clwy-express-generator 5.2.1 → 5.2.3

package/README.md

@@ -4,13 +4,11 @@
 
 **此项目基于 [express-generator](https://github.com/expressjs/generator) 分叉而来，并新增了一些功能特性。**
 
-**其中，ES6 支持的实现参考了 [Dr. Jeff Jackson](https://github.com/drjeffjackson) 提交的 [Pull Request](https://github.com/expressjs/generator/pull/316)，并在其基础上进行了进一步优化和调整。**
-
 ## 功能特性
 
 - **🚀 ES6 支持**：代码更现代简洁。
 - **🔀 路由拆分**：独立文件，便于管理维护。
-- **🗄️ ORM 支持**：支持 Prisma 或 Sequelize ORM。
+- **🗄️ ORM 支持**：支持 Sequelize 或 Prisma ORM。
 - **📁 中间件模块化**：新增文件夹存放中间件。
 - **🔧 增加环境变量配置**：多环境管理更便捷。
 - **🔄 集成 nodemon**：开发时自动重启服务。
@@ -28,6 +26,7 @@
 
 ```bash
 $ npx clwy-express-generator --view=ejs --es6 es6-demo
+# 或：npx clwy-express-generator -v=ejs --es6 es6-demo
 $ cd es6-demo
 ```
 
@@ -53,39 +52,53 @@ $ npm start
 $ docker-compose up -d
 ```
 
-默认将启动 MySQL 数据库，PostgreSQL 和 Redis 配置已在 `docker-compose.yml` 中，请根据需求调整。
+默认将启动 MySQL 数据库，PostgreSQL 和 Redis 配置已在 `docker-compose.yml` 中，请根据需求取消注释。
 
-### 使用 Prisma
+### 使用 Sequelize
 
-创建应用：
+**创建应用：**
 
 ```bash
-$ npx clwy-express-generator --view=ejs --orm=prisma --es6 es6-prisma-demo
-$ cd es6-prisma-demo
+$ npx clwy-express-generator --view=ejs --orm=sequelize --es6 es6-sequelize-demo
+$ cd es6-sequelize-demo
 $ npm i
 ```
 
-初始化数据库客户端：
+**根据需求安装数据库引擎：**
 
 ```bash
-$ npx prisma generate
+$ npm install --save mysql2 # MySQL
+$ npm install --save pg pg-hstore # Postgres
 ```
 
-### 使用 Sequelize
+项目已默认集成了[clwy-sequelize-cli](https://github.com/clwy-cn/clwy-sequelize-cli)，使用以下命令会生成**ES6**风格的模型、迁移和种子文件。
 
-创建应用：
+**生成模型和迁移文件：**
 
 ```bash
-$ npx clwy-express-generator --view=ejs --orm=sequelize --es6 es6-sequelize-demo
-$ cd es6-sequelize-demo
+$ npx sequelize model:generate --name Article --attributes title:string,content:text
+```
+
+**生成种子文件：**
+
+```bash
+$ npx sequelize seed:generate --name article
+```
+
+### 使用 Prisma
+
+**创建应用：**
+
+```bash
+$ npx clwy-express-generator --view=ejs --orm=prisma --es6 es6-prisma-demo
+$ cd es6-prisma-demo
 $ npm i
 ```
 
-根据需求安装数据库引擎：
+**初始化数据库客户端：**
 
 ```bash
-$ npm install --save mysql2 # MySQL
-$ npm install --save pg pg-hstore # Postgres
+$ npx prisma generate
 ```
 
 ## 命令行选项
@@ -95,7 +108,7 @@ $ npm install --save pg pg-hstore # Postgres
         --version        输出版本号
     -v, --view <engine>  添加视图引擎 <engine> 支持 (dust|ejs|hbs|hjs|pug|twig|vash|api)（默认为 ejs）
         --no-view        使用静态html而不是视图引擎
-    -o, --orm <orm>      添加 ORM <orm> 支持 (prisma|sequelize)
+    -o, --orm <orm>      添加 ORM <orm> 支持 (sequelize|prisma)
     -c, --css <engine>   添加样式表引擎 <engine> 支持 (less|stylus|compass|sass)（默认为纯 css）
         --git            添加 .gitignore 文件
         --es6            生成 ES6 代码和模块类型项目（需要Node 22.x或更高版本）
@@ -108,8 +121,6 @@ $ npm install --save pg pg-hstore # Postgres
 
 **This project is forked from [express-generator](https://github.com/expressjs/generator) with additional features.**
 
-**ES6 support is implemented based on the [Pull Request](https://github.com/expressjs/generator/pull/316) submitted by [Dr. Jeff Jackson](https://github.com/drjeffjackson), with further optimizations and adjustments.**
-
 ## Features
 
 - **🚀 ES6 Support**: More modern and concise code.
@@ -157,39 +168,56 @@ After installing and starting Docker:
 $ docker-compose up -d
 ```
 
-This will start a MySQL database by default. PostgreSQL and Redis configurations are already in `docker-compose.yml`; adjust them according to your needs.
+By default, the MySQL database will be started. PostgreSQL and Redis configurations are already included in
+docker-compose.yml; please uncomment them as needed.
 
-### Using Prisma
+### Using Sequelize
 
-Create the application:
+**Create the application:**
 
 ```bash
-$ npx clwy-express-generator --view=ejs --orm=prisma --es6 es6-prisma-demo
-$ cd es6-prisma-demo
+$ npx clwy-express-generator --view=ejs --orm=sequelize --es6 es6-sequelize-demo
+$ cd es6-sequelize-demo
 $ npm i
 ```
 
-Initialize the database client:
+**Install the database engine as needed:**
 
 ```bash
-$ npx prisma generate
+$ npm install --save mysql2 # MySQL
+$ npm install --save pg pg-hstore # Postgres
 ```
 
-### Using Sequelize
+The project has [clwy-sequelize-cli](https://github.com/clwy-cn/clwy-sequelize-cli) integrated by default. Using the following commands will generate **ES6-style** models, migrations, and seed files.
 
-Create the application:
+**Generate model and migration files:**
 
 ```bash
-$ npx clwy-express-generator --view=ejs --orm=sequelize --es6 es6-sequelize-demo
-$ cd es6-sequelize-demo
+$ npx sequelize model:generate --name Article --attributes title:string,content:text
+```
+
+**Generate seed file:**
+
+```bash
+$ npx sequelize seed:generate --name article
+```
+
+### Using Prisma
+
+**Create the application:**
+
+```bash
+$ npx clwy-express-generator --view=ejs --orm=prisma --es6 es6-prisma-demo
+# or: npx clwy-express-generator -v=ejs -o=prisma --es6 es6-prisma-demo
+
+$ cd es6-prisma-demo
 $ npm i
 ```
 
-Install the database engine as needed:
+**Initialize the database client:**
 
 ```bash
-$ npm install --save mysql2 # MySQL
-$ npm install --save pg pg-hstore # Postgres
+$ npx prisma generate
 ```
 
 ## Command Line Options
@@ -199,7 +227,7 @@ This generator can be further configured with the following command line flags.
         --version        Output the version number
     -v, --view <engine>  Add view engine <engine> support (dust|ejs|hbs|hjs|pug|twig|vash|api) (defaults to ejs)
         --no-view        Use static HTML instead of a view engine
-    -o, --orm <orm>      Add ORM <orm> support (prisma|sequelize)
+    -o, --orm <orm>      Add ORM <orm> support (sequelize|prisma)
     -c, --css <engine>   Add stylesheet engine <engine> support (less|stylus|compass|sass) (defaults to plain css)
         --git            Add .gitignore file
         --es6            Generate ES6 code and module type project (requires Node 22.x or higher)

package/bin/express-cli.js

@@ -311,6 +311,11 @@ function createApplication(name, dir, options, done) {
       case 'sequelize':
         // copy Sequelize templates
         pkg.dependencies.sequelize = '^6.37.7'
+        if (options.es6) {
+          pkg.devDependencies['clwy-sequelize-cli'] = '^0.0.1';
+        } else {
+          pkg.devDependencies['sequelize-cli'] = '^6.6.5';
+        }
 
         mkdir(dir, 'migrations')
         mkdir(dir, 'seeders')

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.2.1",
+  "version": "5.2.3",
   "author": "TJ Holowaychuk <tj@vision-media.ca>",
   "contributors": [
     "Aaron Heckmann <aaron.heckmann+github@gmail.com>",