vona-cli-set-api 1.0.5 → 1.0.11

package/cli/templates/create/module/boilerplate/_package.json

@@ -1,19 +1,21 @@
 {
   "name": "vona-module-<%=argv.name%>",
+  "type": "module",
   "version": "5.0.0",
   "title": "<%=argv.moduleInfo.relativeName%>",
   "vonaModule": {
     "dependencies": {
-      "a-core": "5.0.0"
+      "a-vona": "5.0.0"
     }
   },
-  "type": "module",
   "exports": {
     ".": {
-      "types": ["./src/index.ts", "./dist/index.d.ts"],
-      "development": "./src/index.ts",
-      "import": "./dist/index.js",
-      "default": "./src/index.ts"
+      "types": [
+        "./src/index.ts",
+        "./dist/index.d.ts"
+      ],
+      "import": "./src/index.ts",
+      "default": "./dist/index.js"
     },
     "./package.json": "./package.json"
   },
@@ -21,6 +23,24 @@
   "keywords": ["Vona Module"],
   "author": "<%=argv.author%>",
   "files": ["dist", "static"],
-  "scripts": {},
-  "dependencies": {}
+  "scripts": {
+    "clean": "rimraf dist tsconfig.tsbuildinfo",
+    "tsc:publish": "npm run clean && tsc",
+    "prepublishOnly": "npm run tsc:publish",
+    "prepack": "clean-package",
+    "postpack": "clean-package restore"
+  },
+  "clean-package": {
+    "indent": 2,
+    "remove": [
+      "clean-package",
+      "devDependencies",
+      "exports.\\..import"
+    ]
+  },
+  "dependencies": {},
+  "devDependencies": {
+    "clean-package": "^2.2.0",
+    "rimraf": "^6.0.1"
+  }
 }

package/cli/templates/create/module/boilerplate/_tsconfig.build.json

@@ -0,0 +1,8 @@
+{
+  "extends": "<%=argv.suite?'':'../'%>../../tsconfig.base",
+  "compilerOptions": {
+    "rootDir": "src",
+    "outDir": "dist"
+  },
+  "include": ["src", "src/.metadata/*.ts", "src/**/*.json"]
+}

package/cli/templates/create/module/boilerplate/_tsconfig.json

@@ -1,8 +1,7 @@
 {
   "extends": "<%=argv.suite?'':'../'%>../../tsconfig.base",
   "compilerOptions": {
-    "rootDir": "src",
-    "outDir": "dist"
+    "noEmit": true
   },
-  "include": ["src", "src/.metadata/*.ts", "src/**/*.json"]
+  "include": ["src", "src/.metadata/*.ts", "src/**/*.json", "test"]
 }

package/cli/templates/create/module/snippets/package.json.ts

@@ -0,0 +1,17 @@
+import { metadataCustomSnippet } from '@cabloy/cli';
+
+declare module '@cabloy/cli' {
+  interface ICommandArgv {
+    name: string;
+  }
+}
+
+export default metadataCustomSnippet({
+  file: 'package.json',
+  language: 'json',
+  async transform({ /* cli, */ ast, argv }) {
+    ast.dependencies[`vona-module-${argv.name}`] = 'workspace:^';
+    // ok
+    return ast;
+  },
+});

package/cli/templates/create/module/snippets/tsconfig.json.ts

@@ -0,0 +1,19 @@
+import { metadataCustomSnippet } from '@cabloy/cli';
+
+declare module '@cabloy/cli' {
+  interface ICommandArgv {
+    name: string;
+  }
+}
+
+export default metadataCustomSnippet({
+  file: 'tsconfig.json',
+  language: 'json',
+  async transform({ /* cli, */ ast, argv }) {
+    ast.references.push({
+      path: `modules/${argv.name}/tsconfig.build.json`,
+    });
+    // ok
+    return ast;
+  },
+});

package/cli/templates/create/project/basic/boilerplate/.editorconfig

