feat: add v4 template (#74)

* feat: add v4 template

* test: fix v3/v4

* feat: Added Node.js CI workflow support for v3 and v4 builds

* chore: update

* fix: remove pnm

* fix: dir

* chore: update

Author: czy88840616

.github/workflows/nodejs.yml

@@ -3,31 +3,67 @@ name: Node.js CI
 on: [push, pull_request]
 
 jobs:
-  build:
-
+  build-v3:
     runs-on: ubuntu-latest
-
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
-
+        node-version: [18.x]
     steps:
     - uses: actions/checkout@v2
     - name: Use Node.js ${{ matrix.node-version }}
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm run test
+    - name: Install dependencies (v3)
+      run: npm install
+    - name: Test (v3)
+      run: npm run test
+      env:
+        PKG_ROOT: v3
 
-  build-windows:
+  build-v4:
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
+    steps:
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies (v4)
+      run: npm install
+    - name: Test (v4)
+      run: npm run test
+      env:
+        PKG_ROOT: v4
 
+  build-v3-windows:
     runs-on: windows-latest
-
     strategy:
       matrix:
-        node-version: [16.x, 18.x]
+        node-version: [18.x]
+    steps:
+    - name: Configure git
+      run: git config --global core.autocrlf false
+    - uses: actions/checkout@v2
+    - name: Use Node.js ${{ matrix.node-version }}
+      uses: actions/setup-node@v1
+      with:
+        node-version: ${{ matrix.node-version }}
+    - name: Install dependencies (v3, Windows)
+      run: npm install
+    - name: Test (v3, Windows)
+      run: npm run test
+      env:
+        PKG_ROOT: v3
 
+  build-v4-windows:
+    runs-on: windows-latest
+    strategy:
+      matrix:
+        node-version: [20.x]
     steps:
     - name: Configure git
       run: git config --global core.autocrlf false
@@ -36,5 +72,9 @@ jobs:
       uses: actions/setup-node@v1
       with:
         node-version: ${{ matrix.node-version }}
-    - run: npm install
-    - run: npm run test
+    - name: Install dependencies (v4, Windows)
+      run: npm install
+    - name: Test (v4, Windows)
+      run: npm run test
+      env:
+        PKG_ROOT: v4

lerna.json

@@ -1,6 +1,7 @@
 {
   "packages": [
     "v3/*",
+    "v4/*",
     "midway-boilerplate-list",
     "create-midway"
   ],

midway-boilerplate-list/index.js

@@ -41,15 +41,22 @@ module.exports = {
     package: "@midwayjs-examples/application-koa-esm-v3",
     group: "v3-esm",
   },
+  "koa-v4": {
+    desc: "A web application boilerplate with midway v4(koa), now in beta",
+    package: "@midwayjs-examples/application-koa-v4",
+    group: "v4(beta)",
+  },
   web: {
     desc: "A web application boilerplate with midway and Egg.js",
     package: "@midwayjs-examples/application-web",
     group: "v2",
+    hidden: true,
   },
   koa: {
     desc: "A web application boilerplate with midway and koa",
     package: "@midwayjs-examples/application-koa",
     group: "v2",
+    hidden: true,
   },
   express: {
     desc: "A web application boilerplate with midway and express",

package.json

@@ -11,7 +11,7 @@
   "scripts": {
     "release": "lerna publish",
     "test": "cross-env ./scripts/prepare.sh",
-    "test_once": "cross-env ./scripts/prepare.sh v3/midway-framework-web",
+    "test_once": "cross-env ./scripts/prepare.sh v4/midway-framework-koa",
     "build": "lerna run build"
   },
   "engines": {

scripts/prepare.sh

@@ -9,38 +9,40 @@ tmpdir=$origin_cwd/tmp
 rm -rf $tmpdir
 mkdir -p $tmpdir
 
-if [ -z "$1" ]
+run_for_pkg() {
+  pkg_path=$1
+  pkg_name=${pkg_path#*/}
+  cd $tmpdir
+  echo $origin_cwd/$pkg_path
+  node $generator_script $tmpdir/$pkg_name $origin_cwd/$pkg_path
+  cd $pkg_name
+  npm install
+  npm run lint --if-present || exit 1
+  npm run test || exit 1
+  echo $tmpdir/$pkg_name
+}
+
+if [ ! -z "$PKG_ROOT" ] && { [ "$PKG_ROOT" = "v3" ] || [ "$PKG_ROOT" = "v4" ]; }
 then
-  # v3
   cwd=$origin_cwd
   cd $origin_cwd
-
   rm -rf $tmpdir
   mkdir -p $tmpdir
-
-  pkgs=`find v3 -maxdepth 1 -mindepth 1`
-
+  pkgs=`find $PKG_ROOT -maxdepth 1 -mindepth 1`
   for pkg in $pkgs
   do
-    cd $tmpdir
-    echo $cwd/$pkg
-    node $generator_script $tmpdir/${pkg#*/} $cwd/$pkg
-    cd ${pkg#*/}
-    npm install
-    npm run lint --if-present || exit 1
-    npm run test || exit 1
-    echo $tmpdir/${pkg#*/}
+    run_for_pkg $pkg
   done
+elif [ -z "$1" ]
+then
+  # 兼容老逻辑，默认不处理
+  echo "请通过 PKG_ROOT 指定目录或传入具体包路径"
+  exit 1
 else
   cwd=$origin_cwd
   cd $tmpdir
   pkg=$1
-  echo $cwd/$pkg
-  node $generator_script $tmpdir/${pkg#*/} $cwd/$pkg
-  cd ${pkg#*/}
-  npm install
-  npm run lint --if-present || exit 1
-  npm run test || exit 1
+  run_for_pkg $pkg
 fi
 
 echo 'complete'

v4/midway-framework-koa/.npmignore

@@ -0,0 +1 @@
+node_modules

v4/midway-framework-koa/README.md

@@ -0,0 +1,3 @@
+# midway koa boilerplate
+
+midway for koa 脚手架。

v4/midway-framework-koa/after.js

@@ -0,0 +1,14 @@
+const fse = require('fs').promises;
+const { join } = require('path');
+
+function random(start, end) {
+  return Math.floor(Math.random() * (end - start) + start);
+}
+
+module.exports = async options => {
+  const currentFilePath = join(options.targetRoot, 'src/config/config.default.ts');
+  let contents = await fse.readFile(currentFilePath, 'utf-8');
+  contents = contents.replace('{{keys}}', Date.now() + '_' + random(100, 10000));
+
+  await fse.writeFile(currentFilePath, contents);
+};

v4/midway-framework-koa/boilerplate/README.md

@@ -0,0 +1,29 @@
+# my_midway_project
+
+## QuickStart
+
+<!-- add docs here for user -->
+
+see [midway docs][midway] for more detail.
+
+### Development
+
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
+```
+
+### Deploy
+
+```bash
+$ npm start
+```
+
+### npm scripts
+
+- Use `npm run lint` to check code style.
+- Use `npm test` to run unit test.
+
+
+[midway]: https://midwayjs.org

v4/midway-framework-koa/boilerplate/README.zh-CN.md

@@ -0,0 +1,29 @@
+# my_midway_project
+
+## 快速入门
+
+<!-- 在此次添加使用文档 -->
+
+如需进一步了解，参见 [midway 文档][midway]。
+
+### 本地开发
+
+```bash
+$ npm i
+$ npm run dev
+$ open http://localhost:7001/
+```
+
+### 部署
+
+```bash
+$ npm start
+```
+
+### 内置指令
+
+- 使用 `npm run lint` 来做代码风格检查。
+- 使用 `npm test` 来执行单元测试。
+
+
+[midway]: https://midwayjs.org