i5ting / koa-generator Goto Github PK

Koa' application generator for 1.x and 2.x（ Express-style and support all middlewares include async/await ）

Home Page: https://github.com/17koa/koa-generator

License: MIT License

JavaScript 93.01% CSS 0.52% Shell 0.27% Less 0.52% Sass 0.47% SCSS 0.64% Stylus 0.46% EJS 1.44% Handlebars 1.38% Pug 1.29%

koa koa2 koa-generator koa-starter web scaffold nodejs

koa-generator's Introduction

koa-generator

http://koajs.com/

Koa application generator.

Features

Express-style
Support koa 1.x（supported）
Support koa 2.x（koa middleware supported,need Node.js 7.6+ ,babel optional）

Installation

$ npm install -g koa-generator

with 2 commands

koa (Support koa 1.x)
koa2 (Support koa 2.x)

Quick Start 1.x

The quickest way to get started with koa is to utilize the executable koa(1) to generate an application as shown below:

Create the app:

$ koa

Install dependencies:

$ npm install

Rock and Roll

$ npm start

Quick Start 2.x

The quickest way to get started with koa is to utilize the executable koa2(1) to generate an application as shown below:

Create the app:

$ koa2 /tmp/foo && cd /tmp/foo

Install dependencies:

$ npm install

Rock and Roll

$ npm start

more detail see koa2-demo

Command Line Options

This generator can also be further configured with the following command line flags.

-h, --help          output usage information
-V, --version       output the version number
-e, --ejs           add ejs engine support (defaults to jade)
    --hbs           add handlebars engine support
-n, --nunjucks      add nunjucks engine support
-H, --hogan         add hogan.js engine support
-c, --css <engine>  add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)
    --git           add .gitignore
-f, --force         force on non-empty directory

目前选项-c还没有实现

Git Branch Details

master = koa generator
tpl = koa 1.x template
tpl_2.x = koa 2.x template

License

MIT

koa-generator's People

Contributors

Stargazers

Watchers

Forkers

feiin jerroldlee zhufengnodejs wangzhiwei1888 fnet123 dream-seeker mosker liushigit miaowing caiya nodejslovers tobyreynold db-murphy djgithub0727 fantasthu rucky2013 sunrain990 lihang1870719 wuyanming xs23933 is00hcw dennyx sonsongo hellowor1d zy841336855 iwebhome daisty leungkaming yingch2331 artdong yazaihu c0dt shengxinyuan expertping kungvwow studentwan yuanzhhh equalll team4yf wsjlove b110 sheshouzuo qinkangwu yangxiaopingios hdfs010 hewentaowx herryliq rubikplanet wadewy zztiswb116 panmin keng42 happy-everyday xxzxccy zzwwjjdj319 liuwenpeng1 qijundream studyzhb santong oxoyo zhenghuahou supermason zachdsawyer mengxiangkun37 web-yuzm zsboss misunlaughing anaforker logoran cookiexyx zhangtaibai linecode seansangrc haoolee papplo danyuers guoyu07 guaji820 j1mmychen yotonn infernalslam xiaozhuxiaozhi hatuw tianyanke amundsen-roald xiaofeide sanwenjohnny vcvc001 smileyqp 51tintin hhy5277 liangchaofei dannnycrazy wangkaiwen kmvan linsenlin zhangpengdeshu dafei3115 linx-x nuohui

koa-generator's Issues

handlebars配置layout刷新路径直接读取文件内容问题

从这里下载了koa-generator, 想在index.hbs继承layout.hbs，做了下面的修改
app.js

app.use(views(__dirname + '/views', {
  extension: 'hbs',
  map: { hbs: 'handlebars' },
  options: {
      partials: {
          layout: './layout' 
      }
  }
}))

就改了这个，第一次没有报错，第二次貌似把layout.hbs的内容读出来作为路径了

  Error: ENOENT: no such file or directory, open 'F:\person_project\github\koa2_learn\views\<!DOCTYPE html>
  <html>
    <head>
      <title>{{title}}<\title>
      <link rel='stylesheet' href='\stylesheets\style.css' \>
    <\head>
    <body>
      {{{body}}}
    <\body>
  <\html>

初学不是太懂，指教一下，thanks

无法创建项目

系统: win10 node.js版本：v8.x.x
安装完koa-generator之后，无法创建项目，提示koa2：command not found,尝试重置过系统环境变量也没用，我应该如何排错？

"狼叔"：请教一下，如何自己写一个这样的应用生成工具

自己用 node 写过 cli 小工具

自己如何写一个这样的生成工具