@@ -0,0 +1,9 @@
+root = true
+
+[*]
+charset = utf-8
+indent_style = space
+indent_size = 2
+end_of_line = lf
+insert_final_newline = true 
+trim_trailing_whitespace = true

package/cli/templates/create/project/basic/boilerplate/.gitattributes

@@ -0,0 +1,2 @@
+* text=auto eol=lf
+*.{png,jpg,jpeg,gif,webp,woff,woff2} binary

package/cli/templates/create/project/basic/boilerplate/.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["vscodevim.vim", "dbaeumer.vscode-eslint"],
+  "unwantedRecommendations": []
+}

package/cli/templates/create/project/basic/boilerplate/.vscode/settings.json

@@ -0,0 +1,45 @@
+{
+  "editor.tabSize": 2,
+  // "editor.formatOnSave": true,
+  "editor.formatOnSave": false,
+  "editor.formatOnPaste": false,
+  "files.eol": "\n",
+  // typescript
+  "typescript.disableAutomaticTypeAcquisition": false,
+  "typescript.format.enable": true,
+  "typescript.implementationsCodeLens.enabled": true,
+  "typescript.tsserver.useSyntaxServer": "auto",
+  "typescript.validate.enable": true,
+  "typescript.suggest.autoImports": true,
+  "typescript.suggest.includeCompletionsForImportStatements": true,
+  "typescript.preferences.importModuleSpecifier": "shortest",
+  "typescript.preferences.importModuleSpecifierEnding": "js",
+  "typescript.preferences.includePackageJsonAutoImports": "on",
+  // eslint
+  "editor.codeActionsOnSave": {
+    "source.fixAll.eslint": "explicit",
+    "source.fixAll.stylelint": "explicit"
+  },
+  "eslint.validate": ["javascript", "javascriptreact", "typescript", "typescriptreact", "vue"],
+  // associations
+  "files.associations": {
+    "*.js.ejs": "javascript",
+    "*.css.ejs": "css",
+    "*.less.ejs": "less",
+    "*.code-snippets": "text",
+    "docker-compose-dockerfile-app": "dockerfile"
+  },
+  // search
+  "search.exclude": {
+    "/.vscode/**": true,
+    "/coverage/**": true,
+    "/docs/**": true,
+    "**/dist/**": true,
+    "/src/backend/app/**": true,
+    "/src/backend/logs/**": true,
+    "/src/backend/run/**": true,
+    "**/node_modules": true
+  },
+  "search.useIgnoreFiles": false,
+  "hide-my-secrets.hideSecrets": false
+}

package/cli/templates/create/project/basic/boilerplate/.vscode/vona.code-snippets

@@ -0,0 +1,51 @@
+/**
+ * supported code snippets as follows:
+ *   __init__
+ **/
+{
+  "__init__": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "init",
+    "body": ["protected __init__() {", "  $0", "}"],
+    "description": "__init__",
+  },
+  "__dispose__": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "dispose",
+    "body": ["protected async __dispose__() {", "  $0", "}"],
+    "description": "__dispose__",
+  },
+  "aop.__init__": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "aopinit",
+    "body": [
+      "protected __init__(_args: Parameters<any>, next: Function, _receiver: any) {",
+      "  await next();",
+      "  $0",
+      "}"
+    ],
+    "description": "aop.__init__"
+  },
+  "aop.__dispose__": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "aopdispose",
+    "body": [
+      "protected async __dispose__(_args: [], next: Function, _receiver: any) {",
+      "  await next();",
+      "  $0",
+      "}"
+    ],
+    "description": "aop.__dispose__"
+  },
+  "aop.action": {
+    "scope": "typescript,typescriptreact",
+    "prefix": "aopaction",
+    "body": [
+      "async action(_args: Parameters<any>, next: Function, _receiver: any) {",
+      "  $0",
+      "  return await next();",
+      "}"
+    ],
+    "description": "aop.action"
+  }
+}

