react-nest-cli 1.0.0

package/README.md

@@ -0,0 +1,33 @@
+## 项目介绍
+
+一个脚手架工具，用于快速生成 react+nest 项目
+
+使用脚手架 自动化生成项目、规范依赖管理、规范代码风格、代码质量控制、自动化测试、CI/CD 配置、提高开发效率。
+
+
+## 安装
+
+```bash
+npm install -g react-nest-cli
+```
+
+## 基本使用
+
+```bash
+react-nest init <project-name>
+```
+
+
+## 脚手架命令列表
+init 初始化项目
+version 展示版本信息
+info 展示脚手架信息
+help 展示帮助信息
+
+## 项目命令列表
+serve 启动项目
+build 构建项目
+preview 本地预览项目
+lint 检查项目代码风格和质量
+deploy 部署项目到指定环境，如测试环境、预发环境、生产环境等
+test 运行测试用例

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+
+export {  }

package/dist/index.js

@@ -0,0 +1,88 @@
+// packages/cli/src/index.ts
+import { program } from "commander";
+import picocolors from "picocolors";
+import figlet from "figlet";
+import prompts from "prompts";
+import consola from "consola";
+import ora from "ora";
+import { downloadTemplate } from "giget";
+import path from "path";
+import fsExtra from "fs-extra";
+
+// packages/cli/src/configs/text.config.ts
+var text_config_default = {
+  font: "Ghost",
+  horizontalLayout: "default",
+  verticalLayout: "default",
+  width: 200,
+  whitespaceBreak: true
+};
+
+// packages/cli/src/configs/prompts.config.ts
+var prompts_config_default = {
+  templates: [
+    { title: "React + Nest", value: "react-nest", description: "\u8FD9\u4E2A\u6A21\u677F\u5305\u542B\u4E86 React + Nest \u9879\u76EE\u7684\u57FA\u672C\u914D\u7F6E", disabled: false },
+    { title: "React + Nest + TypeScript", value: "react-nest-ts", description: "\u8FD9\u4E2A\u6A21\u677F\u5305\u542B\u4E86 React + Nest + TypeScript \u9879\u76EE\u7684\u57FA\u672C\u914D\u7F6E", disabled: false }
+  ]
+};
+
+// packages/cli/src/index.ts
+var logInfo = () => {
+  console.info(picocolors.yellow(figlet.textSync("React Nest CLI", text_config_default)));
+  consola.start(picocolors.yellow(program.description()));
+  consola.info(picocolors.yellow(program.version()));
+};
+program.version("1.0.0", "-V, --version", "\u8F93\u51FA\u7248\u672C\u53F7").helpOption("-h, --help", "\u8F93\u51FA\u5E2E\u52A9\u4FE1\u606F").description("\u4E00\u4E2A\u811A\u624B\u67B6\u5DE5\u5177\uFF0C\u7528\u4E8E\u5FEB\u901F\u751F\u6210 React+Nest \u9879\u76EE").action(logInfo);
+program.command("info").description("\u8F93\u51FA\u9879\u76EE\u4FE1\u606F").action(logInfo);
+program.command("init").description("\u521D\u59CB\u5316\u9879\u76EE").argument("[project-name]", "\u9879\u76EE\u540D\u79F0").option("--template <template-name>", "\u9879\u76EE\u6A21\u677F\u540D\u79F0").action(async (projectName, rest) => {
+  let { template } = rest || {};
+  if (!projectName) {
+    const response = await prompts({
+      type: "text",
+      initial: "my-project",
+      // 默认值
+      name: "projectName",
+      message: "\u8BF7\u8F93\u5165\u9879\u76EE\u540D\u79F0"
+      // validate: value => value.length ? true : '请输入项目名称'
+    });
+    projectName = response.projectName;
+  }
+  const noTemplate = template && !prompts_config_default.templates.find((item) => item.value === template);
+  if (!template || noTemplate) {
+    if (noTemplate) {
+      consola.error(`\u9879\u76EE\u6A21\u677F ${template} \u4E0D\u5B58\u5728, \u8BF7\u9009\u62E9\u5176\u4ED6\u6A21\u677F`);
+    }
+    const response = await prompts({
+      type: "select",
+      name: "template",
+      message: "\u8BF7\u9009\u62E9\u9879\u76EE\u6A21\u677F",
+      choices: prompts_config_default.templates,
+      initial: 0
+      // 默认选择第一个
+    });
+    template = response.template;
+  }
+  const tip = `\u521D\u59CB\u5316\u9879\u76EE ${projectName}\uFF0C\u6A21\u677F ${template}`;
+  const spinner = ora({
+    text: tip,
+    color: "blue"
+    // spinner: 'growVertical',
+    // isEnabled: false
+  });
+  spinner.start();
+  const projectDir = path.resolve(import.meta.dirname, projectName);
+  if (fsExtra.existsSync(projectDir)) {
+    spinner.fail(`\u{1F4A5}\u521D\u59CB\u5316\u5931\u8D25: \u9879\u76EE\u76EE\u5F55 ${projectName} \u5DF2\u5B58\u5728`);
+    return;
+  }
+  const res = await downloadTemplate(`github:liaolonghui/react-nest-cli/packages/templates/${template}#main`, {
+    dir: projectDir
+  });
+  const { dir } = res;
+  spinner.succeed(`\u9879\u76EE\u521D\u59CB\u5316\u6210\u529F\uFF0C\u9879\u76EE\u76EE\u5F55\uFF1A${dir}`);
+});
+program.command("version").description("\u8F93\u51FA\u7248\u672C\u53F7").action(() => {
+  consola.info(figlet.textSync(`version ==> ${program.version()}`, text_config_default));
+});
+program.parse();
+//# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -0,0 +1 @@
+{"version":3,"sources":["../packages/cli/src/index.ts","../packages/cli/src/configs/text.config.ts","../packages/cli/src/configs/prompts.config.ts"],"sourcesContent":["import { program } from \"commander\";\nimport picocolors from \"picocolors\"; // 也可用chalk\nimport figlet from 'figlet';\nimport prompts from 'prompts'; // 也可用inquirer、手动readline等\nimport consola from \"consola\";\nimport ora from 'ora';\nimport { downloadTemplate } from 'giget';\nimport path from 'node:path';\nimport fsExtra from 'fs-extra';\nimport textConfig from './configs/text.config.ts';\nimport promptsConfig from \"./configs/prompts.config.ts\";\n\n\n// 输出项目信息\nconst logInfo = () => {\n    console.info(picocolors.yellow(figlet.textSync('React Nest CLI', textConfig)))\n    consola.start(picocolors.yellow(program.description()))\n    consola.info(picocolors.yellow(program.version()))\n}\n\n\nprogram\n    .version(\"1.0.0\", '-V, --version', '输出版本号')\n    .helpOption('-h, --help', '输出帮助信息')\n    // .help((str) => '帮助信息：\\n' + str)\n    .description(\"一个脚手架工具，用于快速生成 React+Nest 项目\")\n    .action(logInfo);\n\n// 输出项目信息\nprogram\n    .command('info')\n    .description('输出项目信息')\n    .action(logInfo);\n\n// 初始化项目\nprogram\n    .command('init')\n    .description('初始化项目')\n    .argument('[project-name]', '项目名称')\n    .option('--template <template-name>', '项目模板名称')\n    .action(async (projectName, rest) => {\n        let { template } = rest || {};\n        // 如果projectName没有提供，让用户输入\n        if (!projectName) {\n            const response = await prompts({\n                type: 'text',\n                initial: 'my-project', // 默认值\n                name: 'projectName',\n                message: '请输入项目名称',\n                // validate: value => value.length ? true : '请输入项目名称'\n            });\n            projectName = response.projectName;\n        }\n\n        // 如果template没有提供或者template不存在，让用户选择\n        const noTemplate = (template && !promptsConfig.templates.find(item => item.value === template));\n        if (!template || noTemplate) {\n            if (noTemplate) {\n                consola.error(`项目模板 ${template} 不存在, 请选择其他模板`);\n            }\n            const response = await prompts({\n                type: 'select',\n                name: 'template',\n                message: '请选择项目模板',\n                choices: promptsConfig.templates,\n                initial: 0, // 默认选择第一个\n            });\n            template = response.template;\n        }\n\n        const tip = `初始化项目 ${projectName}，模板 ${template}`;\n        const spinner = ora({\n            text: tip,\n            color: 'blue',\n            // spinner: 'growVertical',\n            // isEnabled: false\n        });\n        spinner.start();\n\n        const projectDir = path.resolve(import.meta.dirname, projectName);\n        if (fsExtra.existsSync(projectDir)) {\n            spinner.fail(`💥初始化失败: 项目目录 ${projectName} 已存在`);\n            return;\n        }\n\n        const res = await downloadTemplate(`github:liaolonghui/react-nest-cli/packages/templates/${template}#main`, {\n            dir: projectDir,\n        });\n        const { dir } = res;\n        spinner.succeed(`项目初始化成功，项目目录：${dir}`);\n        // console.log(res);\n\n    });\n\n// 输出版本号\nprogram.command('version')\n    .description('输出版本号')\n    .action(() => {\n        // 全局option -V, --version 已被注册，这里无需再注册version命令，只是为了演示\n        consola.info(figlet.textSync(`version ==> ${program.version()}`, textConfig));\n    });\n\nprogram.parse();","import type { FigletOptions } from \"figlet\";\n\nexport default {\n    font: \"Ghost\",\n    horizontalLayout: \"default\",\n    verticalLayout: \"default\",\n    width: 200,\n    whitespaceBreak: true,\n} as FigletOptions","\n\nexport default {\n    templates: [\n        { title: 'React + Nest', value: 'react-nest', description: '这个模板包含了 React + Nest 项目的基本配置', disabled: false },\n        { title: 'React + Nest + TypeScript', value: 'react-nest-ts', description: '这个模板包含了 React + Nest + TypeScript 项目的基本配置', disabled: false },\n    ]\n}"],"mappings":";AAAA,SAAS,eAAe;AACxB,OAAO,gBAAgB;AACvB,OAAO,YAAY;AACnB,OAAO,aAAa;AACpB,OAAO,aAAa;AACpB,OAAO,SAAS;AAChB,SAAS,wBAAwB;AACjC,OAAO,UAAU;AACjB,OAAO,aAAa;;;ACNpB,IAAO,sBAAQ;AAAA,EACX,MAAM;AAAA,EACN,kBAAkB;AAAA,EAClB,gBAAgB;AAAA,EAChB,OAAO;AAAA,EACP,iBAAiB;AACrB;;;ACNA,IAAO,yBAAQ;AAAA,EACX,WAAW;AAAA,IACP,EAAE,OAAO,gBAAgB,OAAO,cAAc,aAAa,sGAAgC,UAAU,MAAM;AAAA,IAC3G,EAAE,OAAO,6BAA6B,OAAO,iBAAiB,aAAa,mHAA6C,UAAU,MAAM;AAAA,EAC5I;AACJ;;;AFOA,IAAM,UAAU,MAAM;AAClB,UAAQ,KAAK,WAAW,OAAO,OAAO,SAAS,kBAAkB,mBAAU,CAAC,CAAC;AAC7E,UAAQ,MAAM,WAAW,OAAO,QAAQ,YAAY,CAAC,CAAC;AACtD,UAAQ,KAAK,WAAW,OAAO,QAAQ,QAAQ,CAAC,CAAC;AACrD;AAGA,QACK,QAAQ,SAAS,iBAAiB,gCAAO,EACzC,WAAW,cAAc,sCAAQ,EAEjC,YAAY,8GAA8B,EAC1C,OAAO,OAAO;AAGnB,QACK,QAAQ,MAAM,EACd,YAAY,sCAAQ,EACpB,OAAO,OAAO;AAGnB,QACK,QAAQ,MAAM,EACd,YAAY,gCAAO,EACnB,SAAS,kBAAkB,0BAAM,EACjC,OAAO,8BAA8B,sCAAQ,EAC7C,OAAO,OAAO,aAAa,SAAS;AACjC,MAAI,EAAE,SAAS,IAAI,QAAQ,CAAC;AAE5B,MAAI,CAAC,aAAa;AACd,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC3B,MAAM;AAAA,MACN,SAAS;AAAA;AAAA,MACT,MAAM;AAAA,MACN,SAAS;AAAA;AAAA,IAEb,CAAC;AACD,kBAAc,SAAS;AAAA,EAC3B;AAGA,QAAM,aAAc,YAAY,CAAC,uBAAc,UAAU,KAAK,UAAQ,KAAK,UAAU,QAAQ;AAC7F,MAAI,CAAC,YAAY,YAAY;AACzB,QAAI,YAAY;AACZ,cAAQ,MAAM,4BAAQ,QAAQ,iEAAe;AAAA,IACjD;AACA,UAAM,WAAW,MAAM,QAAQ;AAAA,MAC3B,MAAM;AAAA,MACN,MAAM;AAAA,MACN,SAAS;AAAA,MACT,SAAS,uBAAc;AAAA,MACvB,SAAS;AAAA;AAAA,IACb,CAAC;AACD,eAAW,SAAS;AAAA,EACxB;AAEA,QAAM,MAAM,kCAAS,WAAW,sBAAO,QAAQ;AAC/C,QAAM,UAAU,IAAI;AAAA,IAChB,MAAM;AAAA,IACN,OAAO;AAAA;AAAA;AAAA,EAGX,CAAC;AACD,UAAQ,MAAM;AAEd,QAAM,aAAa,KAAK,QAAQ,YAAY,SAAS,WAAW;AAChE,MAAI,QAAQ,WAAW,UAAU,GAAG;AAChC,YAAQ,KAAK,qEAAiB,WAAW,qBAAM;AAC/C;AAAA,EACJ;AAEA,QAAM,MAAM,MAAM,iBAAiB,wDAAwD,QAAQ,SAAS;AAAA,IACxG,KAAK;AAAA,EACT,CAAC;AACD,QAAM,EAAE,IAAI,IAAI;AAChB,UAAQ,QAAQ,iFAAgB,GAAG,EAAE;AAGzC,CAAC;AAGL,QAAQ,QAAQ,SAAS,EACpB,YAAY,gCAAO,EACnB,OAAO,MAAM;AAEV,UAAQ,KAAK,OAAO,SAAS,eAAe,QAAQ,QAAQ,CAAC,IAAI,mBAAU,CAAC;AAChF,CAAC;AAEL,QAAQ,MAAM;","names":[]}