想要知道一些思路

在此谢谢:+1:

convert jade to pug

npm WARN deprecated [email protected]: Jade has been renamed to pug, please install the latest version of pug instead of jade

koa-bodyparser默认只开起form和json，不支持text

app.js里显示声明3种配置，以便大家用的时候不要掉进坑里

Action required: Greenkeeper could not be activated 🚨

🚨 You need to enable Continuous Integration on Greenkeeper branches of this repository. 🚨

To enable Greenkeeper, you need to make sure that a commit status is reported on all branches. This is required by Greenkeeper because it uses your CI build statuses to figure out when to notify you about breaking changes.

Since we didn’t receive a CI status on the greenkeeper/initial branch, it’s possible that you don’t have CI set up yet.
We recommend using:

CircleCI
Travis CI
Buildkite
CodeShip
Azure Pipelines
TeamCity
Buddy
AppVeyor
But Greenkeeper will work with every other CI service as well.

If you have already set up a CI for this repository, you might need to check how it’s configured. Make sure it is set to run on all new branches. If you don’t want it to run on absolutely every branch, you can whitelist branches starting with greenkeeper/.

Once you have installed and configured CI on this repository correctly, you’ll need to re-trigger Greenkeeper’s initial pull request. To do this, please click the 'fix repo' button on account.greenkeeper.io.

Deprecated use of generators

$ ./bin/run

koa deprecated Support for generators will been removed in v3. See the documentation for examples of how to convert old middleware https://github.com/koajs/koa/tree/v2.x#old-signature-middleware-v1x app.js:23:5

引入webpack配置

咨询您一个问题，要在此基础上引入webpack做移动端，有什么解决方案吗？

koa2 --ejs

请您确认一个 bug，我执行命令：

koa2 --ejs

生成的代码中仍然使用 jade

app.use(views(__dirname + '/views', {
extension: 'jade'
}));

I'm confused on the purpose of the koa2 generator?

How come it doesn't seem to generate with support for async / await which I thought was the big move for Koa2?

package.json的一点小问题

"start": "node bin/www"应是 "start": "nodemon bin/www"吧?

为啥把runkoa去掉了？

The view engine not correct setting

I had try with "-e" ,but the config in the code are still jade.

// global middlewares
app.use(views('views', {
  root: __dirname + '/views',
  default: 'jade'
}));

can not run app generated by koa2

I tried

koa2 --hbs --css sass --git koa2-test

Install works fine
https://gist.githubusercontent.com/AubreyHewes/fa6881ecd9089482ccc5a26f0ad2e126/raw

Running npm start works fine
https://gist.githubusercontent.com/AubreyHewes/3498e3ec955cf04ced5cf09e32865b22/raw

though handlebars layout is not used (outputs only the index.hbs)
though sass middleware is not used (maybe due to the layout not being used?)

Running npm run koa fails...
https://gist.githubusercontent.com/AubreyHewes/20f64418bf61213078ad171296a9ee59/raw

So I installed the failing module babel-plugin-add-module-exports.. then it fails on babel-plugin-transform-es2015-modules-commonjs..
https://gist.githubusercontent.com/AubreyHewes/972d7b3c031d8a59bff1f34dad94e387/raw

So I installed the failing module babel-plugin-transform-es2015-modules-commonjs .. it still fails on the same module babel-plugin-transform-es2015-modules-commonjs..
https://gist.githubusercontent.com/AubreyHewes/b5bee5ee974c10fbe2f7c3e26d1845d7/raw

I assume it's just not ready for what I tried..
I looked into it a little and koa-views does not seem to support handlebars layouts..

Linux 4.2.0-36-generic #42-Ubuntu SMP Thu May 12 22:05:35 UTC 2016 x86_64 x86_64
node: v5.12.0
npm: 3.8.6

Any tips appreciated, thanks.

npm WARN deprecated [email protected]: This package is no longer maintained

npm WARN notice [SECURITY] uglify-js has the following vulnerability: 1 low. Go here for more details: https://nodesecurity.io/advisories?search=uglify-js&version=2.4.24 - Run npm i npm@latest -g to upgrade your npm version, and then npm audit to get more info.
npm notice created a lockfile as package-lock.json. You should commit this file.

Extending default routes don't work

router.get('/', async function(ctx, next) {
    ctx.state = {
        title: 'koa2 title'
    };

    await ctx.render('index', {});
})

router.get('/test', async function(ctx, next) {
    let data = {a:1, b:2}
    ctx.status = 200;
    ctx.body = data;
    await next();
});

// -> /test - 404