package/cli/templates/create/project/basic/boilerplate/env/.env

@@ -0,0 +1,59 @@
+# app
+
+APP_NAME = Vona
+APP_TITLE = Vona
+APP_VERSION = 5.0.0
+
+# server
+
+SERVER_KEYS = <%=argv.SERVER_KEYS%>
+SERVER_GLOBALPREFIX = /api
+SERVER_PUBLICDIR =
+SERVER_LOGGERDIR =
+SERVER_SUBDOMAINOFFSET = 1
+SERVER_WORKERS =
+SERVER_LISTEN_HOSTNAME = 0.0.0.0
+SERVER_LISTEN_PORT = 7102
+SERVER_LISTEN_DISABLE =
+
+# project
+
+PROJECT_DISABLED_MODULES =
+PROJECT_DISABLED_SUITES =
+
+# build
+
+BUILD_SOURCEMAP = false
+BUILD_MINIFY = true
+BUILD_INLINEDYNAMICIMPORTS = true
+BUILD_LOG_CIRCULAR_DEPENDENCY = false
+
+# test
+
+TEST_CONCURRENCY = true
+TEST_ONLY = false
+TEST_WHYISNODERUNNING = false
+TEST_PATTERNS_IGNORE = '**/test-vona/test/cacheMem.test.ts,**/test-vona/test/cacheRedis.test.ts,**/test-vona/test/summer.test.ts'
+
+# database
+
+DATABASE_DEFAULT_CLIENT = 'pg' # pg/mysql
+
+DATABASE_CLIENT_PG_HOST = 127.0.0.1
+DATABASE_CLIENT_PG_PORT = 5432
+DATABASE_CLIENT_PG_USER = postgres
+DATABASE_CLIENT_PG_PASSWORD = 
+DATABASE_CLIENT_PG_DATABASE = postgres
+
+DATABASE_CLIENT_MYSQL_HOST = 127.0.0.1
+DATABASE_CLIENT_MYSQL_PORT = 3306
+DATABASE_CLIENT_MYSQL_USER = root
+DATABASE_CLIENT_MYSQL_PASSWORD = 
+DATABASE_CLIENT_MYSQL_DATABASE = mysql
+
+# redis
+
+REDIS_DEFAULT_HOST = 127.0.0.1
+REDIS_DEFAULT_PORT = 6379
+REDIS_DEFAULT_PASSWORD = 
+REDIS_DEFAULT_DB = 0

package/cli/templates/create/project/basic/boilerplate/env/.env.prod

@@ -0,0 +1,26 @@
+# server
+
+SERVER_KEYS = <%=argv.SERVER_KEYS_PROD%>
+
+# database
+
+DATABASE_DEFAULT_CLIENT = 'pg' # pg/mysql
+
+DATABASE_CLIENT_PG_HOST = pg # see: docker-compose.yml
+DATABASE_CLIENT_PG_PORT = 5432
+DATABASE_CLIENT_PG_USER = <%=argv.DATABASE_CLIENT_PG_USER%>
+DATABASE_CLIENT_PG_PASSWORD = '<%=argv.DATABASE_CLIENT_PG_PASSWORD%>'
+DATABASE_CLIENT_PG_DATABASE = <%=argv.name%>
+
+DATABASE_CLIENT_MYSQL_HOST = mysql # see: docker-compose.yml
+DATABASE_CLIENT_MYSQL_PORT = 3306
+DATABASE_CLIENT_MYSQL_USER = <%=argv.DATABASE_CLIENT_MYSQL_USER%>
+DATABASE_CLIENT_MYSQL_PASSWORD = '<%=argv.DATABASE_CLIENT_MYSQL_PASSWORD%>'
+DATABASE_CLIENT_MYSQL_DATABASE = <%=argv.name%>
+
+# redis
+
+REDIS_DEFAULT_HOST = redis # see: docker-compose.yml
+REDIS_DEFAULT_PORT = 6379
+REDIS_DEFAULT_PASSWORD = 
+REDIS_DEFAULT_DB = 0