package/package.json

@@ -0,0 +1,39 @@
+{
+  "name": "react-nest-cli",
+  "version": "1.0.0",
+  "description": "一个脚手架工具，用于快速生成 react+nest 项目",
+  "type": "module",
+  "bin": {
+    "react-nest": "./dist/index.js"
+  },
+  "main": "./dist/index.js",
+  "scripts": {
+    "build": "tsup",
+    "start": "ts-node ./packages/cli/src/index.ts"
+  },
+  "keywords": [
+    "react",
+    "nest",
+    "脚手架"
+  ],
+  "author": "liaolonghui",
+  "license": "ISC",
+  "dependencies": {
+    "commander": "^14.0.3",
+    "consola": "^3.4.2",
+    "figlet": "^1.10.0",
+    "fs-extra": "^11.3.3",
+    "giget": "^3.1.2",
+    "ora": "^9.3.0",
+    "picocolors": "^1.1.1",
+    "prompts": "^2.4.2",
+    "tsup": "^8.5.1"
+  },
+  "devDependencies": {
+    "@types/fs-extra": "^11.0.4",
+    "@types/node": "^25.2.1",
+    "@types/prompts": "^2.4.9",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.9.3"
+  }
+}

package/packages/cli/src/configs/prompts.config.ts

@@ -0,0 +1,8 @@
+
+
+export default {
+    templates: [
+        { title: 'React + Nest', value: 'react-nest', description: '这个模板包含了 React + Nest 项目的基本配置', disabled: false },
+        { title: 'React + Nest + TypeScript', value: 'react-nest-ts', description: '这个模板包含了 React + Nest + TypeScript 项目的基本配置', disabled: false },
+    ]
+}

