feat: first impl

.eslintrc

@@ -3,17 +3,5 @@
   "parserOptions": {
     "project": "./tsconfig.json",
     "createDefaultProgram": true
-  },
-  "rules": {
-    "prefer-spread": "off",
-    "no-return-assign": "off",
-    "no-case-declarations": "off",
-    "prefer-const": "off",
-    "no-regex-spaces": "off",
-    "no-return-await": "off",
-    "@typescript-eslint/no-unused-vars": "off",
-    "@typescript-eslint/no-use-before-define": "off",
-    "@typescript-eslint/no-empty-function": "off",
-    "@typescript-eslint/no-var-requires": "off"
   }
 }

.github/workflows/release.yml

@@ -0,0 +1,19 @@
+name: Release
+on:
+  # 合并后自动发布
+  # push:
+  #   branches: [ master, main, next, beta, '*.x' ]
+
+  # 手动发布
+  workflow_dispatch: {}
+
+jobs:
+  release:
+    name: Node.js
+    uses: artusjs/github-actions/.github/workflows/node-release.yml@v1
+    secrets:
+      NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+      GIT_TOKEN: ${{ secrets.GIT_TOKEN }}
+    # with:
+      # checkTest: false
+      # dryRun: true

.npmrc

@@ -0,0 +1 @@
+package-lock=false

README.md

@@ -1,40 +1,36 @@
-# artus-cli/template
+# @artus-cli/plugin-version
 
-template repository for artus-cli
+Built-in plugin for showing version info in artus-cli
 