package/cli/templates/create/project/basic/boilerplate/eslint.config.mjs

@@ -0,0 +1,16 @@
+import EslintConfig from '@cabloy/lint/api/eslint.js';
+
+export default EslintConfig({
+  ignores: [
+    '**/*.d.ts',
+    '**/node_modules/**',
+    '**/dist/**',
+    '**/static/**',
+    '.vona',
+    '.assets',
+    'coverage',
+    'docker-compose',
+    'package.json',
+    'scripts',
+  ],
+});

package/cli/templates/create/project/basic/boilerplate/package.original.json

@@ -0,0 +1,45 @@
+{
+  "name": "Vona",
+  "title": "Vona",
+  "private": true,
+  "type": "module",
+  "description": "Vona is an intuitive, elegant and powerful Node.js framework for rapidly developing enterprise applications of any size",
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/vonajs/vona.git"
+  },
+  "author": "zhennann",
+  "keywords": ["nodejs", "full-stack", "workflow-engine", "vona", "cabloy"],
+  "bugs": {
+    "url": "https://github.com/vonajs/vona/issues"
+  },
+  "homepage": "https://github.com/vonajs/vona#readme",
+  "engines": {
+    "node": ">=23.7.0"
+  },
+  "scripts": {
+    "init": "npm run prerun && pnpm install --no-frozen-lockfile",
+    "vona": "vona",
+    "demo": "npm run vona :bin:demo -- --flavor=normal",
+    "db:reset": "npm run prerun && npm run vona :bin:dbReset -- --flavor=normal",
+    "dev": "npm run prerun && npm run vona :bin:dev -- --workers=2 --flavor=normal",
+    "dev:one": "npm run prerun && npm run vona :bin:dev -- --workers=1 --flavor=normal",
+    "test": "npm run prerun && npm run vona :bin:test -- --flavor=normal",
+    "cov": "npm run prerun && npm run vona :bin:test -- --coverage --flavor=normal",
+    "tsc": "npm run prerun && npm run vona :bin:tsc",
+    "build": "npm run prerun && npm run vona :bin:build -- --flavor=normal",
+    "start": "node ./dist/bootstrap.js",
+    "prerun": "npm run vona :tools:deps",
+    "lint": "eslint",
+    "lint:fix": "eslint --fix"
+  },
+  "pnpm": {
+    "overrides": {
+      "@types/mime": "3.0.4"
+    }
+  },
+  "dependencies": {
+    "vona": "workspace:^"
+  },
+  "devDependencies": {}
+}

package/cli/templates/create/project/basic/boilerplate/pnpm-workspace.yaml

@@ -0,0 +1,7 @@
+packages:
+  - 'src/module/*'
+  - 'src/module-vendor/*'
+  - 'src/suite/*'
+  - 'src/suite/*/modules/*'
+  - 'src/suite-vendor/*'
+  - 'src/suite-vendor/*/modules/*'

package/cli/templates/create/project/basic/boilerplate/scripts/app-init.sh