package/packages/cli/src/configs/text.config.ts

@@ -0,0 +1,9 @@
+import type { FigletOptions } from "figlet";
+
+export default {
+    font: "Ghost",
+    horizontalLayout: "default",
+    verticalLayout: "default",
+    width: 200,
+    whitespaceBreak: true,
+} as FigletOptions

package/packages/cli/src/index.ts

@@ -0,0 +1,103 @@
+import { program } from "commander";
+import picocolors from "picocolors"; // 也可用chalk
+import figlet from 'figlet';
+import prompts from 'prompts'; // 也可用inquirer、手动readline等
+import consola from "consola";
+import ora from 'ora';
+import { downloadTemplate } from 'giget';
+import path from 'node:path';
+import fsExtra from 'fs-extra';
+import textConfig from './configs/text.config.ts';
+import promptsConfig from "./configs/prompts.config.ts";
+
+
+// 输出项目信息
+const logInfo = () => {
+    console.info(picocolors.yellow(figlet.textSync('React Nest CLI', textConfig)))
+    consola.start(picocolors.yellow(program.description()))
+    consola.info(picocolors.yellow(program.version()))
+}
+
+
+program
+    .version("1.0.0", '-V, --version', '输出版本号')
+    .helpOption('-h, --help', '输出帮助信息')
+    // .help((str) => '帮助信息：\n' + str)
+    .description("一个脚手架工具，用于快速生成 React+Nest 项目")
+    .action(logInfo);
+
+// 输出项目信息
+program
+    .command('info')
+    .description('输出项目信息')
+    .action(logInfo);
+
+// 初始化项目
+program
+    .command('init')
+    .description('初始化项目')
+    .argument('[project-name]', '项目名称')
+    .option('--template <template-name>', '项目模板名称')
+    .action(async (projectName, rest) => {
+        let { template } = rest || {};
+        // 如果projectName没有提供，让用户输入
+        if (!projectName) {
+            const response = await prompts({
+                type: 'text',
+                initial: 'my-project', // 默认值
+                name: 'projectName',
+                message: '请输入项目名称',
+                // validate: value => value.length ? true : '请输入项目名称'
+            });
+            projectName = response.projectName;
+        }
+
+        // 如果template没有提供或者template不存在，让用户选择
+        const noTemplate = (template && !promptsConfig.templates.find(item => item.value === template));
+        if (!template || noTemplate) {
+            if (noTemplate) {
+                consola.error(`项目模板 ${template} 不存在, 请选择其他模板`);
+            }
+            const response = await prompts({
+                type: 'select',
+                name: 'template',
+                message: '请选择项目模板',
+                choices: promptsConfig.templates,
+                initial: 0, // 默认选择第一个
+            });
+            template = response.template;
+        }
+
+        const tip = `初始化项目 ${projectName}，模板 ${template}`;
+        const spinner = ora({
+            text: tip,
+            color: 'blue',
+            // spinner: 'growVertical',
+            // isEnabled: false
+        });
+        spinner.start();
+
+        const projectDir = path.resolve(import.meta.dirname, projectName);
+        if (fsExtra.existsSync(projectDir)) {
+            spinner.fail(`💥初始化失败: 项目目录 ${projectName} 已存在`);
+            return;
+        }
+
+        const res = await downloadTemplate(`github:liaolonghui/react-nest-cli/packages/templates/${template}#main`, {
+            dir: projectDir,
+        });
+        const { dir } = res;
+        spinner.succeed(`项目初始化成功，项目目录：${dir}`);
+        // console.log(res);
+
+    });
+
+// 输出版本号
+program.command('version')
+    .description('输出版本号')
+    .action(() => {
+        // 全局option -V, --version 已被注册，这里无需再注册version命令，只是为了演示
+        consola.info(figlet.textSync(`version ==> ${program.version()}`, textConfig));
+    });
+
+program.parse();

