neat-admin-cli 1.0.0

package/README.md

@@ -0,0 +1,67 @@
+# ndc
+
+A CLI tool to scaffold an Ant Design admin project from the [ant-admin-template](https://github.com/leonwgc/ant-admin-template) GitHub template.
+
+[中文文档](./README.zh-CN.md)
+
+## Installation
+
+```bash
+npm install -g ndc
+```
+
+Or use it directly via `npx`:
+
+```bash
+npx ndc init --dir my-admin-project
+```
+
+## Usage
+
+```bash
+ndc init --dir <directory>
+```
+
+### Options
+
+| Option | Description |
+|--------|-------------|
+| `--dir <directory>` | Target directory name or path for the new project (required) |
+| `-V, --version` | Output the version number |
+| `-h, --help` | Display help information |
+
+### Example
+
+```bash
+# Create a project in the current directory
+ndc init --dir my-admin-project
+
+# Create a project at an absolute path
+ndc init --dir /path/to/my-admin-project
+```
+
+After initialization, the tool will:
+
+1. Clone the template with `git clone --depth 1`
+2. Re-initialize a clean git repository
+3. Install dependencies with `npm install`
+
+Then start the development server:
+
+```bash
+cd my-admin-project
+npm run dev
+```
+
+## Template
+
+The project template is based on [ant-admin-template](https://github.com/leonwgc/ant-admin-template), which includes:
+
+- React + TypeScript
+- Ant Design component library
+- gdn-pack build tool
+- Routing & layout setup
+
+## License
+
+MIT

package/README.zh-CN.md

@@ -0,0 +1,67 @@
+# ndc
+
+一个基于 Node.js 的 CLI 工具，用于从 [ant-admin-template](https://github.com/leonwgc/ant-admin-template) 模板快速初始化 Ant Design 后台管理项目。
+
+[English](./README.md)
+
+## 安装
+
+```bash
+npm install -g ndc
+```
+
+或通过 `npx` 直接使用（无需全局安装）：
+
+```bash
+npx ndc init --dir my-admin-project
+```
+
+## 使用方法
+
+```bash
+ndc init --dir <目录>
+```
+
+### 参数说明
+
+| 参数 | 说明 |
+|------|------|
+| `--dir <目录>` | 新项目的目标目录名称或路径（必填） |
+| `-V, --version` | 输出版本号 |
+| `-h, --help` | 显示帮助信息 |
+
+### 示例
+
+```bash
+# 在当前目录下创建项目
+ndc init --dir my-admin-project
+
+# 指定绝对路径创建项目
+ndc init --dir /path/to/my-admin-project
+```
+
+初始化完成后，工具会依次执行：
+
+1. 使用 `git clone --depth 1` 克隆模板仓库
+2. 删除原始 `.git`，重新初始化为全新 git 仓库
+3. 使用 `npm install` 自动安装依赖
+
+然后启动开发服务器：
+
+```bash
+cd my-admin-project
+npm run dev
+```
+
+## 模板介绍
+
+项目模板基于 [ant-admin-template](https://github.com/leonwgc/ant-admin-template)，包含以下技术栈：
+
+- React + TypeScript
+- Ant Design 组件库
+- gdn-pack 构建工具
+- 路由与布局结构
+
+## License
+
+MIT

package/dist/index.d.ts

@@ -0,0 +1,2 @@
+#!/usr/bin/env node
+export {};

package/dist/index.js

@@ -0,0 +1,149 @@
+#!/usr/bin/env node
+"use strict";
+var __createBinding = (this && this.__createBinding) || (Object.create ? (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    var desc = Object.getOwnPropertyDescriptor(m, k);
+    if (!desc || ("get" in desc ? !m.__esModule : desc.writable || desc.configurable)) {
+      desc = { enumerable: true, get: function() { return m[k]; } };
+    }
+    Object.defineProperty(o, k2, desc);
+}) : (function(o, m, k, k2) {
+    if (k2 === undefined) k2 = k;
+    o[k2] = m[k];
+}));
+var __setModuleDefault = (this && this.__setModuleDefault) || (Object.create ? (function(o, v) {
+    Object.defineProperty(o, "default", { enumerable: true, value: v });
+}) : function(o, v) {
+    o["default"] = v;
+});
+var __importStar = (this && this.__importStar) || (function () {
+    var ownKeys = function(o) {
+        ownKeys = Object.getOwnPropertyNames || function (o) {
+            var ar = [];
+            for (var k in o) if (Object.prototype.hasOwnProperty.call(o, k)) ar[ar.length] = k;
+            return ar;
+        };
+        return ownKeys(o);
+    };
+    return function (mod) {
+        if (mod && mod.__esModule) return mod;
+        var result = {};
+        if (mod != null) for (var k = ownKeys(mod), i = 0; i < k.length; i++) if (k[i] !== "default") __createBinding(result, mod, k[i]);
+        __setModuleDefault(result, mod);
+        return result;
+    };
+})();
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const commander_1 = require("commander");
+const child_process_1 = require("child_process");
+const path = __importStar(require("path"));
+const fs = __importStar(require("fs"));
+const chalk_1 = __importDefault(require("chalk"));
+const TEMPLATE_URL = 'https://github.com/leonwgc/neat-admin-template.git';
+function run(command, cwd) {
+    return new Promise((resolve, reject) => {
+        const [cmd, ...args] = command.split(' ');
+        const child = (0, child_process_1.spawn)(cmd, args, {
+            cwd,
+            stdio: 'inherit',
+            shell: process.platform === 'win32',
+        });
+        child.on('close', (code) => {
+            if (code === 0) {
+                resolve();
+            }
+            else {
+                reject(new Error(chalk_1.default.red(`Command failed: ${command} (exit code: ${code})`)));
+            }
+        });
+        child.on('error', (err) => {
+            reject(new Error(chalk_1.default.red(`Failed to start command: ${command}\n${err.message}`)));
+        });
+    });
+}
+async function init(dir) {
+    const targetDir = path.resolve(process.cwd(), dir);
+    if (fs.existsSync(targetDir)) {
+        console.error(chalk_1.default.red(`Error: Directory already exists: ${targetDir}`));
+        process.exit(1);
+    }
+    const parentDir = path.dirname(targetDir);
+    const projectName = path.basename(targetDir);
+    if (!fs.existsSync(parentDir)) {
+        fs.mkdirSync(parentDir, { recursive: true });
+    }
+    console.log(chalk_1.default.cyan(`\nCloning codes into ${chalk_1.default.bold(targetDir)} ...\n`));
+    try {
+        await run(`git clone --depth 1 ${TEMPLATE_URL} ${projectName}`, parentDir);
+    }
+    catch (err) {
+        console.error(chalk_1.default.red('Clone failed:'), err.message);
+        process.exit(1);
+    }
+    // Remove .git and re-initialize
+    const gitDir = path.join(targetDir, '.git');
+    if (fs.existsSync(gitDir)) {
+        fs.rmSync(gitDir, { recursive: true, force: true });
+    }
+    await run('git init', targetDir);
+    // Remove docs directory if present
+    const docsDir = path.join(targetDir, 'docs');
+    if (fs.existsSync(docsDir)) {
+        fs.rmSync(docsDir, { recursive: true, force: true });
+        console.log(chalk_1.default.gray('Removed docs directory.'));
+    }
+    // Update package.json name and description
+    const pkgPath = path.join(targetDir, 'package.json');
+    if (fs.existsSync(pkgPath)) {
+        const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+        pkg.name = projectName;
+        pkg.description = projectName;
+        fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf-8');
+    }
+    // Replace HashRouter with BrowserRouter in index.tsx
+    const indexTsxPath = path.join(targetDir, 'src', 'index.tsx');
+    if (fs.existsSync(indexTsxPath)) {
+        let content = fs.readFileSync(indexTsxPath, 'utf-8');
+        if (content.includes('HashRouter')) {
+            content = content.replace(/HashRouter/g, 'BrowserRouter');
+            fs.writeFileSync(indexTsxPath, content, 'utf-8');
+        }
+    }
+    const pm = 'npm';
+    console.log(chalk_1.default.cyan(`\nInstalling dependencies...\n`));
+    try {
+        await run(`${pm} install`, targetDir);
+    }
+    catch (err) {
+        console.error(chalk_1.default.red('Install failed:'), err.message);
+        process.exit(1);
+    }
+    console.log(chalk_1.default.green(`\n✅ Project initialized successfully!\n`));
+    console.log(chalk_1.default.cyan(`\nStarting development server...\n`));
+    try {
+        await run(`${pm} start`, targetDir);
+    }
+    catch (err) {
+        console.error(chalk_1.default.red('Start failed:'), err.message);
+        process.exit(1);
+    }
+}
+const program = new commander_1.Command();
+program
+    .name('ndc')
+    .description('Scaffold a neat design admin project from template')
+    .version('1.0.0');
+program
+    .command('init')
+    .description('Initialize a new project')
+    .requiredOption('--dir <directory>', 'Target directory name or path for the new project')
+    .action((options) => {
+    init(options.dir).catch((err) => {
+        console.error(err.message);
+        process.exit(1);
+    });
+});
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,31 @@
+{
+  "name": "neat-admin-cli",
+  "version": "1.0.0",
+  "description": "CLI tool to initialize ant-admin project from template",
+  "main": "dist/index.js",
+  "bin": {
+    "neat-admin-cli": "./dist/index.js"
+  },
+  "scripts": {
+    "build": "tsc",
+    "dev": "ts-node src/index.ts",
+    "prepublishOnly": "npm run build"
+  },
+  "keywords": [
+    "cli",
+    "ant-admin",
+    "template"
+  ],
+  "author": "leonwgc",
+  "license": "MIT",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^12.0.0"
+  },
+  "devDependencies": {
+    "@types/chalk": "^0.4.31",
+    "@types/node": "^20.0.0",
+    "ts-node": "^10.9.2",
+    "typescript": "^5.4.0"
+  }
+}

package/src/index.ts

@@ -0,0 +1,130 @@
+#!/usr/bin/env node
+
+import { Command } from 'commander';
+import { spawn } from 'child_process';
+import * as path from 'path';
+import * as fs from 'fs';
+import chalk from 'chalk';
+
+const TEMPLATE_URL = 'https://github.com/leonwgc/neat-admin-template.git';
+
+function run(command: string, cwd: string): Promise<void> {
+  return new Promise((resolve, reject) => {
+    const [cmd, ...args] = command.split(' ');
+    const child = spawn(cmd, args, {
+      cwd,
+      stdio: 'inherit',
+      shell: process.platform === 'win32',
+    });
+
+    child.on('close', (code) => {
+      if (code === 0) {
+        resolve();
+      } else {
+        reject(new Error(chalk.red(`Command failed: ${command} (exit code: ${code})`)));
+      }
+    });
+
+    child.on('error', (err) => {
+      reject(new Error(chalk.red(`Failed to start command: ${command}\n${err.message}`)));
+    });
+  });
+}
+
+async function init(dir: string): Promise<void> {
+  const targetDir = path.resolve(process.cwd(), dir);
+
+  if (fs.existsSync(targetDir)) {
+    console.error(chalk.red(`Error: Directory already exists: ${targetDir}`));
+    process.exit(1);
+  }
+
+  const parentDir = path.dirname(targetDir);
+  const projectName = path.basename(targetDir);
+
+  if (!fs.existsSync(parentDir)) {
+    fs.mkdirSync(parentDir, { recursive: true });
+  }
+
+  console.log(chalk.cyan(`\nCloning codes into ${chalk.bold(targetDir)} ...\n`));
+  try {
+    await run(
+      `git clone --depth 1 ${TEMPLATE_URL} ${projectName}`,
+      parentDir
+    );
+  } catch (err) {
+    console.error(chalk.red('Clone failed:'), (err as Error).message);
+    process.exit(1);
+  }
+
+  // Remove .git and re-initialize
+  const gitDir = path.join(targetDir, '.git');
+  if (fs.existsSync(gitDir)) {
+    fs.rmSync(gitDir, { recursive: true, force: true });
+  }
+  await run('git init', targetDir);
+
+  // Remove docs directory if present
+  const docsDir = path.join(targetDir, 'docs');
+  if (fs.existsSync(docsDir)) {
+    fs.rmSync(docsDir, { recursive: true, force: true });
+    console.log(chalk.gray('Removed docs directory.'));
+  }
+
+  // Update package.json name and description
+  const pkgPath = path.join(targetDir, 'package.json');
+  if (fs.existsSync(pkgPath)) {
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    pkg.name = projectName;
+    pkg.description = projectName;
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n', 'utf-8');
+  }
+
+  // Replace HashRouter with BrowserRouter in index.tsx
+  const indexTsxPath = path.join(targetDir, 'src', 'index.tsx');
+  if (fs.existsSync(indexTsxPath)) {
+    let content = fs.readFileSync(indexTsxPath, 'utf-8');
+    if (content.includes('HashRouter')) {
+      content = content.replace(/HashRouter/g, 'BrowserRouter');
+      fs.writeFileSync(indexTsxPath, content, 'utf-8');
+    }
+  }
+
+  const pm = 'npm';
+  console.log(chalk.cyan(`\nInstalling dependencies...\n`));
+  try {
+    await run(`${pm} install`, targetDir);
+  } catch (err) {
+    console.error(chalk.red('Install failed:'), (err as Error).message);
+    process.exit(1);
+  }
+
+  console.log(chalk.green(`\n✅ Project initialized successfully!\n`));
+  console.log(chalk.cyan(`\nStarting development server...\n`));
+  try {
+    await run(`${pm} start`, targetDir);
+  } catch (err) {
+    console.error(chalk.red('Start failed:'), (err as Error).message);
+    process.exit(1);
+  }
+}
+
+const program = new Command();
+
+program
+  .name('ndc')
+  .description('Scaffold a neat design admin project from template')
+  .version('1.0.0');
+
+program
+  .command('init')
+  .description('Initialize a new project')
+  .requiredOption('--dir <directory>', 'Target directory name or path for the new project')
+  .action((options) => {
+    init(options.dir).catch((err) => {
+      console.error(err.message);
+      process.exit(1);
+    });
+  });
+
+program.parse(process.argv);

package/tsconfig.json

@@ -0,0 +1,16 @@
+{
+  "compilerOptions": {
+    "target": "ES2018",
+    "module": "commonjs",
+    "lib": ["ES2018"],
+    "outDir": "./dist",
+    "rootDir": "./src",
+    "strict": true,
+    "esModuleInterop": true,
+    "skipLibCheck": true,
+    "declaration": true,
+    "resolveJsonModule": true
+  },
+  "include": ["src/**/*"],
+  "exclude": ["node_modules", "dist"]
+}