Initial commit

whxaxes · web-flow · commit 3baa9b3ef85b · 2023-03-09T17:54:56.000+08:00
diff --git a/.eslintignore b/.eslintignore
@@ -0,0 +1,2 @@
+dist/
+node_modules/
diff --git a/.eslintrc b/.eslintrc
@@ -0,0 +1,7 @@
+{
+  "extends": "@artus/eslint-config-artus/typescript",
+  "parserOptions": {
+    "project": "./tsconfig.json",
+    "createDefaultProgram": true
+  }
+}
diff --git a/.github/workflows/ci.yml b/.github/workflows/ci.yml
@@ -0,0 +1,22 @@
+name: CI
+
+on:
+  push:
+    branches: [ master, main ]
+
+  pull_request:
+    branches: [ master, main, next, beta, "*.x" ]
+
+  schedule:
+    - cron: '0 2 * * *'
+
+  workflow_dispatch: {}
+
+jobs:
+  Job:
+    name: Node.js
+    uses: artusjs/github-actions/.github/workflows/node-test.yml@master
+    # pass these inputs only if you need to custom
+    # with:
+    #   os: 'ubuntu-latest, macos-latest, windows-latest'
+    #   version: '16, 18'
diff --git a/.github/workflows/release.yml b/.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
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,7 @@
+node_modules/
+dist/
+coverage/
+*-lock*[.yaml, .json]
+**/*.js
+**/*.js.map
+**/*.d.ts
diff --git a/.mocharc.yml b/.mocharc.yml
@@ -0,0 +1,5 @@
+spec: test/**/*.test.ts
+extension: ts
+require: ts-node/register
+timeout: 120000
+exclude: test/fixtures/
diff --git a/.npmrc b/.npmrc
@@ -0,0 +1 @@
+package-lock=false
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2022 artus-cli
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
diff --git a/README.md b/README.md
@@ -0,0 +1,47 @@
+# artus-cli/template
+
+template repository for artus-cli
+
+<!-- Badge，自行替换掉下面的 `artus-cli/artus-cli` 占位符-->
+
+[![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)
+
+
+## Install
+
+```sh
+$ npm i -D @artus-cli/artus-cli 
+```
+
+## Usage
+
+```ts
+// plugin.ts
+
+export default {
+  template: {
+    enable: true,
+    package: 'artus-cli/artus-cli',
+  },
+};
+```
+
+## Commands
+
+### dev
+
+
+### debug
+
+
+## Contributing
+
+```sh
+$ npm test
+$ npm run cov
+```
diff --git a/package.json b/package.json
@@ -0,0 +1,63 @@
+{
+  "name": "template-plugin",
+  "version": "0.0.0",
+  "description": "plugin template",
+  "homepage": "",
+  "author": "",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "type": "commonjs",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "require": "./dist/index.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "scripts": {
+    "lint": "eslint . --ext .ts",
+    "postlint": "tsc --noEmit",
+    "test": "mocha",
+    "cov": "c8 -n src/ npm test",
+    "ci": "npm run cov",
+    "tsc": "rm -rf dist && tsc",
+    "prepack": "npm run tsc"
+  },
+  "dependencies": {
+    "tslib": "^2.4.0"
+  },
+  "devDependencies": {
+    "@artus-cli/artus-cli": "latest",
+    "@artus/eslint-config-artus": "^0.0.1",
+    "@artus/tsconfig": "^1",
+    "@types/mocha": "^9.1.1",
+    "@types/node": "^18.7.14",
+    "c8": "^7.12.0",
+    "coffee": "^5.5.0",
+    "eslint": "^8.28.0",
+    "mocha": "^10.0.0",
+    "ts-mocha": "^10.0.0",
+    "ts-node": "^10.9.1",
+    "tsconfig-paths": "^4.1.1",
+    "typescript": "^4.8.2"
+  },
+  "repository": {
+    "type": "git",
+    "url": ""
+  },
+  "files": [
+    "dist"
+  ],
+  "publishConfig": {
+    "access": "public"
+  },
+  "keywords": [
+    "artus",
+    "artus-cli",
+    "artus-cli-plugin",
+    "command-line-app",
+    "cli",
+    "commander"
+  ],
+  "license": "MIT"
+}
diff --git a/src/cmd/example.ts b/src/cmd/example.ts
@@ -0,0 +1,11 @@
+import { DefineCommand, Command } from '@artus-cli/artus-cli';
+
+@DefineCommand({
+  command: 'example',
+  description: 'This is a example command',
+})
+export class ExampleCommand extends Command {
+  async run() {
+    console.info('show example');
+  }
+}
diff --git a/src/index.ts b/src/index.ts
@@ -0,0 +1 @@
+export * from './cmd/example';
diff --git a/src/lifecycle.ts b/src/lifecycle.ts
@@ -0,0 +1,12 @@
+import { Program, Inject, ApplicationLifecycle, LifecycleHook, LifecycleHookUnit } from '@artus-cli/artus-cli';
+
+@LifecycleHookUnit()
+export default class TemplateLifecycle implements ApplicationLifecycle {
+  @Inject()
+  private readonly program: Program;
+
+  @LifecycleHook()
+  async configDidLoad() {
+    console.info('bin', this.program.binName);
+  }
+}
diff --git a/src/meta.json b/src/meta.json
@@ -0,0 +1,3 @@
+{
+  "name": "template"
+}
diff --git a/test/fixtures/my-bin/bin/cli.ts b/test/fixtures/my-bin/bin/cli.ts
@@ -0,0 +1,4 @@
+#!/usr/bin/env node
+
+import { start } from '@artus-cli/artus-cli';
+start();
diff --git a/test/fixtures/my-bin/config/plugin.ts b/test/fixtures/my-bin/config/plugin.ts
@@ -0,0 +1,8 @@
+import path from 'node:path';
+
+export default {
+  template: {
+    enable: true,
+    path: path.resolve(__dirname, '../../../../src'),
+  },
+};
diff --git a/test/fixtures/my-bin/package.json b/test/fixtures/my-bin/package.json
@@ -0,0 +1,6 @@
+{
+  "name": "my-bin",
+  "version": "1.0.1",
+  "type": "commonjs",
+  "bin": "./bin/cli.js"
+}
diff --git a/test/index.test.ts b/test/index.test.ts
@@ -0,0 +1,10 @@
+import { run } from './test-utils';
+
+describe('test/index.test.ts', () => {
+  it('should show example', async () => {
+    await run('my-bin', 'example')
+      // .debug()
+      .expect('stdout', /show example/)
+      .end();
+  });
+});
diff --git a/test/test-utils.ts b/test/test-utils.ts
@@ -0,0 +1,12 @@
+import path from 'path';
+import coffee from 'coffee';
+import { ForkOptions } from 'child_process';
+
+export function run(binName: string, args: string | string[], options: ForkOptions = {}) {
+  const bin = path.resolve(__dirname, './fixtures', binName, 'bin/cli.ts');
+  if (typeof args === 'string') args = args.split(' ');
+  return coffee.fork(bin, args, {
+    execArgv: [ '-r', 'ts-node/register' ].concat(options.execArgv || []),
+    ...options,
+  });
+}
diff --git a/test/tsconfig.json b/test/tsconfig.json
@@ -0,0 +1,6 @@
+{
+  "extends": "../tsconfig",
+  "include": [
+    "**/*.ts"
+  ]
+}
diff --git a/tsconfig.json b/tsconfig.json
@@ -0,0 +1,12 @@
+{
+  "extends": "@artus/tsconfig",
+  "compilerOptions": {
+    "baseUrl": ".",
+    "resolveJsonModule": true,
+    "outDir": "dist"
+  },
+  "include": [
+    "src/**/*.ts",
+    "src/**/*.json"
+  ]
+}