Do I made any mistakes? Thanks.

建议koa2-generator使用 koa-body 因为 koa-bodyparser 不支持上传文件解析

app.js中routes(router)似乎没对

我是初学者，提的可能不对，请原谅。这段代码好像没啥用，又或者是指向的代码有问题。

koa-router 已经更新到 7.1.1， koa-generator 使用的仍是7.0.1版本

如题，请问会更新吗？

增加ava测试

log4js for koa

https://github.com/dominhhai/koa-log4js/tree/v2.x

它是一个不错的实现方案，感觉如果我自己写也不过如此

hi.狼哥..jade官方早已建议迁移到pug上了.

终于看到这个更新东西了. 我每次-g安装这个脚手架工具. 都要自己去手动修改一下koa2 这个文件. 能不能把jade去掉...直接替换成pug呢.

npm start 报错

mac系统下， npm install 后 npm start 启动项目报错

use `koa2 -e` ,and visit `http://127.0.0.1:3000`,response : "Not Found"

I use $ koa2 -eto generate a project,

and change default HTML engine to ejs , then start server with npm start,

and visit: http://127.0.0.1:3000 , it response "Not Found".

I debug like this:

co module:

function onFulfilled(res) {
  var ret;
  try {
    console.log(res,'!!!!!!!!!!!'); // and 
    ret = gen.next(res);
  } catch (e) {
    return reject(e);
  }
  next(ret);
}

koa@next module:

