gridsum-vue3-pc 1.1.1 → 1.2.1

package/bin/create-vue3-pc.mjs

@@ -15,6 +15,8 @@ const { version: CLI_VERSION } = JSON.parse(
 
 const MIN_NODE_VERSION = 18;
 const DEFAULT_NAME = 'vue3-project';
+const VALID_CICD = ['none', 'github', 'gitlab', 'jenkins'];
+const DIR_NAME_RE = /^[a-zA-Z0-9-_]+$/;
 
 const TEMPLATES = {
   base: path.join(__dirname, '../template/base'),
@@ -26,10 +28,6 @@ const TEMPLATES = {
   }
 };
 
-const VALID_CICD = ['none', 'github', 'gitlab', 'jenkins'];
-
-const DIR_NAME_RE = /^[a-zA-Z0-9-_]+$/;
-
 const helpMessage = `
 ${pc.bold(pc.cyan('gridsum-vue3-pc'))} ${pc.dim(`v${CLI_VERSION}`)}
 
@@ -43,6 +41,7 @@ ${pc.bold('Options:')}
   -c, --cicd <type>         CI/CD type ${pc.dim('(github, gitlab, jenkins, none)')}
   -f, --force               Force overwrite if directory exists
   --auto-start              Auto start dev server after creation
+  --no-git                  Skip git initialization
   --no-auto-install         Skip automatic dependency installation
   --no-interactive          Run in non-interactive mode
   -h, --help                Display this message
@@ -60,8 +59,8 @@ ${pc.bold('Examples:')}
 `;
 
 function formatTargetDir(input) {
-  const dir = input.trim().replace(/[\/\\]+$/g, '');
-  if (!dir || /[<>:"|?*\x00-\x1f]/.test(dir) || dir.includes('..') || dir.includes('/') || dir.includes('\\')) {
+  const dir = input.trim().replace(/[/\\]+$/g, '');
+  if (!dir || /[<>:"|?*\\/]/.test(dir) || dir.includes('..') || [...dir].some(c => c < ' ')) {
     return '';
   }
   return dir;
@@ -72,12 +71,7 @@ function isValidPackageName(name) {
 }
 
 function toValidPackageName(name) {
-  return name
-    .trim()
-    .toLowerCase()
-    .replace(/\s+/g, '-')
-    .replace(/^[._]/, '')
-    .replace(/[^a-z\d\-~]+/g, '-');
+  return name.trim().toLowerCase().replace(/\s+/g, '-').replace(/^[._]/, '').replace(/[^a-z\d\-~]+/g, '-');
 }
 
 function isEmpty(dir) {
@@ -91,21 +85,17 @@ function emptyDir(dir) {
   for (const file of fs.readdirSync(dir)) {
     if (file === '.git') continue;
     const target = path.resolve(dir, file);
-    const namespaced = target.length > 260 ? path.toNamespacedPath(target) : target;
-    fs.rmSync(namespaced, { recursive: true, force: true });
+    fs.rmSync(target.length > 260 ? path.toNamespacedPath(target) : target, { recursive: true, force: true });
   }
 }
 
 function copyDir(srcDir, destDir) {
-  if (!fs.existsSync(srcDir)) {
-    throw new Error(`Template directory not found: ${srcDir}`);
-  }
+  if (!fs.existsSync(srcDir)) throw new Error(`Template directory not found: ${srcDir}`);
   fs.mkdirSync(destDir, { recursive: true });
   for (const file of fs.readdirSync(srcDir)) {
     const srcFile = path.resolve(srcDir, file);
     const destFile = path.resolve(destDir, file);
-    const stat = fs.statSync(srcFile);
-    if (stat.isDirectory()) {
+    if (fs.statSync(srcFile).isDirectory()) {
       copyDir(srcFile, destFile);
     } else {
       fs.copyFileSync(srcFile, destFile);
@@ -128,30 +118,16 @@ function getInstallCommand(pkgManager) {
 }
 
 function getRunCommand(pkgManager, script) {
-  switch (pkgManager) {
-    case 'yarn':
-    case 'pnpm':
-    case 'bun':
-      return [pkgManager, script];
-    default:
-      return [pkgManager, 'run', script];
-  }
+  return ['yarn', 'pnpm', 'bun'].includes(pkgManager)
+    ? [pkgManager, script]
+    : [pkgManager, 'run', script];
 }
 
 function runCommand(command, options = {}) {
   const [cmd, ...args] = command;
-  const result = spawn.sync(cmd, args, {
-    ...options,
-    stdio: 'inherit',
-  });
-
-  if (result.error) {
-    throw new Error(`Failed to execute "${cmd}": ${result.error.message}`);
-  }
-
-  if (result.status != null && result.status > 0) {
-    throw new Error(`"${cmd}" exited with code ${result.status}`);
-  }
+  const result = spawn.sync(cmd, args, { ...options, stdio: 'inherit' });
+  if (result.error) throw new Error(`Failed to execute "${cmd}": ${result.error.message}`);
+  if (result.status != null && result.status > 0) throw new Error(`"${cmd}" exited with code ${result.status}`);
 }
 
 function checkNodeVersion() {
@@ -170,107 +146,73 @@ Please upgrade Node.js:
 
 function parseArgs() {
   const argv = mri(process.argv.slice(2), {
-    boolean: ['help', 'version', 'force', 'auto-start', 'no-interactive', 'no-auto-install'],
+    boolean: ['help', 'version', 'force', 'auto-start', 'no-interactive', 'no-auto-install', 'no-git'],
     string: ['name', 'title', 'cicd'],
-    alias: {
-      h: 'help',
-      v: 'version',
-      n: 'name',
-      t: 'title',
-      c: 'cicd',
-      f: 'force',
-    },
+    alias: { h: 'help', v: 'version', n: 'name', t: 'title', c: 'cicd', f: 'force' },
   });
-
   argv._targetDir = argv._[0];
   argv.interactive = !argv['no-interactive'];
   argv.autoInstall = argv['no-auto-install'] ? false : undefined;
-
+  argv.git = argv['no-git'] !== undefined ? !argv['no-git'] : undefined;
   return argv;
 }
 
-function scaffoldProject(root, answers, packageName) {
-  fs.mkdirSync(root, { recursive: true });
-
-  copyDir(TEMPLATES.base, root);
-  copyDir(TEMPLATES.ts, root);
-
-  if (answers.cicd !== 'none') {
-    const cicdDir = TEMPLATES.cicd[answers.cicd];
-    if (!cicdDir || !fs.existsSync(cicdDir)) {
-      throw new Error(`CI/CD template "${answers.cicd}" not found at expected path: ${cicdDir}`);
-    }
-    copyDir(cicdDir, root);
-  }
+function validateOptions(options) {
+  const errors = [];
+  if (options.name && !DIR_NAME_RE.test(options.name))
+    errors.push('Project name must contain only letters, numbers, dash and underscore');
+  if (options.cicd && !VALID_CICD.includes(options.cicd))
+    errors.push(`Invalid CI/CD type "${options.cicd}". Valid: ${VALID_CICD.join(', ')}`);
+  if (options.title && !/^[a-zA-Z0-9_\-\u4e00-\u9fa5 ]+$/.test(options.title))
+    errors.push('Project title contains invalid characters');
+  return errors;
+}
 
+function updateProjectFiles(root, answers, packageName) {
   const pkgPath = path.join(root, 'package.json');
   if (fs.existsSync(pkgPath)) {
-    try {
-      const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
-      pkg.name = packageName;
-      fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
-    } catch (e) {
-      throw new Error(`Failed to update package.json: ${e.message}`);
-    }
+    const pkg = JSON.parse(fs.readFileSync(pkgPath, 'utf-8'));
+    pkg.name = packageName;
+    fs.writeFileSync(pkgPath, JSON.stringify(pkg, null, 2) + '\n');
   }
 
   for (const file of ['.env', '.env.production']) {
     const filePath = path.join(root, file);
     if (fs.existsSync(filePath)) {
-      try {
-        let content = fs.readFileSync(filePath, 'utf-8');
-        content = content.replace(/^VITE_APP_TITLE=.*$/m, `VITE_APP_TITLE=${answers.title}`);
-        fs.writeFileSync(filePath, content);
-      } catch (e) {
-        throw new Error(`Failed to update ${file}: ${e.message}`);
-      }
+      let content = fs.readFileSync(filePath, 'utf-8');
+      content = content.replace(/^VITE_APP_TITLE=.*$/m, `VITE_APP_TITLE=${answers.title}`);
+      fs.writeFileSync(filePath, content);
     }
   }
 
   const indexPath = path.join(root, 'index.html');
   if (fs.existsSync(indexPath)) {
-    try {
-      let content = fs.readFileSync(indexPath, 'utf-8');
-      content = content.replace(/<title>[^<]*<\/title>/, `<title>${answers.title}</title>`);
-      fs.writeFileSync(indexPath, content);
-    } catch (e) {
-      throw new Error(`Failed to update index.html: ${e.message}`);
-    }
+    let content = fs.readFileSync(indexPath, 'utf-8');
+    content = content.replace(/<title>[^<]*<\/title>/, `<title>${answers.title}</title>`);
+    fs.writeFileSync(indexPath, content);
   }
 }
 
-function validateOptions(options) {
-  const errors = [];
-
-  if (options.name && !DIR_NAME_RE.test(options.name)) {
-    errors.push('Project name must contain only letters, numbers, dash and underscore');
-  }
-
-  if (options.cicd && !VALID_CICD.includes(options.cicd)) {
-    errors.push(`Invalid CI/CD type "${options.cicd}". Valid: ${VALID_CICD.join(', ')}`);
-  }
-
-  if (options.title && !/^[a-zA-Z0-9_\-\u4e00-\u9fa5 ]+$/.test(options.title)) {
-    errors.push('Project title contains invalid characters (allowed: letters, numbers, Chinese, spaces, dash, underscore)');
+function initGit(root) {
+  try {
+    runCommand(['git', 'init', '--initial-branch=main'], { cwd: root, stdio: 'pipe' });
+    const gitignore = path.join(root, '.gitignore');
+    if (fs.existsSync(gitignore)) {
+      runCommand(['git', 'add', '.'], { cwd: root, stdio: 'pipe' });
+      runCommand(['git', 'commit', '-m', 'Initial project scaffold'], { cwd: root, stdio: 'pipe' });
+    }
+    return true;
+  } catch {
+    return false;
   }
-
-  return errors;
 }
 
 async function main() {
   checkNodeVersion();
-
   const argv = parseArgs();
 
-  if (argv.help) {
-    console.log(helpMessage);
-    process.exit(0);
-  }
-
-  if (argv.version) {
-    console.log(`v${CLI_VERSION}`);
-    process.exit(0);
-  }
+  if (argv.help) { console.log(helpMessage); process.exit(0); }
+  if (argv.version) { console.log(`v${CLI_VERSION}`); process.exit(0); }
 
   const validationErrors = validateOptions(argv);
   if (validationErrors.length > 0) {
@@ -283,13 +225,9 @@ async function main() {
   const isInteractive = argv.interactive && process.stdin.isTTY;
   const pkgManager = detectPackageManager();
 
-  const cancel = (exitCode = 0) => {
-    prompts.cancel('Operation cancelled');
-    process.exit(exitCode);
-  };
+  const cancel = (exitCode = 0) => { prompts.cancel('Operation cancelled'); process.exit(exitCode); };
 
   let targetDir = argv._targetDir ? formatTargetDir(argv._targetDir) : undefined;
-
   if (targetDir === '') {
     console.error(`\n${pc.red('Error:')} Invalid directory name "${argv._targetDir}"\n`);
     process.exit(1);
@@ -303,12 +241,8 @@ async function main() {
         placeholder: DEFAULT_NAME,
         validate: (value) => {
           const dir = formatTargetDir(value);
-          if (!dir || dir.length === 0) {
-            return 'Project name cannot be empty';
-          }
-          if (!DIR_NAME_RE.test(dir)) {
-            return 'Only letters, numbers, dash and underscore allowed';
-          }
+          if (!dir || dir.length === 0) return 'Project name cannot be empty';
+          if (!DIR_NAME_RE.test(dir)) return 'Only letters, numbers, dash and underscore allowed';
         },
       });
       if (prompts.isCancel(result)) return cancel();
@@ -322,7 +256,6 @@ async function main() {
 
   if (fs.existsSync(root) && !isEmpty(root)) {
     let action = argv.force ? 'overwrite' : undefined;
-
     if (!action) {
       if (isInteractive) {
         const result = await prompts.select({
@@ -339,17 +272,10 @@ async function main() {
         action = 'cancel';
       }
     }
-
     switch (action) {
-      case 'overwrite':
-        emptyDir(root);
-        break;
-      case 'ignore':
-        break;
-      case 'cancel': {
-        const exitCode = argv.interactive ? 0 : 1;
-        return cancel(exitCode);
-      }
+      case 'overwrite': emptyDir(root); break;
+      case 'ignore': break;
+      case 'cancel': return cancel(argv.interactive ? 0 : 1);
     }
   }
 
@@ -360,11 +286,7 @@ async function main() {
         message: 'Package name:',
         defaultValue: toValidPackageName(packageName),
         placeholder: toValidPackageName(packageName),
-        validate: (value) => {
-          if (value && !isValidPackageName(value)) {
-            return 'Invalid package.json name (must match: @scope/name or name)';
-          }
-        },
+        validate: (value) => { if (value && !isValidPackageName(value)) return 'Invalid package.json name'; },
       });
       if (prompts.isCancel(result)) return cancel();
       packageName = result;
@@ -373,11 +295,7 @@ async function main() {
     }
   }
 
-  let answers = {
-    name: targetDir,
-    title: argv.title || 'Vue3 PC Template',
-    cicd: argv.cicd || 'none',
-  };
+  let answers = { name: targetDir, title: argv.title || 'Vue3 PC Template', cicd: argv.cicd || 'none' };
 
   if (isInteractive) {
     const title = await prompts.text({
@@ -403,32 +321,44 @@ async function main() {
   }
 
   const s = isInteractive ? prompts.spinner() : null;
-  if (s) {
-    s.start('Scaffolding project...');
-  } else {
-    prompts.log.step('Scaffolding project...');
-  }
+  if (s) { s.start('Scaffolding project...'); } else { prompts.log.step('Scaffolding project...'); }
 
   try {
-    scaffoldProject(root, answers, packageName);
+    fs.mkdirSync(root, { recursive: true });
+    copyDir(TEMPLATES.base, root);
+    copyDir(TEMPLATES.ts, root);
+
+    if (answers.cicd !== 'none') {
+      const cicdDir = TEMPLATES.cicd[answers.cicd];
+      if (!cicdDir || !fs.existsSync(cicdDir))
+        throw new Error(`CI/CD template "${answers.cicd}" not found`);
+      copyDir(cicdDir, root);
+    }
+
+    updateProjectFiles(root, answers, packageName);
   } catch (e) {
     if (s) s.stop(pc.red('Scaffolding failed'));
     console.error(`\n${pc.red('Error:')} ${e.message}\n`);
     process.exit(1);
   }
 
-  if (s) {
-    s.stop('Project created successfully!');
-  } else {
-    prompts.log.success('Project created successfully!');
+  if (s) { s.stop('Project created successfully!'); } else { prompts.log.success('Project created successfully!'); }
+
+  let doGit = argv.git;
+  if (doGit === undefined && isInteractive) {
+    const result = await prompts.confirm({ message: 'Initialize git repository?', initialValue: true });
+    if (prompts.isCancel(result)) return cancel();
+    doGit = result;
+  }
+  if (doGit) {
+    if (initGit(root)) {
+      process.stdout.write(`${pc.green('✓')} Git repository initialized\n`);
+    }
   }
 
   let autoInstall = argv.autoInstall;
   if (autoInstall === undefined && isInteractive) {
-    const result = await prompts.confirm({
-      message: `Install dependencies with ${pkgManager}?`,
-      initialValue: true,
-    });
+    const result = await prompts.confirm({ message: `Install dependencies with ${pkgManager}?`, initialValue: true });
     if (prompts.isCancel(result)) return cancel();
     autoInstall = result;
   }
@@ -438,7 +368,7 @@ async function main() {
     try {
       runCommand(getInstallCommand(pkgManager), { cwd: root });
       process.stdout.write(`${pc.green('✓')} Dependencies installed!\n`);
-    } catch (e) {
+    } catch (_) {
       process.stdout.write(`\n${pc.red('✗')} Installation failed\n`);
       console.error(`  ${pc.dim('You can retry manually:')}`);
       console.error(`  ${pc.cyan(`cd ${targetDir} && ${pkgManager} install${pkgManager === 'npm' ? ' --legacy-peer-deps' : ''}`)}\n`);
@@ -448,10 +378,7 @@ async function main() {
 
   let autoStart = argv['auto-start'];
   if (autoStart === undefined && isInteractive && autoInstall) {
-    const result = await prompts.confirm({
-      message: 'Start dev server now?',
-      initialValue: false,
-    });
+    const result = await prompts.confirm({ message: 'Start dev server now?', initialValue: false });
     if (prompts.isCancel(result)) return cancel();
     autoStart = result;
   }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "gridsum-vue3-pc",
-  "version": "1.1.1",
+  "version": "1.2.1",
   "description": "Gridsum Vue3 Vite PC Template Generator - 快速生成基于 Vue3 + Vite + TypeScript 的企业级 PC 端项目",
   "type": "module",
   "sideEffects": false,
@@ -41,7 +41,6 @@
     "type": "github",
     "url": "https://github.com/sponsors/gridsum"
   },
-
   "engines": {
     "node": ">=18.0.0"
   },
@@ -52,11 +51,12 @@
     "picocolors": "^1.1.1"
   },
   "devDependencies": {
+    "@eslint/js": "^9.0.0",
     "@types/cross-spawn": "^6.0.6",
     "eslint": "^10.5.0"
   },
   "scripts": {
-    "lint": "eslint bin/ --ext .mjs --fix",
+    "lint": "eslint bin/ --fix",
     "test": "node bin/create-vue3-pc.mjs --help",
     "test:create": "node bin/create-vue3-pc.mjs test-project --name test-project --title \"Test Project\" --no-interactive && npm --prefix test-project install --legacy-peer-deps && npm --prefix test-project run lint && npm --prefix test-project run typecheck && npm --prefix test-project run build",
     "posttest:create": "node -e \"const fs = require('fs'); if (fs.existsSync('test-project')) fs.rmSync('test-project', { recursive: true, force: true }); console.log('cleaned up test-project');\"",

package/template/base/.eslintrc.cjs

@@ -8,13 +8,15 @@ module.exports = {
   extends: [
     'eslint:recommended',
     'plugin:vue/vue3-recommended',
-    'prettier',
   ],
+  ignorePatterns: ['dist/', 'node_modules/'],
+  parser: '@typescript-eslint/parser',
   parserOptions: {
     ecmaVersion: 2021,
     sourceType: 'module',
+    extraFileExtensions: ['.vue'],
   },
-  plugins: ['vue'],
+  plugins: ['vue', '@typescript-eslint'],
   rules: {
     'vue/multi-word-component-names': 'off',
     'no-unused-vars': 'warn',

package/template/base/.stylelintrc.cjs

@@ -1,6 +1,3 @@
 module.exports = {
-  extends: [
-    'stylelint-config-standard',
-    'stylelint-config-prettier',
-  ],
+  extends: ['stylelint-config-standard'],
 };

package/template/base/Dockerfile

@@ -3,7 +3,7 @@ FROM node:20-alpine AS builder
 WORKDIR /app
 
 COPY package.json package-lock.json* ./
-RUN npm ci
+RUN npm install --legacy-peer-deps
 
 COPY . .
 RUN npm run build