-<!-- Badge，自行替换掉下面的 `artus-cli/artus-cli` 占位符-->
+[![NPM version](https://img.shields.io/npm/v/@artus-cli/plugin-version.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-version)
+[![NPM quality](https://img.shields.io/npms-io/final-score/@artus-cli/plugin-version.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-version)
+[![NPM download](https://img.shields.io/npm/dm/@artus-cli/plugin-version.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/plugin-version)
+[![Continuous Integration](https://github.com/artus-cli/plugin-version/actions/workflows/ci.yml/badge.svg)](https://github.com/artus-cli/plugin-version/actions/workflows/ci.yml)
+[![Test coverage](https://img.shields.io/codecov/c/github/artus-cli/plugin-version.svg?style=flat-square)](https://codecov.io/gh/artus-cli/plugin-version)
+[![Oss Insight Analytics](https://img.shields.io/badge/OssInsight-artus--cli%2Fartus--cli-blue.svg?style=flat-square)](https://ossinsight.io/analyze/artus-cli/plugin-version)
 
-[![NPM version](https://img.shields.io/npm/v/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![NPM quality](https://img.shields.io/npms-io/final-score/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![NPM download](https://img.shields.io/npm/dm/@artus-cli/artus-cli.svg?style=flat-square)](https://npmjs.org/package/@artus-cli/artus-cli)
-[![Continuous Integration](https://github.com/artus-cli/artus-cli/actions/workflows/ci.yml/badge.svg)](https://github.com/artus-cli/artus-cli/actions/workflows/ci.yml)
-[![Test coverage](https://img.shields.io/codecov/c/github/artus-cli/artus-cli.svg?style=flat-square)](https://codecov.io/gh/artus-cli/artus-cli)
-[![Oss Insight Analytics](https://img.shields.io/badge/OssInsight-artus--cli%2Fartus--cli-blue.svg?style=flat-square)](https://ossinsight.io/analyze/artus-cli/artus-cli)
-
-
-## Usage
+## Install
 
 ```sh
-# print help
-$ my-bin --help
-
-# run dev
-$ my-bin dev --port=8080
+$ npm i @artus-cli/plugin-version
 ```
 
-## Commands
-
-### dev
-
+## Usage
 
-### debug
+```ts
+// plugin.ts
 
+export default {
+  version: {
+    enable: true,
+    package: '@artus-cli/plugin-version'
+  },
+};
+```
 
 ## Contributing
 
 ```sh
 $ npm test
 $ npm run cov
-
-$ npx ts-node src/bin/cli.ts dev --port=8080
 ```

package.json

@@ -1,7 +1,7 @@
 {
-  "name": "@artus-cli/template",
-  "version": "0.0.0",
-  "description": "artus-cli template",
+  "name": "@artus-cli/plugin-version",
+  "version": "0.0.1-beta.1",
+  "description": "version plugin for artus cli",
   "homepage": "",
   "author": "",
   "main": "dist/index.js",
@@ -25,7 +25,7 @@
     "prepack": "npm run tsc"
   },
   "dependencies": {
-    "@artus-cli/artus-cli": "beta"
+    "tslib": "^2.4.0"
   },
   "devDependencies": {
     "@artus/eslint-config-artus": "^0.0.1",
@@ -38,13 +38,13 @@
     "mocha": "^10.0.0",
     "ts-mocha": "^10.0.0",
     "ts-node": "^10.9.1",
+    "@artus-cli/artus-cli": "latest",
     "tsconfig-paths": "^4.1.1",
-    "tslib": "^2.4.0",
     "typescript": "^4.8.2"
   },
   "repository": {
     "type": "git",
-    "url": ""
+    "url": "git@github.com:artus-cli/plugin-version.git"
   },
   "files": [
     "dist"
@@ -55,6 +55,7 @@
   "keywords": [
     "artus",
     "artus-cli",
+    "artus-cli-plugin",
     "command-line-app",
     "cli",
     "commander"

src/index.ts

@@ -1,2 +1,29 @@
-export * from './cmd/dev';
-export * from './cmd/debug';
+import { Program, CommandContext, Inject, ApplicationLifecycle, LifecycleHook, LifecycleHookUnit } from '@artus-cli/artus-cli';
+
+@LifecycleHookUnit()
+export default class VersionLifecycle implements ApplicationLifecycle {
+  @Inject()
+  private readonly program: Program;
+
+  @LifecycleHook()
+  async configDidLoad() {
+    const { rootCommand } = this.program;
+    this.program.option({
+      version: {
+        type: 'boolean',
+        alias: 'v',
+        description: 'Show Version',
+      },
+    }, [ rootCommand ]);
+
+    // intercept root command and show version
+    this.program.useInCommand(rootCommand, async (ctx: CommandContext, next) => {
+      const { args } = ctx;
+      if (args.version) {
+        return console.info(this.program.version);
+      }
+
+      await next();
+    });
+  }
+}

src/meta.json

@@ -0,0 +1,3 @@
+{
+  "name": "version"
+}

src/bin/cli.ts → test/fixtures/my-bin/bin/cli.ts

@@ -1,5 +1,4 @@
 #!/usr/bin/env node
 
 import { start } from '@artus-cli/artus-cli';
-
-start();
+start({ strict: false });

test/fixtures/my-bin/cmd/dev.ts

@@ -0,0 +1,10 @@
+import { DefineCommand, Command } from '@artus-cli/artus-cli';
+
+@DefineCommand({
+  command: 'dev',
+})
+export class DevCommand extends Command {
+  async run() {
+    console.info('dev');
+  }
+}

test/fixtures/my-bin/cmd/main.ts

@@ -0,0 +1,8 @@
+import { DefineCommand, Command } from '@artus-cli/artus-cli';
+
+@DefineCommand()
+export class MainCommand extends Command {
+  async run() {
+    console.info('main');
+  }
+}

test/fixtures/my-bin/config/plugin.ts

@@ -0,0 +1,8 @@
+import path from 'node:path';
+
+export default {
+  version: {
+    enable: true,
+    path: path.resolve(__dirname, '../../../../src'),
+  },
+};

test/fixtures/my-bin/package.json

@@ -0,0 +1,6 @@
+{
+  "name": "my-bin",
+  "version": "1.0.1",
+  "type": "commonjs",
+  "bin": "./bin/cli.js"
+}