function respond(ctx) {
  console.log(ctx.body, 'respond');
  // allow bypassing koa
  if (false === ctx.respond) return;
      ...

and start server with DEBUG=* npm start, and find the log shows like :

undefined '!!!!!!!!!!!!!!!!!!!!!!!'
undefined 'respond'    # respond executed before template parser
  --> GET / 404 27ms -
<!DOCTYPE html>
<html>
  <head>
    <title>Hello World Koa!</title>
    <link rel='stylesheet' href='/stylesheets/style.css' />
  </head>
  <body>
    <h1>Hello World Koa!</h1>
    <p>Welcome to Hello World Koa!</p>
  </body>
</html>
 !!!!!!!!!!!!!!!!!!!!!!!

koa default function(respond) executed before HTML parser , why? and how to debug it then?

`log` is not defined.

template file: koa-generator/templates1/js/app.js

app.on('error', function(err, ctx){ log.error('server error', err, ctx); });
log here is not defined.

npm run koa的时候报错

执行npm start和npm run pm2都正常运行，但是执行npm run koa的时候报错如下，很奇怪哎：

[email protected] koa /Users/magicly/development/koa-test
runkoa bin/www

bin/www
3babel presets path = /Users/magicly/development/koa-test/node_modules/runkoa/node_modules/
/Users/magicly/development/koa-test/node_modules/babel-core/lib/transformation/file/options/option-manager.js:177
throw new ReferenceError(messages.get("pluginUnknown", plugin, loc, i, dirname));
^

ReferenceError: Unknown plugin "/Users/magicly/development/koa-test/node_modules/runkoa/node_modules/babel-plugin-add-module-exports" specified in "base" at 0, attempted to resolve relative to "/Users/magicly/development/koa-test/bin"
at /Users/magicly/development/koa-test/node_modules/babel-core/lib/transformation/file/options/option-manager.js:177:17
at Array.map (native)
at Function.normalisePlugins (/Users/magicly/development/koa-test/node_modules/babel-core/lib/transformation/file/options/option-manager.js:153:20)
at OptionManager.mergeOptions (/Users/magicly/development/koa-test/node_modules/babel-core/lib/transformation/file/options/option-manager.js:245:36)
at OptionManager.init (/Users/magicly/development/koa-test/node_modules/babel-core/lib/transformation/file/options/option-manager.js:383:12)
at compile (/Users/magicly/development/koa-test/node_modules/babel-register/lib/node.js:103:45)
at loader (/Users/magicly/development/koa-test/node_modules/babel-register/lib/node.js:148:14)
at Object.require.extensions.(anonymous function) as .js
at Module.load (module.js:458:32)
at tryModuleLoad (module.js:417:12)

npm ERR! Darwin 15.5.0
npm ERR! argv "/Users/magicly/.nvm/versions/node/v6.2.1/bin/node" "/Users/magicly/.nvm/versions/node/v6.2.1/bin/npm" "run" "koa"

请问为什么app.js里面的语句都没有;为结尾

在自动处理成的app.js里, 所有的语句都没有以;为结尾, 这是特别设计的吗?

use morgan logger

https://github.com/koa-modules/morgan

样式怎么编译？

如sass、less这些怎么编译？

关于koa-generator的错误处理

在routes/index.js这样写：

router.get('/', async (ctx, next)=> {
    throw new Error('aaa')
    ctx.render('index', {
        title: 'fff'
    });
})

请求时会被挂起，没有任何输出，浏览器也一直在请求状态。

在middleware里添加了这个才捕捉到异常信息

app.use(async (ctx,next) =>{
    try {
        await next()
    }catch (e) {
        console.log('err',e)
    }
});

那么问题来了，koa-generator生成的项目怎么处理未捕捉的异常？

use serve-static

https://github.com/koa-modules/serve-static

Direct support for SCSS syntax for Sass

We may not need compass since node-compass hasn't been updated for quite a while

ejs

https://github.com/koajs/ejs

koa-views is using consolidate under the hood.

正常说，是支持ejs的

npm start 就报错， runkoa 模块依赖的有问题

/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-core/6.18.2/babel-core/lib/transformation/file/options/option-manager.js:176
          throw new ReferenceError(messages.get("pluginUnknown", plugin, loc, i, dirname));
          ^

ReferenceError: Unknown plugin "/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/1.5.6/runkoa/babel-plugin-add-module-exports" specified in "base" at 0, attempted to resolve relative to "/Users/Jon_shen/Documents/workpace/mingpian-koa/bin"
    at /Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-core/6.18.2/babel-core/lib/transformation/file/options/option-manager.js:176:17
    at Array.map (native)
    at Function.normalisePlugins (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-core/6.18.2/babel-core/lib/transformation/file/options/option-manager.js:154:20)
    at OptionManager.mergeOptions (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-core/6.18.2/babel-core/lib/transformation/file/options/option-manager.js:229:36)
    at OptionManager.init (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-core/6.18.2/babel-core/lib/transformation/file/options/option-manager.js:374:12)
    at compile (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-register/6.18.0/babel-register/lib/node.js:103:45)
    at loader (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-register/6.18.0/babel-register/lib/node.js:144:14)
    at Object.require.extensions.(anonymous function) [as .js] (/Users/Jon_shen/Documents/workpace/mingpian-koa/node_modules/.npminstall/babel-register/6.18.0/babel-register/lib/node.js:154:7)
    at Module.load (module.js:487:32)
    at tryModuleLoad (module.js:446:12)

自己在 run 文件中受冻配置了 babel就正常了

add nunjucks support

welcome pr

app.js中app.on('error')不应该用logger吧？

这个位置

app.on('error', function(err, ctx){
   logger.error('server error', err, ctx);
});

koa-logger是没有这个的……

www文件中listen写死3000

www文件中：
var port = normalizePort(process.env.PORT || '3000');
可是listen的时候是写死的3000，应该是listen 这个port变量吧

test报错，typeof app ！== ‘function’

npm test的时候报错了，104行

assert.equal(typeof app, 'function');

我打印了一下typeof app，是object

{ subdomainOffset: 2, proxy: false, env: 'development' }

add .gitignore && readme.md

centos npm install 失败

windows上npm install 成功 centos上npm install 失败
`# node -v
v12.13.1

npm -v

6.12.1

koa2

npm install

npm WARN deprecated [email protected]: core-js@<3.0 is no longer maintained and not recommended for usage due to the number of issues. Please, upgrade your dependencies to the actual version of core-js@3.
npm WARN deprecated [email protected]: One of your dependencies needs to upgrade to fsevents v2: 1) Proper nodejs v10+ support 2) No more fetching binaries from AWS, smaller package size
npm WARN deprecated [email protected]: CircularJSON is in maintenance only, flatted is its successor.
npm ERR! code ENOENT
npm ERR! syscall open
npm ERR! path /var/nodejs/chart/node_modules/acorn-jsx/node_modules/acorn/package.json.2031230988
npm ERR! errno -2
npm ERR! enoent ENOENT: no such file or directory, open '/var/nodejs/chart/node_modules/acorn-jsx/node_modules/acorn/package.json.2031230988'
npm ERR! enoent This is related to npm not being able to find a file.
npm ERR! enoent

npm ERR! A complete log of this run can be found in:
npm ERR! /root/.npm/_logs/2019-11-29T05_04_14_458Z-debug.log

npm i --save [email protected]
npm install koa-router@next --save

app中使用koa-router方法无效？

version: 1.1.16

通过koa2 project_name创建项目后，在app.js中，出现了app.use(router.routes(), router.allowedMethods());

app.use()不是只接受第一个参数的吗？