sumor 2.0.0 → 2.0.3

package/README.md

@@ -0,0 +1 @@
+# Sumor Cloud Application Framework

package/package.json

@@ -1,11 +1,19 @@
 {
   "name": "sumor",
-  "version": "2.0.0",
+  "version": "2.0.3",
   "main": "src/index.js",
   "type": "module",
   "bin": {
     "sumor": "src/cli.js"
   },
+  "files": [
+    "i18n/",
+    "i18nExt/",
+    "modules/",
+    "src/",
+    "LICENSE",
+    "README.md"
+  ],
   "scripts": {
     "demo": "cd demo && npm run start",
     "check": "npm run autofix && npm run coverage",
@@ -26,10 +34,18 @@
     "publish-release-minor": "npm version minor && npm run push-tag",
     "publish-release-major": "npm version major && npm run push-tag"
   },
-  "keywords": [],
-  "author": "",
-  "license": "UNLICENSED",
-  "description": "",
+  "keywords": [
+    "sumor",
+    "openapi",
+    "swagger",
+    "rest",
+    "api",
+    "express",
+    "yaml"
+  ],
+  "author": "Sumor Cloud",
+  "license": "MIT",
+  "description": "It generates a REST API from a YAML file using OpenAPI 3.0 and Express.js.",
   "dependencies": {
     "axios": "^1.8.4",
     "body-parser": "^2.2.0",

package/.eslintignore

@@ -1,6 +0,0 @@
-coverage
-node_modules
-web/public
-static
-tmp
-apiExplorer

package/.eslintrc.yml

@@ -1,4 +0,0 @@
-root: true
-extends:
-  - standard
-  - plugin:prettier/recommended

package/.gitattributes

@@ -1 +0,0 @@
-* text=auto eol=lf

package/.github/workflows/audit.yml

@@ -1,22 +0,0 @@
-name: Audit
-on:
-  schedule:
-    - cron: '0 * * * *'
-jobs:
-  audit:
-    name: Audit
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Run NPM audit
-        run: npm audit

package/.github/workflows/available.yml

@@ -1,22 +0,0 @@
-name: Available
-on:
-  schedule:
-    - cron: '*/1 * * * *'
-jobs:
-  install:
-    name: NPM Installation Test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install NPM dependencies
-        run: npm i sumor
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Dependency Check
-        run: npm ls
-      - name: Audit
-        run: npm audit

package/.github/workflows/ci.yml

@@ -1,45 +0,0 @@
-name: CI
-on:
-  push:
-    branches:
-      - main
-jobs:
-  check:
-    name: Code Quality Check
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Syntax specification checking using ESLint
-        run: npm run lint
-      - name: Run NPM audit
-        run: npm audit
-  test:
-    name: Unit Test
-    needs: check
-    runs-on: ubuntu-latest
-    strategy:
-      matrix:
-        node-version: [18.x, 20.x, 22.x]
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js ${{ matrix.node-version }}
-        uses: actions/setup-node@v4
-        with:
-          node-version: ${{ matrix.node-version }}
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Unit test using Jest
-        run: npm test

package/.github/workflows/coverage.yml

@@ -1,23 +0,0 @@
-name: Coverage
-on:
-  push:
-    branches:
-      - main
-jobs:
-  test:
-    name: Unit Test
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Unit test with coverage using Jest
-        run: npm run coverage

package/.github/workflows/publish.yml

@@ -1,31 +0,0 @@
-name: Publish
-on:
-  push:
-    tags:
-      - '*'
-jobs:
-  publish:
-    name: Publish to NPM
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Install NPM dependencies
-        run: npm ci
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Syntax specification checking using ESLint
-        run: npm run lint
-      - name: Run NPM audit
-        run: npm audit
-      - name: Unit test with coverage using Jest
-        run: npm test
-      - name: Publish to NPM
-        run: npm publish --access public
-        env:
-          NODE_AUTH_TOKEN: ${{ secrets.NPM_TOKEN }}

package/.github/workflows/ut.yml

@@ -1,24 +0,0 @@
-name: Test
-on:
-  schedule:
-    - cron: '0 * * * *'
-jobs:
-  test:
-    name: Unit test for latest dependencies
-    runs-on: ubuntu-latest
-    steps:
-      - name: Checkout code
-        uses: actions/checkout@v4
-      - name: Use Node.js
-        uses: actions/setup-node@v4
-        with:
-          node-version: '20.x'
-          registry-url: 'https://registry.npmjs.org'
-      - name: Remove package-lock.json
-        run: rm -f package-lock.json
-      - name: Install NPM dependencies
-        run: npm i
-      - name: Check dependencies size
-        run: du -sh node_modules
-      - name: Unit test using Jest
-        run: npm run test

package/.husky/pre-commit

@@ -1,10 +0,0 @@
-#!/bin/sh
-#
-# 在运行 pre-commit 脚本之前打印消息
-echo "正在运行 pre-commit 脚本..."
-
-# 运行 pre-commit 命令
-npm run pre-commit
-
-# 在运行 pre-commit 脚本之后打印消息
-echo "pre-commit 脚本运行完成。"

package/.husky/pre-push

@@ -1,10 +0,0 @@
-#!/bin/sh
-
-# 在运行 pre-push 脚本之前打印消息
-echo "正在运行 pre-push 脚本..."
-
-# 运行 pre-push 命令
-npm run pre-push
-
-# 在运行 pre-push 脚本之后打印消息
-echo "pre-push 脚本运行完成。"

package/.prettierrc.yml

@@ -1,7 +0,0 @@
-singleQuote: true
-semi: false
-tabWidth: 2
-printWidth: 100
-trailingComma: none
-arrowParens: avoid
-endOfLine: lf

package/demo/api/error.js

@@ -1,3 +0,0 @@
-export default (req, res) => {
-  throw new Error('This is an error')
-}

package/demo/api/file.js

@@ -1,4 +0,0 @@
-export default (req, res) => {
-  // const file = req.data.file
-  return req.data
-}

package/demo/api/file.yaml

@@ -1,11 +0,0 @@
-name: File
-methods:
-  - POST
-  - GET
-parameters:
-  file:
-    name: 文件
-    type: file
-    required: true
-  id:
-    name: 上传请求号

package/demo/api/hello.js

@@ -1,4 +0,0 @@
-export default (req, res) => {
-  const name = req.data.name
-  return `Hello ${name}!`
-}

package/demo/api/hello.yaml

@@ -1,13 +0,0 @@
-name: Hello
-path:
-  - /hello
-  - /hello/:name
-parameters:
-  name:
-    name: 姓名
-    type: string
-    required: true
-    rules:
-      CHARACTER_LIMIT:
-        expression: '^[a-zA-Z][a-zA-Z0-9_]{0,19}$'
-        message: '姓名只能包含字母、数字和下划线，且不能以数字开头，长度在1-20个字符之间'

package/demo/api/login.js

@@ -1,4 +0,0 @@
-export default (req, res, next) => {
-  req.token.id = 'DEMO_TOKEN'
-  req.token.user = 'DEMO_USER'
-}

package/demo/api/logout.js

@@ -1,4 +0,0 @@
-export default (req, res, next) => {
-  req.token.id = 'DEMO_TOKEN'
-  req.token.user = 'DEMO_USER'
-}

package/demo/api/long.js

@@ -1,9 +0,0 @@
-export default (req, res) => {
-  const times = 100
-  let result = ''
-  for (let i = 0; i < times; i++) {
-    result += 'Hello!'
-  }
-
-  return result
-}

package/demo/api/long.yaml

@@ -1,2 +0,0 @@
-methods:
-  - GET

package/demo/api/user/admin.js

@@ -1,12 +0,0 @@
-export default async (req, res) => {
-  const { token } = req
-
-  token.id = 'DEMO_TOKEN'
-  token.user = 'DEMO_USER'
-
-  token.check('ADMIN')
-
-  return {
-    name: 'John Doe'
-  }
-}

package/demo/api/user/info.js

@@ -1,8 +0,0 @@
-export default async (req, res) => {
-  const { token } = req
-  token.check()
-
-  return {
-    name: 'John Doe'
-  }
-}

package/demo/config/config.yaml

@@ -1,2 +0,0 @@
-name: demo
-desc: 示例应用，用于测试和演示

package/demo/i18n/demo.yaml

@@ -1 +0,0 @@
-name: 测试

package/demo/package.json

@@ -1,6 +0,0 @@
-{
-  "type": "module",
-  "scripts": {
-    "start": "../src/cli.js start"
-  }
-}

package/jest.config.json

@@ -1,26 +0,0 @@
-{
-  "maxWorkers": 10,
-  "reporters": [
-    "default",
-    [
-      "jest-html-reporter",
-      {
-        "pageTitle": "Test Report",
-        "outputPath": "./output/unit/index.html"
-      }
-    ]
-  ],
-  "coverageThreshold": {
-    "global": {
-      "branches": 80,
-      "functions": 80,
-      "lines": 80,
-      "statements": 80
-    }
-  },
-  "coverageDirectory": "output/test/all/coverage",
-  "coverageReporters": ["json", "lcov", "text", "clover"],
-  "collectCoverageFrom": ["modules/**/*.js"],
-  "testPathIgnorePatterns": ["node_modules", "output", "static", "dist", "tmp"],
-  "coveragePathIgnorePatterns": ["node_modules", "output", "static", "dist", "tmp"]
-}

package/test-utils/codeTest/README.md

@@ -1,4 +0,0 @@
-# 代码测试器
-
-代码测试不指定文件的情况下，会自动测试当前目录下的所有代码文件。这消耗太多时间，而指定文件名又很麻烦。
-该工具将通过命令行交互，查找当前目录下的所有测试文件，让用户选择要测试的文件，然后执行测试。

package/test-utils/codeTest/custom.css

@@ -1,47 +0,0 @@
-/* 当浏览器设置为dark模式时生效 */
-a {
-  color: #2196f3;
-}
-
-@media (prefers-color-scheme: dark) {
-  body {
-    background: #000;
-    color: #fff;
-  }
-  .quiet {
-    color: rgba(255, 255, 255, 0.5);
-  }
-  .low {
-    background: rgba(255, 87, 34, 0.5);
-  }
-  .high {
-    background: rgba(255, 255, 255, 0.1);
-  }
-  .medium {
-    background: rgba(255, 87, 34, 0.3);
-  }
-
-  .status-line.medium,
-  .medium .cover-fill {
-    background: rgb(255, 87, 34);
-  }
-  a {
-    color: #a9d9ff;
-  }
-  .coverage-summary th {
-    background: rgba(255, 255, 255, 0.3);
-  }
-  thead tr {
-    border: 1px solid #bbb;
-  }
-  pre {
-    background: rgba(255, 255, 255, 1);
-    color: #000;
-    .quiet {
-      color: rgba(0, 0, 0, 0.7);
-    }
-  }
-  pre a {
-    color: #2196f3;
-  }
-}

package/test-utils/codeTest/index.js

@@ -1,80 +0,0 @@
-import inquirer from 'inquirer'
-import path from 'path'
-import fse from 'fs-extra'
-import getTestFiles from './utils/getTestFiles.js'
-import runTests from './utils/runTests.js'
-import startServer from './utils/startServer.js'
-const LAST_TEST_FILE_PATH = path.join(process.cwd(), 'tmp', 'tools', 'codeTest', 'lastTestFile.txt')
-
-// 主函数
-const executeCodeTest = async () => {
-  const testFiles = getTestFiles(path.join(process.cwd(), 'modules'))
-  if (testFiles.length === 0) {
-    console.log('未找到测试文件。')
-    return
-  }
-
-  // const sortedTestFiles = testFiles.sort((a, b) => {
-  //   if (a.endsWith('/index.test.js') && !b.endsWith('/index.test.js')) return -1
-  //   if (!a.endsWith('/index.test.js') && b.endsWith('/index.test.js')) return 1
-  //   return a.localeCompare(b)
-  // })
-
-  let displayTestFiles = testFiles.map(file => {
-    if (file.endsWith('/index.test.js'))
-      return {
-        name: file.replace('/index.test.js', ''),
-        value: file
-      }
-    return {
-      name: file.replace('.test.js', ''),
-      value: file
-    }
-  })
-  displayTestFiles = displayTestFiles.sort((a, b) => {
-    if (b.name > a.name) return -1
-    else return 1
-  })
-
-  let lastTestFile = ''
-  if (await fse.exists(LAST_TEST_FILE_PATH)) {
-    lastTestFile = await fse.readFile(LAST_TEST_FILE_PATH, 'utf-8')
-  }
-
-  const answers = await inquirer.prompt([
-    {
-      type: 'list',
-      name: 'file',
-      message: `选择要运行的测试文件:（共${displayTestFiles.length - 1}个）`,
-      choices: [{ name: `全部`, value: '' }, ...displayTestFiles],
-      default: lastTestFile
-    }
-  ])
-
-  let selectedFile = answers.file
-  selectedFile = selectedFile || ''
-  const report = await runTests(LAST_TEST_FILE_PATH, selectedFile)
-
-  const unitPath = path.join(report, 'unit')
-
-  const generatedUnitPath = path.join(process.cwd(), 'output', 'unit')
-  await fse.move(generatedUnitPath, path.join(process.cwd(), unitPath))
-
-  const unitPort = await startServer(path.join(process.cwd(), unitPath))
-  console.log(`单元测试报告请访问 http://localhost:${unitPort}`)
-  // console.log(` - 报告目录：${unitPath}`)
-
-  const coveragePath = path.join(report, 'coverage', 'lcov-report')
-
-  // 将custom.css的内容追加到base.css文件中
-  const customCssPath = path.join(new URL('.', import.meta.url).pathname, 'custom.css')
-  const baseCssPath = path.join(coveragePath, 'base.css')
-  const customCss = await fse.readFile(customCssPath, 'utf-8')
-  await fse.appendFile(baseCssPath, customCss)
-
-  const coveragePort = await startServer(path.join(process.cwd(), coveragePath))
-  console.log(`覆盖率报告请访问 http://localhost:${coveragePort}`)
-  // console.log(` - 报告目录：${coveragePath}`)
-}
-
-executeCodeTest()

package/test-utils/codeTest/utils/calculateCoverage.js

@@ -1,55 +0,0 @@
-export function calculateCoverage(coverageJSON) {
-  const results = {}
-  let totalStatements = 0
-  let totalFunctions = 0
-  let totalBranches = 0
-  let totalStatementCoverage = 0
-  let totalFunctionCoverage = 0
-  let totalBranchCoverage = 0
-
-  for (const filePath in coverageJSON) {
-    const fileCoverage = coverageJSON[filePath]
-    const statements = Object.keys(fileCoverage.s).length
-    const functions = Object.keys(fileCoverage.f).length
-    const branches = Object.keys(fileCoverage.b).length
-    const statementCoverage =
-      (Object.values(fileCoverage.s).filter(v => v > 0).length / statements) * 100
-    const functionCoverage =
-      (Object.values(fileCoverage.f).filter(v => v > 0).length / functions) * 100
-    const branchCoverage =
-      (Object.values(fileCoverage.b).filter(v => v.every(b => b > 0)).length / branches) * 100
-
-    results[filePath] = {
-      statements,
-      functions,
-      branches,
-      statementCoverage,
-      functionCoverage,
-      branchCoverage
-    }
-
-    totalStatements += statements
-    totalFunctions += functions
-    totalBranches += branches
-    if (statements > 0) {
-      totalStatementCoverage += statementCoverage * statements
-    }
-    if (functions > 0) {
-      totalFunctionCoverage += functionCoverage * functions
-    }
-    if (branches > 0) {
-      totalBranchCoverage += branchCoverage * branches
-    }
-  }
-
-  const total = {
-    statements: totalStatements,
-    functions: totalFunctions,
-    branches: totalBranches,
-    statementCoverage: totalStatementCoverage / totalStatements,
-    functionCoverage: totalFunctionCoverage / totalFunctions,
-    branchCoverage: totalBranchCoverage / totalBranches
-  }
-
-  return { results, total }
-}

package/test-utils/codeTest/utils/getTestFiles.js

@@ -1,20 +0,0 @@
-import fs from 'fs'
-import path from 'path'
-
-// 获取当前目录下的所有测试文件的函数
-const getTestFiles = testFolder => {
-  let testFiles = []
-  const files = fs.readdirSync(testFolder)
-  files.forEach(file => {
-    const filePath = path.join(testFolder, file)
-    const stat = fs.statSync(filePath)
-    if (stat.isDirectory()) {
-      testFiles = testFiles.concat(getTestFiles(filePath))
-    } else if (file.endsWith('.test.js')) {
-      testFiles.push(filePath.replace(process.cwd() + path.sep, ''))
-    }
-  })
-  return testFiles
-}
-
-export default getTestFiles

package/test-utils/codeTest/utils/runTests.js

@@ -1,38 +0,0 @@
-import { execSync } from 'child_process'
-import fse from 'fs-extra'
-import path from 'path'
-
-// 替换 .test.ts 为 .test.js
-const runTests = async (config, file) => {
-  await fse.remove(path.join(process.cwd(), 'tmp', 'test'))
-
-  await fse.ensureFile(config)
-  await fse.writeFile(config, file, 'utf-8')
-
-  let folder = 'all'
-  if (file !== '') {
-    folder = file.replace('.test.js', '').replace(/\/|\\/g, '.').replace('.index', '')
-  }
-  const root = `./output/test/${folder}`
-  await fse.remove(path.join(process.cwd(), root))
-
-  try {
-    const cmdArr = [
-      'node --experimental-vm-modules node_modules/jest/bin/jest.js',
-      file.replace(/\\/g, '/'),
-      '--coverage',
-      '--coverageDirectory=' + root + '/coverage'
-    ]
-    console.log(cmdArr.join(' '))
-    execSync(cmdArr.join(' '), {
-      stdio: 'inherit'
-    })
-  } catch (e) {
-    if (e) {
-      console.log('\n单元测试失败，调试请查看上述日志')
-    }
-  }
-  return root
-}
-
-export default runTests

package/test-utils/codeTest/utils/startServer.js

@@ -1,23 +0,0 @@
-import express from 'express'
-import { getPortPromise } from 'portfinder'
-
-// 启动网页服务显示覆盖率
-const startServer = async dir => {
-  const app = express()
-  app.use(express.static(dir))
-  const port = await getPortPromise({ port: 16100, stopPort: 16199 })
-  const server = await new Promise(resolve => {
-    const server = app.listen(port, () => {
-      resolve(server)
-    })
-  })
-  process.on('SIGINT', () => {
-    server.close(() => {
-      process.exit(0)
-    })
-  })
-
-  return port
-}
-
-export default startServer

package/test-utils/tmp.js

@@ -1,15 +0,0 @@
-import fse from 'fs-extra'
-import path from 'path'
-
-// await fse.remove(path.join(process.cwd(), 'tmp', 'test'))
-
-export default async namespace => {
-  namespace = namespace || 'unknown'
-  const random = Math.random().toString(36).substring(7)
-  const folderName = namespace + '-' + random
-  const tmpDir = path.join(process.cwd(), 'tmp', 'test', folderName)
-
-  await fse.ensureDir(tmpDir)
-
-  return tmpDir
-}