@@ -0,0 +1,4 @@
+#!/usr/bin/env bash
+
+cp /opt/node/app/dist/* -r /root/output/app/dist
+npm run start:backend

package/cli/templates/create/project/basic/boilerplate/scripts/wait-for-it.sh

@@ -0,0 +1,156 @@
+#!/usr/bin/env bash
+#   Use this script to test if a given TCP host/port are available
+
+cmdname=$(basename $0)
+
+echoerr() { if [[ $QUIET -ne 1 ]]; then echo "$@" 1>&2; fi }
+
+usage() {
+    cat << USAGE >&2
+Usage:
+    $cmdname host:port [-s] [-t timeout] [-- command args]
+    -s | --strict               Only execute subcommand if the test succeeds
+    -q | --quiet                Don't output any status messages
+    -t TIMEOUT | --timeout=TIMEOUT
+                                Timeout in seconds, zero for no timeout
+    -- COMMAND ARGS             Execute command with args after the test finishes
+USAGE
+    exit 1
+}
+
+wait_for() {
+    local wait_host=$1
+    local wait_port=$2
+    if [[ $TIMEOUT -gt 0 ]]; then
+        echoerr "$cmdname: waiting $TIMEOUT seconds for $wait_host:$wait_port"
+    else
+        echoerr "$cmdname: waiting for $wait_host:$wait_port without a timeout"
+    fi
+    local start_ts=$(date +%s)
+    while :
+    do
+        (echo > /dev/tcp/$wait_host/$wait_port) >/dev/null 2>&1
+        local result=$?
+        if [[ $result -eq 0 ]]; then
+            local end_ts=$(date +%s)
+            echoerr "$cmdname: $wait_host:$wait_port is available after $((end_ts - start_ts)) seconds"
+            break
+        fi
+        sleep 1
+    done
+    return $result
+}
+
+wait_for_wrapper() {
+    local wait_host=$1
+    local wait_port=$2
+    # In order to support SIGINT during timeout: http://unix.stackexchange.com/a/57692
+    if [[ $QUIET -eq 1 ]]; then
+        timeout $TIMEOUT $0 $wait_host:$wait_port --quiet --child --timeout=$TIMEOUT &
+    else
+        timeout $TIMEOUT $0 $wait_host:$wait_port --child --timeout=$TIMEOUT &
+    fi
+    PID=$!
+    trap "kill -INT -$PID" INT
+    wait $PID
+    RESULT=$?
+    if [[ $RESULT -ne 0 ]]; then
+        echoerr "$cmdname: timeout occurred after waiting $TIMEOUT seconds for $wait_host:$wait_port"
+    fi
+    return $RESULT
+}
+
+parse_arguments() {
+  local index=0
+  while [[ $# -gt 0 ]]
+  do
+      case "$1" in
+          *:* )
+          hostport=(${1//:/ })
+          HOST[$index]=${hostport[0]}
+          PORT[$index]=${hostport[1]}
+          shift 1
+          ;;
+          --child)
+          CHILD=1
+          shift 1
+          ;;
+          -q | --quiet)
+          QUIET=1
+          shift 1
+          ;;
+          -s | --strict)
+          STRICT=1
+          shift 1
+          ;;
+          -t)
+          TIMEOUT="$2"
+          if [[ $TIMEOUT == "" ]]; then break; fi
+          shift 2
+          ;;
+          --timeout=*)
+          TIMEOUT="${1#*=}"
+          shift 1
+          ;;
+          --)
+          shift
+          CLI="$@"
+          break
+          ;;
+          --help)
+          usage
+          ;;
+          *)
+          echoerr "Unknown argument: $1"
+          usage
+          ;;
+      esac
+      let index+=1
+  done
+  if [[ ${#HOST[@]} -eq 0 || ${#PORT[@]} -eq 0 ]]; then
+      echoerr "Error: you need to provide a host and port to test."
+      usage
+  fi
+}
+
+iterate_hosts() {
+  local result=0
+  local index=0
+  local wait_function=$1
+  while [[ $result -eq 0 && $index -lt ${#HOST[@]} ]]; do
+    ($wait_function ${HOST[$index]} ${PORT[$index]})
+    result=$?
+    let index+=1
+  done
+  echo $result
+}
+
+wait_for_services() {
+  TIMEOUT=${TIMEOUT:-15}
+  STRICT=${STRICT:-0}
+  CHILD=${CHILD:-0}
+  QUIET=${QUIET:-0}
+
+  if [[ $CHILD -gt 0 ]]; then
+      exit $(iterate_hosts wait_for)
+  else
+      if [[ $TIMEOUT -gt 0 ]]; then
+          RESULT=$(iterate_hosts wait_for_wrapper)
+      else
+          RESULT=$(iterate_hosts wait_for)
+      fi
+  fi
+}
+
+parse_arguments "$@"
+wait_for_services
+
+if [[ $CLI != "" ]]; then
+    if [[ $RESULT -ne 0 && $STRICT -eq 1 ]]; then
+        echoerr "$cmdname: strict mode, refusing to execute subprocess"
+        exit $RESULT
+    fi
+    exec $CLI
+else
+    exit $RESULT
+fi

package/cli/templates/create/project/basic/boilerplate/src/backend/config/config/config.local.ts

@@ -0,0 +1,10 @@
+import type { VonaAppInfo, VonaConfigOptional } from 'vona';
+
+export default function (_appInfo: VonaAppInfo) {
+  const config = {} as VonaConfigOptional;
+
+  // modules
+  config.modules = {};
+
+  return config;
+}

package/cli/templates/create/project/basic/boilerplate/src/backend/config/config/config.prod.ts

@@ -0,0 +1,21 @@
+import type { VonaAppInfo, VonaConfigOptional } from 'vona';
+
+export default function (_appInfo: VonaAppInfo) {
+  const config = {} as VonaConfigOptional;
+
+  // instances
+  config.instances = [
+    {
+      instanceName: '',
+      password: '',
+      title: '',
+      config: {
+      },
+    },
+  ];
+
+  // modules
+  config.modules = {};
+
+  return config;
+}

package/cli/templates/create/project/basic/boilerplate/src/backend/config/config/config.test.ts

@@ -0,0 +1,10 @@
+import type { VonaAppInfo, VonaConfigOptional } from 'vona';
+
+export default function (_appInfo: VonaAppInfo) {
+  const config = {} as VonaConfigOptional;
+
+  // modules
+  config.modules = {};
+
+  return config;
+}

package/cli/templates/create/project/basic/boilerplate/src/backend/config/config/config.ts

@@ -0,0 +1,10 @@
+import type { VonaAppInfo, VonaConfigOptional } from 'vona';
+
+export default function (_appInfo: VonaAppInfo) {
+  const config = {} as VonaConfigOptional;
+
+  // modules
+  config.modules = {};
+
+  return config;
+}

package/cli/templates/create/project/basic/boilerplate/src/backend/config/locale/en-us.ts

@@ -0,0 +1,5 @@
+import type { VonaLocaleOptional } from 'vona';
+
+export default {
+  modules: {},
+} as VonaLocaleOptional;

package/cli/templates/create/project/basic/boilerplate/src/backend/config/locale/zh-cn.ts

@@ -0,0 +1,5 @@
+import type { VonaLocaleOptional } from 'vona';
+
+export default {
+  modules: {},
+} as VonaLocaleOptional;

package/cli/templates/create/project/basic/boilerplate/src/backend/config/locales.ts

@@ -0,0 +1,7 @@
+import en_us from './locale/en-us.ts';
+import zh_cn from './locale/zh-cn.ts';
+
+export const locales = {
+  'en-us': en_us,
+  'zh-cn': zh_cn,
+};

package/cli/templates/create/project/basic/boilerplate/src/backend/typing/env.d.ts

@@ -0,0 +1,5 @@
+/* eslint-disable */
+
+declare namespace NodeJS {
+  interface ProcessEnv {}
+}

package/cli/templates/create/project/basic/boilerplate/tsconfig.base.esm.json

@@ -0,0 +1,10 @@
+{
+  "extends": "@cabloy/lint/api/tsconfig.base.esm",
+  "compilerOptions": {
+    "target": "esnext",
+    "module": "nodenext",
+    "allowImportingTsExtensions": true,
+    "rewriteRelativeImportExtensions": true,
+    "verbatimModuleSyntax": true
+  }
+}

package/cli/templates/create/project/basic/boilerplate/tsconfig.base.json

@@ -0,0 +1,3 @@
+{
+  "extends": "./tsconfig.base.esm.json"
+}