nsgm-cli 2.1.7 → 2.1.9

package/README.md

@@ -1,28 +1,62 @@
 # NSGM CLI
-- 技术栈: [Next](https://github.com/vercel/next.js), [Styled-components](https://github.com/styled-components/styled-components), [Graphql](https://graphql.org/), [Mysql](https://www.mysql.com/)
-- 全栈架构，代码模板生成，快速开发
-- 数据库采用 Mysql, 配置见 mysql.config.js
-- 项目配置见 project.config.js
-- Next 框架配置见 next.config.js
-  
-## 命令
-- nsgm init    初始化项目
-- nsgm upgrade 升级项目基础文件
-- nsgm create  创建模板页面
-- nsgm delete  删除模板页面
-- nsgm deletedb 删除模板页面及数据库表
-- nsgm dev     开发模式
-- nsgm start   生产模式
-- nsgm build   编译
-- nsgm export  导出静态页面
-        
-## 参数
-- dictionary: 在 export/init 的时候使用, 默认 webapp, 譬如: nsgm init|export dictionary=webapp 或者 nsgm init|export webapp
-- controller: 在 create/delete 的时候使用， 必须有。譬如：nsgm create|delete math
-- action:     在 create/delete 的时候使用， 默认 manage, 跟在 controller 后面， 譬如 nsgm create|delete math test
-
-## 根目录新增 next.config.js
-```
+
+A full-stack development framework with code template generation capabilities, helping developers efficiently build web applications.
+
+## Tech Stack
+
+- [Next.js](https://github.com/vercel/next.js) - React framework
+- [Styled-components](https://github.com/styled-components/styled-components) - CSS-in-JS solution
+- [GraphQL](https://graphql.org/) - API query language
+- [MySQL](https://www.mysql.com/) - Relational database
+
+## Features
+
+- Full-stack architecture design
+- Automatic code template generation
+- Rapid development workflow
+- Integrated GraphQL API
+- MySQL database support
+
+## Command Line Tools
+
+### Basic Commands
+
+| Command | Description |
+|------|------|
+| `nsgm init` | Initialize project |
+| `nsgm upgrade` | Upgrade project base files |
+| `nsgm create` | Create template page |
+| `nsgm delete` | Delete template page |
+| `nsgm deletedb` | Delete template page and database table |
+| `nsgm dev` | Development mode |
+| `nsgm start` | Production mode |
+| `nsgm build` | Build project |
+| `nsgm export` | Export static pages |
+
+### Parameter Description
+
+- **dictionary**: Used with `export`/`init` commands, default value is `webapp`
+  ```
+  nsgm init dictionary=webapp
+  # or simplified as
+  nsgm init webapp
+  ```
+
+- **controller**: Used with `create`/`delete` commands, required parameter
+  ```
+  nsgm create math
+  ```
+
+- **action**: Used with `create`/`delete` commands, default value is `manage`, follows the controller
+  ```
+  nsgm create math test
+  ```
+
+## Project Configuration
+
+### next.config.js
+
+```javascript
 const { nextConfig } = require('nsgm-cli')
 const projectConfig = require('./project.config')
 
@@ -37,8 +71,9 @@ module.exports = (phase, defaultConfig) => {
 }
 ```
 
-## 根目录新增 mysql.config.js
-```
+### mysql.config.js
+
+```javascript
 const { mysqlConfig } = require('nsgm-cli')
 const { mysqlOptions } = mysqlConfig
 const { user, password, host, port, database } = mysqlOptions
@@ -54,8 +89,9 @@ module.exports = {
 }
 ```
 
-## 根目录新增 project.config.js
-```
+### project.config.js
+
+```javascript
 const { projectConfig } = require('nsgm-cli')
 const pkg = require('./package.json')
 
@@ -71,34 +107,44 @@ module.exports = {
 }
 ```
 
-## 根目录新增 server 
-- apis    存放 Rest Api 
-- modules 存放 graphql 的 resolver 和 schema
-- plugins 存放 graphql 的 plugin
-- *.js  举例： test.js =>  用于响应 /test/*, ${prefix}/test/* 请求
+## Server Directory Structure
 
-```
-  const express = require('express')
-  const moment = require('moment')
+The `server` folder in the project root contains the following:
 
-  const router = express.Router()
+### Directory Description
 
-  router.use((req, res, next) => {
-      const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl
-      console.log(moment().format('YYYY-MM-DD HH:mm:ss') + ' ' + fullUrl)
-      next()
-  })
+- `apis/` - Stores REST API interfaces
+- `modules/` - Stores GraphQL resolvers and schemas
+- `plugins/` - Stores GraphQL plugins
+- `*.js` - Route files, e.g., `test.js` handles requests to `/test/*` and `${prefix}/test/*`
 
-  router.get('/*', (req, res) => {
-      res.statusCode = 200
-      res.json({ name: 'TEST' })
-  })
+### Example Code
 
-  module.exports = router
-```
+#### Route File Example (server/test.js)
 
-- apis/hello.js
+```javascript
+const express = require('express')
+const moment = require('moment')
+
+const router = express.Router()
+
+router.use((req, res, next) => {
+    const fullUrl = req.protocol + '://' + req.get('host') + req.originalUrl
+    console.log(moment().format('YYYY-MM-DD HH:mm:ss') + ' ' + fullUrl)
+    next()
+})
+
+router.get('/*', (req, res) => {
+    res.statusCode = 200
+    res.json({ name: 'TEST' })
+})
+
+module.exports = router
 ```
+
+#### REST API Example (server/apis/hello.js)
+
+```javascript
 const express = require('express')
 const router = express.Router()
 
@@ -110,8 +156,9 @@ router.get('/*', (req, res) => {
 module.exports = router
 ```
 
-- modules/link/schema.js
-```
+#### GraphQL Schema Example (server/modules/link/schema.js)
+
+```javascript
 module.exports = {
     query: `
         link: String
@@ -124,15 +171,16 @@ module.exports = {
 } 
 ```
 
-- modules/link/resolver.js
-```
+#### GraphQL Resolver Example (server/modules/link/resolver.js)
+
+```javascript
 let localLink = ''
 
 module.exports = {
     link: () => {
         return localLink
     },
-    linkUpdate: ({ link }) =>{
+    linkUpdate: ({ link }) => {
         console.log('link', link)
         localLink = link
         return localLink
@@ -140,8 +188,9 @@ module.exports = {
 }
 ```
 
-- plugins/date.js
-```
+#### GraphQL Plugin Example (server/plugins/date.js)
+
+```javascript
 const moment = require('moment')
 const { Kind } = require('graphql/language')
 const { GraphQLScalarType } = require('graphql')
@@ -157,5 +206,4 @@ const customScalarDate = new GraphQLScalarType({
 })
 
 module.exports = { Date: customScalarDate }
-```
-
+```

package/generation/README.md

@@ -1,16 +1,147 @@
-# NSGM CLI PROJECT
-
-## 命令
-- npm run init    初始化项目
-- npm run upgrade 升级项目基础文件
-- npm run create  创建模板页面
-- npm run delete  删除模板页面
-- npm run dev     开发模式
-- npm run start   生产模式
-- npm run build   编译
-- npm run export  导出静态页面
-        
-## 参数
-- dictionary: 在 export/init 的时候使用, 默认 webapp, 譬如: npm run init|export dictionary=webapp 或者 npm run init|export webapp
-- controller: 在 create/delete 的时候使用， 必须有。譬如： npm run create|delete math
-- action:     在 create/delete 的时候使用， 默认 manage, 跟在 controller 后面， 譬如 npm run create|delete math test
+# 欢迎使用 NSGM 项目
+
+这是一个由 NSGM CLI 创建的全栈开发项目，集成了 Next.js、Styled-components、GraphQL 和 MySQL 技术栈。
+
+## 技术栈
+
+- [Next.js](https://github.com/vercel/next.js) - React 框架
+- [Styled-components](https://github.com/styled-components/styled-components) - CSS-in-JS 解决方案
+- [GraphQL](https://graphql.org/) - API 查询语言
+- [MySQL](https://www.mysql.com/) - 关系型数据库
+
+## 快速入门
+
+### 开发命令
+
+| 命令 | 说明 |
+|---------|-------------|
+| `npm run dev` | 开发模式 |
+| `npm run start` | 生产模式 |
+| `npm run build` | 编译项目 |
+| `npm run export` | 导出静态页面 |
+
+### 代码生成命令
+
+| 命令 | 说明 |
+|---------|-------------|
+| `npm run create` | 创建模板页面 |
+| `npm run delete` | 删除模板页面 |
+
+### 项目维护命令
+
+| 命令 | 说明 |
+|---------|-------------|
+| `npm run upgrade` | 升级项目基础文件 |
+
+## 参数说明
+
+### controller
+- 用于 `create`/`delete` 命令
+- 必填参数
+- 示例:
+  ```
+  npm run create math
+  ```
+
+### action
+- 用于 `create`/`delete` 命令
+- 默认值为 `manage`
+- 跟在 controller 参数后面
+- 示例:
+  ```
+  npm run create math test
+  ```
+
+### dictionary
+- 用于 `export` 命令
+- 默认值为 `webapp`
+- 示例:
+  ```
+  npm run export dictionary=webapp
+  # 或简化为
+  npm run export webapp
+  ```
+
+## 项目结构
+
+```
+├── components/       # 公共组件
+├── pages/            # 页面文件
+│   ├── api/          # API 路由
+│   └── [controller]/ # 控制器页面
+├── public/           # 静态资源
+├── server/           # 服务端代码
+│   ├── apis/         # REST API 接口
+│   ├── modules/      # GraphQL 解析器和模式
+│   └── plugins/      # GraphQL 插件
+├── styles/           # 全局样式
+├── next.config.js    # Next.js 配置
+├── mysql.config.js   # MySQL 配置
+└── project.config.js # 项目配置
+```
+
+## 配置文件
+
+### next.config.js
+
+```javascript
+const { nextConfig } = require('nsgm-cli')
+const projectConfig = require('./project.config')
+
+const { version, prefix, protocol, host } = projectConfig 
+
+module.exports = (phase, defaultConfig) => {
+    let configObj = nextConfig(phase, defaultConfig, { 
+        version, prefix, protocol, host
+    })
+
+    return configObj
+}
+```
+
+### mysql.config.js
+
+```javascript
+const { mysqlConfig } = require('nsgm-cli')
+const { mysqlOptions } = mysqlConfig
+const { user, password, host, port, database } = mysqlOptions
+
+module.exports = {
+    mysqlOptions: {
+        user,
+        password,
+        host,
+        port,
+        database
+    }
+}
+```
+
+### project.config.js
+
+```javascript
+const { projectConfig } = require('nsgm-cli')
+const pkg = require('./package.json')
+
+const { prefix, protocol, host, port } = projectConfig
+const { version } = pkg
+
+module.exports = {
+    version,
+    prefix,
+    protocol,
+    host,
+    port
+}
+```
+
+## 开发指南
+
+1. **创建新页面**：使用 `npm run create [controller] [action]` 命令
+2. **启动开发服务器**：运行 `npm run dev`
+3. **构建生产版本**：运行 `npm run build` 然后 `npm run start`
+4. **导出静态网站**：运行 `npm run export`
+
+## 更多资源
+
+更多详细信息，请参考 [NSGM CLI 文档](https://github.com/erishen/nsgm-cli)。