From 205ef26535a2f8e0ca8912085e24c1687a019f3a Mon Sep 17 00:00:00 2001 From: Suyi Date: Wed, 31 Jan 2024 11:17:09 +0800 Subject: [PATCH] refactor: rename cli to artusx-init --- README.md | 5 ++-- common/config/rush/command-line.json | 26 +++++++++---------- common/config/rush/pnpm-lock.yaml | 2 +- rush.json | 4 +-- .../boilerplate/.eslintignore | 0 .../plugin-boilerplate/boilerplate/.eslintrc | 0 .../plugin-boilerplate/boilerplate/README.md | 0 .../boilerplate/_package.json | 0 .../plugin-boilerplate/boilerplate/gitignore | 0 .../boilerplate/src/client.ts | 0 .../boilerplate/src/config/config.default.ts | 0 .../boilerplate/src/constants.ts | 0 .../boilerplate/src/index.ts | 0 .../boilerplate/src/lifecycle.ts | 0 .../boilerplate/src/meta.json | 0 .../boilerplate/tsconfig.json | 0 .../boilerplate/plugin-boilerplate/index.js | 0 .../plugin-boilerplate/package.json | 0 toolchains/{cli => artusx-init}/package.json | 4 +-- .../{cli => artusx-init}/src/bin/cli.ts | 0 .../{cli => artusx-init}/src/cmd/main.ts | 0 toolchains/{cli => artusx-init}/src/meta.json | 0 toolchains/{cli => artusx-init}/tsconfig.json | 0 23 files changed, 20 insertions(+), 21 deletions(-) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/.eslintignore (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/.eslintrc (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/README.md (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/_package.json (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/gitignore (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/client.ts (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/config/config.default.ts (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/constants.ts (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/index.ts (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/lifecycle.ts (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/src/meta.json (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/boilerplate/tsconfig.json (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/index.js (100%) rename toolchains/{cli => artusx-init}/boilerplate/plugin-boilerplate/package.json (100%) rename toolchains/{cli => artusx-init}/package.json (88%) rename toolchains/{cli => artusx-init}/src/bin/cli.ts (100%) rename toolchains/{cli => artusx-init}/src/cmd/main.ts (100%) rename toolchains/{cli => artusx-init}/src/meta.json (100%) rename toolchains/{cli => artusx-init}/tsconfig.json (100%) diff --git a/README.md b/README.md index b2696205..e1d09326 100644 --- a/README.md +++ b/README.md @@ -101,9 +101,8 @@ rush update create new plugin (with @artusx/cli) ```bash -# create plugin with name @artusx/postgres -# will also update projects in rush.json -rush artusx --name postgres +# create new package and update projects in rush.json +rush gen --name postgres ``` publish to npm.js diff --git a/common/config/rush/command-line.json b/common/config/rush/command-line.json index 2e0cbfc5..c71cc29c 100644 --- a/common/config/rush/command-line.json +++ b/common/config/rush/command-line.json @@ -31,10 +31,10 @@ "shellCommand": "commitlint --edit ''" }, { - "name": "artusx", + "name": "gen", "commandKind": "global", - "summary": "project manager for monorepo", - "shellCommand": "node toolchains/cli/dist/bin/cli.js" + "summary": "Generator for monorepo, This command invokes toolchains to create a new package.", + "shellCommand": "node toolchains/artusx-init/dist/bin/cli.js" } // { // /** @@ -206,7 +206,15 @@ * Custom "parameters" introduce new parameters for specified Rush command-line commands. * For example, you might define a "--production" parameter for the "rush build" command. */ - "parameters": [ + "parameters": [ + { + "parameterKind": "string", + "longName": "--name", + "description": "new package name", + "associatedCommands": [ "gen" ], + "argumentName": "ARTUSX_NAME", + "required": true + } // { // /** // * (Required) Determines the type of custom parameter. @@ -419,14 +427,6 @@ // "description": "Use the strawberry flavor" // } // ] - // } - { - "parameterKind": "string", - "longName": "--name", - "description": "name for artusx cli", - "associatedCommands": [ "artusx" ], - "argumentName": "ARTUSX_NAME", - "required": true - } + // } ] } diff --git a/common/config/rush/pnpm-lock.yaml b/common/config/rush/pnpm-lock.yaml index fa98f7c0..b16359b3 100644 --- a/common/config/rush/pnpm-lock.yaml +++ b/common/config/rush/pnpm-lock.yaml @@ -318,7 +318,7 @@ importers: tslib: 2.6.2 typescript: 4.9.5 - ../../toolchains/cli: + ../../toolchains/artusx-init: specifiers: '@artus-cli/artus-cli': ~0.2.10 '@artusx/eslint-config': workspace:* diff --git a/rush.json b/rush.json index 6be459cf..ff83248d 100644 --- a/rush.json +++ b/rush.json @@ -462,8 +462,8 @@ "tags": ["tools"] }, { - "packageName": "@artusx/cli", - "projectFolder": "toolchains/cli", + "packageName": "@artusx/init", + "projectFolder": "toolchains/artusx-init", "tags": ["tools"] }, // plugin diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/.eslintignore b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/.eslintignore similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/.eslintignore rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/.eslintignore diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/.eslintrc b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/.eslintrc similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/.eslintrc rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/.eslintrc diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/README.md b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/README.md similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/README.md rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/README.md diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/_package.json b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/_package.json similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/_package.json rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/_package.json diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/gitignore b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/gitignore similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/gitignore rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/gitignore diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/client.ts b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/client.ts similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/client.ts rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/client.ts diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/config/config.default.ts b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/config/config.default.ts similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/config/config.default.ts rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/config/config.default.ts diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/constants.ts b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/constants.ts similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/constants.ts rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/constants.ts diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/index.ts b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/index.ts similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/index.ts rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/index.ts diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/lifecycle.ts b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/lifecycle.ts similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/lifecycle.ts rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/lifecycle.ts diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/meta.json b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/meta.json similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/src/meta.json rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/src/meta.json diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/tsconfig.json b/toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/tsconfig.json similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/boilerplate/tsconfig.json rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/boilerplate/tsconfig.json diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/index.js b/toolchains/artusx-init/boilerplate/plugin-boilerplate/index.js similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/index.js rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/index.js diff --git a/toolchains/cli/boilerplate/plugin-boilerplate/package.json b/toolchains/artusx-init/boilerplate/plugin-boilerplate/package.json similarity index 100% rename from toolchains/cli/boilerplate/plugin-boilerplate/package.json rename to toolchains/artusx-init/boilerplate/plugin-boilerplate/package.json diff --git a/toolchains/cli/package.json b/toolchains/artusx-init/package.json similarity index 88% rename from toolchains/cli/package.json rename to toolchains/artusx-init/package.json index bb2d0582..670cea18 100644 --- a/toolchains/cli/package.json +++ b/toolchains/artusx-init/package.json @@ -1,7 +1,7 @@ { - "name": "@artusx/cli", + "name": "@artusx/init", "version": "1.0.1-dev.1", - "description": "command line interface for artusx", + "description": "artusx generator for artusx", "keywords": [ "artus.js" ], diff --git a/toolchains/cli/src/bin/cli.ts b/toolchains/artusx-init/src/bin/cli.ts similarity index 100% rename from toolchains/cli/src/bin/cli.ts rename to toolchains/artusx-init/src/bin/cli.ts diff --git a/toolchains/cli/src/cmd/main.ts b/toolchains/artusx-init/src/cmd/main.ts similarity index 100% rename from toolchains/cli/src/cmd/main.ts rename to toolchains/artusx-init/src/cmd/main.ts diff --git a/toolchains/cli/src/meta.json b/toolchains/artusx-init/src/meta.json similarity index 100% rename from toolchains/cli/src/meta.json rename to toolchains/artusx-init/src/meta.json diff --git a/toolchains/cli/tsconfig.json b/toolchains/artusx-init/tsconfig.json similarity index 100% rename from toolchains/cli/tsconfig.json rename to toolchains/artusx-init/tsconfig.json