clwy-express-generator 5.0.4 → 5.0.6

package/README.md

@@ -7,99 +7,105 @@
 [![Linux Build][github-actions-ci-image]][github-actions-ci-url]
 [![Windows Build][appveyor-image]][appveyor-url]
 
-Forked from [express-generator](https://github.com/expressjs/generator), this project is a fork with some new features.
+Forked from [express-generator](https://github.com/expressjs/generator)，此项目是从这个项目派生而来，并添加了一些新特性。
 
-## Features
+## 功能特性
 
-- **🚀 Support for ES6 syntax**: The project now supports using ES6 syntax, making the code more modern and concise.
-- **🔀 Split routes**: The route files are now split into separate files, making them easier to manage and maintain.
-- **📁 Added middleware folder**: A new middleware folder has been added to store various middleware, improving the modularity of the code.
-- **🔧 Added environment variable configuration file**: The project now includes a configuration file for environment variables, making it easier to manage different environments.
-- **🔄 nodemon has been added**: The project now uses nodemon by default, automatically restarting the server during development when file changes are detected.
+- **🚀 ES6支持**：代码更现代简洁。
+- **🔀 路由拆分**：独立文件，便于管理维护。
+- **📁 中间件模块化**：新增文件夹存放中间件。
+- **🔧 增加环境变量配置**：多环境管理更便捷。
+- **🔄 集成nodemon**：开发时自动重启服务。
+- **📄 新增 README.md**：包含项目简介和基本功能说明。
+- **📦 内置配置**：默认包含`.prettierrc`（代码格式化）和`.gitignore`（文件忽略）。
 
-## Quick Start
+## 快速开始
 
-The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
+使用express最快的方式是利用可执行文件`express(1)`来生成一个应用，如下所示：
 
-Create the app:
+创建应用：
 
 ```bash
 $ npx clwy-express-generator --view=ejs --es6 es6-demo && cd es6-demo
 ```
 
-Install dependencies:
+安装依赖：
 
 ```bash
 $ npm install
 ```
 
-Start your Express.js app at `http://localhost:3000/`:
+在 `http://localhost:3000/` 启动您的 Express.js 应用：
 
 ```bash
 $ npm start
 ```
 
-## Command Line Options
+## 命令行选项
 
-This generator can also be further configured with the following command line flags.
+此生成器还可以通过以下命令行标志进行进一步配置。
 
-        --version        output the version number
-    -v, --view <engine>  add view <engine> support (dust|ejs|hbs|hjs|pug|twig|vash|api) (defaults to ejs)
-        --no-view        use static html instead of view engine
-    -c, --css <engine>   add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)
-        --git            add .gitignore
-        --es6            generate ES6 code and module-type project (requires Node 14.x or higher)
-    -o, --orm            use the Prisma ORM
-    -f, --force          force on non-empty directory
-    -h, --help           output usage information
+        --version        输出版本号
+    -v, --view <engine>  添加视图引擎 <engine> 支持 (dust|ejs|hbs|hjs|pug|twig|vash|api)（默认为 ejs）
+        --no-view        使用静态html而不是视图引擎
+    -c, --css <engine>   添加样式表引擎 <engine> 支持 (less|stylus|compass|sass)（默认为纯 css）
+        --git            添加 .gitignore 文件
+        --es6            生成 ES6 代码和模块类型项目（需要Node 14.x或更高版本）
+    -o, --orm            使用 Prisma ORM
+    -f, --force          强制在非空目录上操作
+    -h, --help           输出使用信息
 
-------------
+Forked from [express-generator](https://github.com/expressjs/generator), this project is a fork with some new features.
 
-Forked from [express-generator](https://github.com/expressjs/generator)，此项目是从这个项目派生而来，并添加了一些新特性。
+------------
 
-## 功能特性
+## Features
 
-- **🚀 支持ES6语法**：项目现在支持使用ES6语法，使代码更加现代化和简洁。
-- **🔀 分割路由**：路由文件现在被拆分到单独的文件中，使它们更易于管理和维护。
-- **📁 新增中间件文件夹**：添加了一个新的中间件文件夹来存放各种中间件，提高了代码的模块化。
-- **🔧 添加环境变量配置文件**：项目现在包含一个环境变量的配置文件，使管理不同环境变得更加容易。
-- **🔄 增加了 nodemon**: 项目现在默认使用 nodemon，在开发过程中，当文件发生变化时会自动重启服务。
+- **🚀 ES6 Support**: Modern and cleaner code.
+- **🔀 Split Routes**: Separate files for easier management and maintenance.
+- **📁 Modular Middleware**: Dedicated folder for middleware.
+- **🔧 Environment Variables**: Easier multi-environment configuration.
+- **🔄 Nodemon Integration**: Auto-restart during development.
+- **📄 Added basic README.md**: Describes the project as a simple Express app with static file serving and basic routing.
+- **📦 Built-in Configs**: Includes `.prettierrc` (code formatting) and `.gitignore` (file exclusion) by default.
 
-## 快速开始
+## Quick Start
 
-使用express最快的方式是利用可执行文件`express(1)`来生成一个应用，如下所示：
+The quickest way to get started with express is to utilize the executable `express(1)` to generate an application as shown below:
 
-创建应用：
+Create the app:
 
 ```bash
 $ npx clwy-express-generator --view=ejs --es6 es6-demo && cd es6-demo
 ```
 
-安装依赖：
+Install dependencies:
 
 ```bash
 $ npm install
 ```
 
-在 `http://localhost:3000/` 启动您的 Express.js 应用：
+Start your Express.js app at `http://localhost:3000/`:
 
 ```bash
 $ npm start
 ```
 
-## 命令行选项
+## Command Line Options
 
-此生成器还可以通过以下命令行标志进行进一步配置。
+This generator can also be further configured with the following command line flags.
 
-        --version        输出版本号
-    -v, --view <engine>  添加视图引擎 <engine> 支持 (dust|ejs|hbs|hjs|pug|twig|vash|api)（默认为 ejs）
-        --no-view        使用静态html而不是视图引擎
-    -c, --css <engine>   添加样式表引擎 <engine> 支持 (less|stylus|compass|sass)（默认为纯 css）
-        --git            添加 .gitignore 文件
-        --es6            生成 ES6 代码和模块类型项目（需要Node 14.x或更高版本）
-    -o, --orm            使用 Prisma ORM
-    -f, --force          强制在非空目录上操作
-    -h, --help           输出使用信息
+        --version        output the version number
+    -v, --view <engine>  add view <engine> support (dust|ejs|hbs|hjs|pug|twig|vash|api) (defaults to ejs)
+        --no-view        use static html instead of view engine
+    -c, --css <engine>   add stylesheet <engine> support (less|stylus|compass|sass) (defaults to plain css)
+        --git            add .gitignore
+        --es6            generate ES6 code and module-type project (requires Node 14.x or higher)
+    -o, --orm            use the Prisma ORM
+    -f, --force          force on non-empty directory
+    -h, --help           output usage information
+
+------------
 
 ## License
 

package/bin/express-cli.js

@@ -1,24 +1,24 @@
 #!/usr/bin/env node
 
-var ejs = require('ejs')
-var fs = require('fs')
-var minimatch = require('minimatch')
-var mkdirp = require('mkdirp')
-var parseArgs = require('minimist')
-var path = require('path')
-var readline = require('readline')
-var sortedObject = require('sorted-object')
-var util = require('util')
-
-var MODE_0666 = parseInt('0666', 8)
-var MODE_0755 = parseInt('0755', 8)
-var TEMPLATE_DIR = path.join(__dirname, '..', 'templates')
-var VERSION = require('../package').version
-var MIN_ES6_VERSION = 14
+const ejs = require('ejs')
+const fs = require('fs')
+const minimatch = require('minimatch')
+const mkdirp = require('mkdirp')
+const parseArgs = require('minimist')
+const path = require('path')
+const readline = require('readline')
+const sortedObject = require('sorted-object')
+const util = require('util')
+
+const MODE_0666 = parseInt('0666', 8)
+const MODE_0755 = parseInt('0755', 8)
+const TEMPLATE_DIR = path.join(__dirname, '..', 'templates')
+const VERSION = require('../package').version
+const MIN_ES6_VERSION = 14
 
 // parse args
-var unknown = []
-var args = parseArgs(process.argv.slice(2), {
+const unknown = []
+const args = parseArgs(process.argv.slice(2), {
   alias: {
     c: 'css',
     e: 'ejs',
@@ -48,7 +48,7 @@ main(args, exit)
  */
 
 function confirm (msg, callback) {
-  var rl = readline.createInterface({
+  const rl = readline.createInterface({
     input: process.stdin,
     output: process.stdout
   })
@@ -92,12 +92,13 @@ function createApplication (name, dir, options, done) {
   console.log()
 
   // Package
-  var pkg = {
+  const pkg = {
     name: name,
     version: '0.0.0',
     private: true,
     scripts: {
-      start: 'nodemon ./bin/www'
+      start: 'nodemon ./bin/www',
+      format: 'prettier --write "**/*.{js,json,md}"'
     },
     dependencies: {
       debug: '~4.4.0',
@@ -105,7 +106,8 @@ function createApplication (name, dir, options, done) {
       express: '~5.1.0'
     },
     devDependencies: {
-      nodemon: '^3.1.9'
+      nodemon: '^3.1.9',
+      prettier: '^3.5.3'
     }
   }
   if (options.es6) {
@@ -113,9 +115,9 @@ function createApplication (name, dir, options, done) {
   }
 
   // JavaScript
-  var app = loadTemplate(options.es6 ? 'mjs/app.js' : 'js/app.js')
-  var www = loadTemplate(options.es6 ? 'mjs/www' : 'js/www')
-  var env = loadTemplate('.env')
+  const app = loadTemplate(options.es6 ? 'mjs/app.js' : 'js/app.js')
+  const www = loadTemplate(options.es6 ? 'mjs/www' : 'js/www')
+  const env = loadTemplate('env')
 
   // App name
   www.locals.name = name
@@ -138,7 +140,7 @@ function createApplication (name, dir, options, done) {
   app.locals.uses.push('cookieParser()')
   pkg.dependencies['cookie-parser'] = '~1.4.7'
 
-  // Env vars
+  // Env consts
   env.locals.orm = options.orm
 
   if (dir !== '.') {
@@ -171,6 +173,9 @@ function createApplication (name, dir, options, done) {
       break
   }
 
+  // copy Prettier templates
+  copyTemplate(options.es6 ? 'mjs/prettierrc.json' : 'js/prettierrc.json', path.join(dir, '.prettierrc.json'))
+
   // copy config templates
   mkdir(dir, 'config')
   copyTemplateMulti(
@@ -287,9 +292,11 @@ function createApplication (name, dir, options, done) {
   // Static files
   app.locals.uses.push("express.static(path.join(__dirname, 'public'))")
 
-  if (options.git) {
-    copyTemplate('js/gitignore', path.join(dir, '.gitignore'))
-  }
+  // Git ignore file
+  copyTemplate('gitignore', path.join(dir, '.gitignore'))
+
+  // Git README file
+  copyTemplate('README.md', path.join(dir, 'README.md'))
 
   // sort dependencies like npm(1)
   pkg.dependencies = sortedObject(pkg.dependencies)
@@ -301,7 +308,7 @@ function createApplication (name, dir, options, done) {
   write(path.join(dir, 'bin/www'), www.render(), MODE_0755)
   write(path.join(dir, '.env'), env.render())
 
-  var prompt = launchedFromCmd() ? '>' : '$'
+  const prompt = launchedFromCmd() ? '>' : '$'
 
   if (dir !== '.') {
     console.log()
@@ -379,8 +386,8 @@ function exit (code) {
     if (!(draining--)) process.exit(code)
   }
 
-  var draining = 0
-  var streams = [process.stdout, process.stderr]
+  let draining = 0
+  const streams = [process.stdout, process.stderr]
 
   exit.exited = true
 
@@ -407,8 +414,8 @@ function launchedFromCmd () {
  */
 
 function loadTemplate (name) {
-  var contents = fs.readFileSync(path.join(__dirname, '..', 'templates', (name + '.ejs')), 'utf-8')
-  var locals = Object.create(null)
+  const contents = fs.readFileSync(path.join(__dirname, '..', 'templates', (name + '.ejs')), 'utf-8')
+  const locals = Object.create(null)
 
   function render () {
     return ejs.render(contents, locals, {
@@ -453,10 +460,10 @@ function main (options, done) {
   } else {
     console.log(options.view)
     // Path
-    var destinationPath = options._[0] || '.'
+    const destinationPath = options._[0] || '.'
 
     // App name
-    var appName = createAppName(path.resolve(destinationPath)) || 'hello-world'
+    const appName = createAppName(path.resolve(destinationPath)) || 'hello-world'
 
     // View engine
     if (options.view === true) {
@@ -515,7 +522,7 @@ function main (options, done) {
  */
 
 function mkdir (base, dir) {
-  var loc = path.join(base, dir)
+  const loc = path.join(base, dir)
 
   console.log('   \x1b[36mcreate\x1b[0m : ' + loc + path.sep)
   mkdirp.sync(loc, MODE_0755)

package/package.json

@@ -2,7 +2,7 @@
   "name": "clwy-express-generator",
   "description": "Express' application generator",
   "homepage": "https://github.com/clwy-cn/clwy-express-generator",
-  "version": "5.0.4",
+  "version": "5.0.6",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     "Aaron Heckmann <aaron.heckmann+github@gmail.com>",

package/templates/README.md

@@ -0,0 +1,15 @@
+# Express Project
+
+This project is a simple Express application that serves a static HTML file. It also includes a basic routing setup and a simple middleware function.
+
+Install dependencies:
+
+```bash
+$ npm install
+```
+
+Start your Express.js app at `http://localhost:3000/`:
+
+```bash
+$ npm start
+```

package/templates/env.ejs

@@ -0,0 +1,2 @@
+# your environment variables
+PORT=3000

package/templates/{js/gitignore → gitignore}

@@ -59,3 +59,17 @@ typings/
 
 # next.js build output
 .next
+
+# Ignore environment files.
+/.env
+
+# Ignore editor files.
+/.idea
+/.vscode
+
+# Ignore system files.
+.DS_Store
+Thumbs.db
+
+# Ignore Docker data.
+/data

package/templates/js/middlewares/error-handler.js

@@ -14,4 +14,4 @@ module.exports = (err, req, res, next) => {
   //   message: err.message
   // });
   res.render('error');
-};
+};

package/templates/js/prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": true,
+  "singleQuote": true,
+  "printWidth": 100
+}

package/templates/mjs/app.js.ejs

@@ -1,48 +1,48 @@
-import path from 'path';
-import { fileURLToPath } from 'url';
+import path from 'path'
+import { fileURLToPath } from 'url'
 
-import express from 'express';
+import express from 'express'
 <% Object.keys(modules).sort().forEach(function (variable) { -%>
-import <%- variable %> from '<%- modules[variable] %>';
-<% }); -%>
+import <%- variable %> from '<%- modules[variable] %>'
+<% }) -%>
 
 <% if (view) { -%>
-import createError from 'http-errors';
-import errorHandler from './middlewares/error-handler.js';
+import createError from 'http-errors'
+import errorHandler from './middlewares/error-handler.js'
 <% } -%>
 
 // environment variables
-import 'dotenv/config';
-import routes from './config/routes.js';
+import 'dotenv/config'
+import routes from './config/routes.js'
 
-const __dirname = path.dirname(fileURLToPath(import.meta.url));
+const __dirname = path.dirname(fileURLToPath(import.meta.url))
 
-const app = express();
+const app = express()
 
 <% if (view) { -%>
 // view engine setup
 <% if (view.render) { -%>
-app.engine('<%- view.engine %>', <%- view.render %>);
+app.engine('<%- view.engine %>', <%- view.render %>)
 <% } -%>
-app.set('views', path.join(__dirname, 'views'));
-app.set('view engine', '<%- view.engine %>');
+app.set('views', path.join(__dirname, 'views'))
+app.set('view engine', '<%- view.engine %>')
 
 <% } -%>
 <% uses.forEach(function (use) { -%>
-app.use(<%- use %>);
-<% }); -%>
+app.use(<%- use %>)
+<% }) -%>
 
 // routes
-app.use(routes);
+app.use(routes)
 
 <% if (view) { -%>
 // catch 404 and forward to error handler
 app.use((req, res, next) => {
-  next(createError(404));
-});
+  next(createError(404))
+})
 
 // error handler
-app.use(errorHandler);
+app.use(errorHandler)
 
 <% } -%>
-export default app;
+export default app

package/templates/mjs/config/routes.js

@@ -1,10 +1,10 @@
-import express from 'express';
-import indexRouter from '../routes/index.js';
-import usersRouter from '../routes/users.js';
+import express from 'express'
+import indexRouter from '../routes/index.js'
+import usersRouter from '../routes/users.js'
 
-const router = express.Router();
+const router = express.Router()
 
-router.use('/', indexRouter);
-router.use('/users', usersRouter);
+router.use('/', indexRouter)
+router.use('/users', usersRouter)
 
-export default router;
+export default router

package/templates/mjs/middlewares/error-handler.js

@@ -2,16 +2,16 @@
 
 export default (err, req, res, next) => {
   // set locals, only providing error in development
-  res.locals.message = err.message;
-  res.locals.error = req.app.get('env') === 'development' ? err : {};
+  res.locals.message = err.message
+  res.locals.error = req.app.get('env') === 'development' ? err : {}
 
   // render the error page
-  res.status(err.status || 500);
+  res.status(err.status || 500)
 
   // if you want to use json, you can use res.json instead of res.render
   // res.json({
   //   status: false,
   //   message: err.message
   // });
-  res.render('error');
-};
+  res.render('error')
+}

package/templates/mjs/prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://json.schemastore.org/prettierrc",
+  "semi": false,
+  "singleQuote": true,
+  "printWidth": 100
+}

package/templates/mjs/routes/index.js

@@ -1,11 +1,12 @@
-import express from 'express';
-const router = express.Router();
+import express from 'express'
+
+const router = express.Router()
 
 /* GET home page. */
 router.get('/', (req, res, next) => {
   // if you want to use json, you can use res.json instead of res.render
   // res.json({ title: 'Express' });
-  res.render('index', { title: 'Express' });
-});
+  res.render('index', { title: 'Express' })
+})
 
-export default router;
+export default router

package/templates/mjs/routes/users.js

@@ -1,9 +1,10 @@
-import express from 'express';
-const router = express.Router();
+import express from 'express'
+
+const router = express.Router()
 
 /* GET users listing. */
 router.get('/', (req, res, next) => {
-  res.send('respond with a resource');
-});
+  res.send('respond with a resource')
+})
 
-export default router;
+export default router

package/templates/mjs/www.ejs

@@ -4,51 +4,51 @@
  * Module dependencies.
  */
 
-import http from 'http';
+import http from 'http'
 
-import app from '../app.js';
-import debugFunction from 'debug';
-const debug = debugFunction('<%- name %>:server');
+import app from '../app.js'
+import debugFunction from 'debug'
+const debug = debugFunction('<%- name %>:server')
 
 /**
  * Get port from environment and store in Express.
  */
 
-const port = normalizePort(process.env.PORT || '3000');
-app.set('port', port);
+const port = normalizePort(process.env.PORT || '3000')
+app.set('port', port)
 
 /**
  * Create HTTP server.
  */
 
-const server = http.createServer(app);
+const server = http.createServer(app)
 
 /**
  * Listen on provided port, on all network interfaces.
  */
 
-server.listen(port);
-server.on('error', onError);
-server.on('listening', onListening);
+server.listen(port)
+server.on('error', onError)
+server.on('listening', onListening)
 
 /**
  * Normalize a port into a number, string, or false.
  */
 
 function normalizePort(val) {
-  const port = parseInt(val, 10);
+  const port = parseInt(val, 10)
 
   if (isNaN(port)) {
     // named pipe
-    return val;
+    return val
   }
 
   if (port >= 0) {
     // port number
-    return port;
+    return port
   }
 
-  return false;
+  return false
 }
 
 /**
@@ -57,25 +57,25 @@ function normalizePort(val) {
 
 function onError(error) {
   if (error.syscall !== 'listen') {
-    throw error;
+    throw error
   }
 
   const bind = typeof port === 'string'
     ? 'Pipe ' + port
-    : 'Port ' + port;
+    : 'Port ' + port
 
   // handle specific listen errors with friendly messages
   switch (error.code) {
     case 'EACCES':
-      console.error(bind + ' requires elevated privileges');
-      process.exit(1);
-      break;
+      console.error(bind + ' requires elevated privileges')
+      process.exit(1)
+      break
     case 'EADDRINUSE':
-      console.error(bind + ' is already in use');
-      process.exit(1);
-      break;
+      console.error(bind + ' is already in use')
+      process.exit(1)
+      break
     default:
-      throw error;
+      throw error
   }
 }
 
@@ -84,9 +84,9 @@ function onError(error) {
  */
 
 function onListening() {
-  const addr = server.address();
+  const addr = server.address()
   const bind = typeof addr === 'string'
     ? 'pipe ' + addr
-    : 'port ' + addr.port;
-  debug('Listening on ' + bind);
+    : 'port ' + addr.port
+  debug('Listening on ' + bind)
 }

package/templates/.env.ejs

@@ -1,12 +0,0 @@
-# your environment variables
-PORT=3000
-<% if (orm) { -%>
-
-# This was inserted by `prisma init`:
-# Environment variables declared in this file are automatically made available to Prisma.
-# See the documentation for more detail: https://pris.ly/d/prisma-schema#accessing-environment-variables-from-the-schema
-
-# Prisma supports the native connection string format for PostgreSQL, MySQL, SQLite, SQL Server, MongoDB and CockroachDB.
-# See the documentation for all the connection string options: https://pris.ly/d/connection-strings
-DATABASE_URL="mysql://root:password@localhost:3306/mydb"
-<% } -%>