package/packages/templates/react-nest/package.json

@@ -0,0 +1,20 @@
+{
+  "name": "react-nest",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/liaolonghui/react-nest-cli.git"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "bugs": {
+    "url": "https://github.com/liaolonghui/react-nest-cli/issues"
+  },
+  "homepage": "https://github.com/liaolonghui/react-nest-cli#readme"
+}

package/packages/templates/react-nest-ts/package.json

@@ -0,0 +1,12 @@
+{
+  "name": "react-nest-ts",
+  "version": "1.0.0",
+  "description": "",
+  "main": "index.js",
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC"
+}

package/pnpm-workspace.yaml

@@ -0,0 +1,3 @@
+packages:
+  - 'src/packages/**'
+  - 'src/app/**'

package/tsconfig.json

@@ -0,0 +1,47 @@
+{
+  // Visit https://aka.ms/tsconfig to read more about this file
+  "compilerOptions": {
+    // File Layout
+    // "rootDir": "./src",
+    // "outDir": "./dist",
+
+    // Environment Settings
+    // See also https://aka.ms/tsconfig/module
+    "module": "nodenext",
+    "target": "esnext",
+    // For nodejs:
+    "lib": ["esnext"],
+    "types": ["node"],
+    // and npm install -D @types/node
+
+    "emitDeclarationOnly": true,
+    "allowImportingTsExtensions": true,
+
+
+    // Other Outputs
+    "sourceMap": true,
+    "declaration": true,
+    "declarationMap": true,
+
+    // Stricter Typechecking Options
+    "noUncheckedIndexedAccess": true,
+    "exactOptionalPropertyTypes": true,
+
+    // Style Options
+    // "noImplicitReturns": true,
+    // "noImplicitOverride": true,
+    // "noUnusedLocals": true,
+    // "noUnusedParameters": true,
+    // "noFallthroughCasesInSwitch": true,
+    // "noPropertyAccessFromIndexSignature": true,
+
+    // Recommended Options
+    "strict": true,
+    "jsx": "react-jsx",
+    "verbatimModuleSyntax": true,
+    "isolatedModules": true,
+    "noUncheckedSideEffectImports": true,
+    "moduleDetection": "force",
+    "skipLibCheck": true,
+  }
+}

package/tsup.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "tsup";
+
+
+export default defineConfig({
+    entry: ['packages/cli/src/index.ts'],
+    format: ['esm'],
+    dts: true,
+    sourcemap: true,
+    clean: true,
+})