nsbp-cli 0.2.27 → 0.2.30

package/README.md

@@ -147,7 +147,7 @@ node ./bin/nsbp.js --help  # Test CLI locally
 
 - **Package Name**: `nsbp-cli`
 - **Bin Command**: `nsbp` (install globally and run `nsbp --help`)
-- **Version**: `0.2.27`
+- **Version**: `0.2.30`
 - **Dependencies**: chalk, commander, fs-extra, inquirer
 - **Package Manager**: Uses pnpm (also compatible with npm)
 - **Node Version**: >=16.0.0

package/bin/nsbp.js

@@ -1,55 +1,59 @@
 #!/usr/bin/env node
 
-const { Command } = require('commander');
-const chalk = require('chalk');
-const fs = require('fs-extra');
-const path = require('path');
-const { execSync } = require('child_process');
-const inquirer = require('inquirer');
+const { Command } = require('commander')
+const chalk = require('chalk')
+const fs = require('fs-extra')
+const path = require('path')
+const { execSync } = require('child_process')
+const inquirer = require('inquirer')
 
 // Read version from package.json dynamically
-const packageJson = require('../package.json');
+const packageJson = require('../package.json')
 
-const program = new Command();
+const program = new Command()
 
 program
   .name('nsbp')
   .description('CLI tool to create NSBP (Node React SSR by Webpack) projects')
-  .version(packageJson.version);
+  .version(packageJson.version)
 
 program
   .command('create <project-name>')
   .description('Create a new NSBP project')
-  .option('-t, --template <template>', 'Specify template (basic, blog, ecommerce)', 'basic')
+  .option(
+    '-t, --template <template>',
+    'Specify template (basic, blog, ecommerce)',
+    'basic'
+  )
   .option('--skip-install', 'Skip pnpm install')
   .action(async (projectName, options) => {
-    console.log(chalk.cyan(`🚀 Creating NSBP project: ${projectName}`));
-    
+    console.log(chalk.cyan(`🚀 Creating NSBP project: ${projectName}`))
+
     try {
       // Check if directory already exists
-      const targetDir = path.join(process.cwd(), projectName);
+      const targetDir = path.join(process.cwd(), projectName)
       if (fs.existsSync(targetDir)) {
         const { overwrite } = await inquirer.prompt([
           {
             type: 'confirm',
             name: 'overwrite',
             message: `Directory "${projectName}" already exists. Overwrite?`,
-            default: false,
-          },
-        ]);
+            default: false
+          }
+        ])
         if (!overwrite) {
-          console.log(chalk.yellow('Operation cancelled.'));
-          process.exit(0);
+          console.log(chalk.yellow('Operation cancelled.'))
+          process.exit(0)
         }
-        fs.removeSync(targetDir);
+        fs.removeSync(targetDir)
       }
 
       // Create project directory
-      fs.ensureDirSync(targetDir);
+      fs.ensureDirSync(targetDir)
 
       // Get template source path from built-in templates
-      const templateSource = path.join(__dirname, '../templates/basic');
-      
+      const templateSource = path.join(__dirname, '../templates/basic')
+
       // List of files/directories to copy
       const copyItems = [
         'src',
@@ -64,115 +68,134 @@ program
         'tsconfig.json',
         '.prettierrc',
         '.prettierignore',
+        '.prettierrc.js',
+        'eslint.config.js',
+        '.husky',
         'gitignore',
         'Makefile',
         'README.md'
-      ];
+      ]
 
       // Copy each item
-      console.log(chalk.cyan('📦 Copying project files...'));
+      console.log(chalk.cyan('📦 Copying project files...'))
       for (const item of copyItems) {
-        const source = path.join(templateSource, item);
-        const target = path.join(targetDir, item);
+        const source = path.join(templateSource, item)
+        const target = path.join(targetDir, item)
         if (fs.existsSync(source)) {
           if (fs.statSync(source).isDirectory()) {
             fs.copySync(source, target, {
               filter: (src) => {
                 // Exclude node_modules, build, .temp_cache, etc.
                 // Use relative path to avoid matching parent directory names
-                const relativePath = path.relative(source, src);
-                const segments = relativePath.split(path.sep);
-                const excluded = ['node_modules', '.temp_cache', 'build', '.git', '.DS_Store', '.serena'];
-                return !segments.some(seg => excluded.includes(seg));
+                const relativePath = path.relative(source, src)
+                const segments = relativePath.split(path.sep)
+                const excluded = [
+                  'node_modules',
+                  '.temp_cache',
+                  'build',
+                  '.git',
+                  '.DS_Store',
+                  '.serena'
+                ]
+                return !segments.some((seg) => excluded.includes(seg))
               }
-            });
+            })
           } else {
-            fs.copySync(source, target);
+            fs.copySync(source, target)
           }
         }
       }
 
       // Rename gitignore to .gitignore
-      const gitignorePath = path.join(targetDir, 'gitignore');
+      const gitignorePath = path.join(targetDir, 'gitignore')
       if (fs.existsSync(gitignorePath)) {
-        fs.renameSync(gitignorePath, path.join(targetDir, '.gitignore'));
+        fs.renameSync(gitignorePath, path.join(targetDir, '.gitignore'))
       }
 
       // Create package.json for new project
-      const originalPackage = require(path.join(templateSource, 'package.json'));
+      const originalPackage = require(path.join(templateSource, 'package.json'))
       const newPackage = {
         ...originalPackage,
         name: projectName,
         version: '1.0.0',
         description: `NSBP project: ${projectName}`
-      };
+      }
 
       fs.writeFileSync(
         path.join(targetDir, 'package.json'),
         JSON.stringify(newPackage, null, 2)
-      );
+      )
 
       // Remove package-lock.json if exists (use pnpm instead)
-      const packageLockPath = path.join(targetDir, 'package-lock.json');
+      const packageLockPath = path.join(targetDir, 'package-lock.json')
       if (fs.existsSync(packageLockPath)) {
-        fs.removeSync(packageLockPath);
+        fs.removeSync(packageLockPath)
       }
 
       // Create .npmignore to prevent package-lock.json from being committed
-      const npmignorePath = path.join(targetDir, '.npmignore');
+      const npmignorePath = path.join(targetDir, '.npmignore')
       if (!fs.existsSync(npmignorePath)) {
-        fs.writeFileSync(npmignorePath, 'package-lock.json\n');
+        fs.writeFileSync(npmignorePath, 'package-lock.json\n')
       }
 
       // Optionally install dependencies
       if (!options.skipInstall) {
         // Check if pnpm is available
         try {
-          execSync('which pnpm', { stdio: 'ignore' });
+          execSync('which pnpm', { stdio: 'ignore' })
         } catch {
-          console.error(chalk.red('❌ pnpm is not installed or not available in PATH.'));
-          console.error(chalk.yellow('Please install pnpm before continuing:'));
-          console.error(chalk.cyan('  npm install -g pnpm'));
-          console.error(chalk.yellow('Or use --skip-install flag to skip dependency installation.'));
-          process.exit(1);
+          console.error(
+            chalk.red('❌ pnpm is not installed or not available in PATH.')
+          )
+          console.error(chalk.yellow('Please install pnpm before continuing:'))
+          console.error(chalk.cyan('  npm install -g pnpm'))
+          console.error(
+            chalk.yellow(
+              'Or use --skip-install flag to skip dependency installation.'
+            )
+          )
+          process.exit(1)
         }
-        
-        console.log(chalk.cyan('📦 Installing dependencies...'));
-        process.chdir(targetDir);
-        execSync('pnpm install', { stdio: 'inherit' });
+
+        console.log(chalk.cyan('📦 Installing dependencies...'))
+        process.chdir(targetDir)
+        execSync('pnpm install', { stdio: 'inherit' })
       }
 
-      console.log(chalk.green(`✅ NSBP project "${projectName}" created successfully!`));
-      console.log(chalk.yellow('\nNext steps:'));
-      console.log(`  cd ${projectName}`);
+      console.log(
+        chalk.green(`✅ NSBP project "${projectName}" created successfully!`)
+      )
+      console.log(chalk.yellow('\nNext steps:'))
+      console.log(`  cd ${projectName}`)
       if (options.skipInstall) {
-        console.log('  pnpm install');
+        console.log('  pnpm install')
       }
-      console.log('  pnpm run dev');
-      console.log(chalk.cyan('\nHappy coding! 🎉'));
-
+      console.log('  pnpm run dev')
+      console.log(chalk.cyan('\nHappy coding! 🎉'))
     } catch (error) {
-      console.error(chalk.red(`❌ Error creating project: ${error.message}`));
-      process.exit(1);
+      console.error(chalk.red(`❌ Error creating project: ${error.message}`))
+      process.exit(1)
     }
-  });
+  })
 
 program
   .command('info')
   .description('Display information about NSBP')
   .action(() => {
-    console.log(chalk.cyan('NSBP - Node React SSR by Webpack'));
-    console.log(chalk.gray('A lightweight React SSR framework with full Webpack control.'));
-    console.log('');
-    console.log(chalk.yellow('Key Features:'));
-    console.log('  • ~60% less resource usage than Next.js');
-    console.log('  • Full Webpack configuration control');
-    console.log('  • TypeScript support out of the box');
-    console.log('  • Built-in image service');
-    console.log('');
-    console.log(chalk.cyan('Website: ') + 'https://github.com/nsbp/nsbp');
-    console.log(chalk.cyan('Usage:   ') + 'nsbp create my-app');
-  });
+    console.log(chalk.cyan('NSBP - Node React SSR by Webpack'))
+    console.log(
+      chalk.gray('A lightweight React SSR framework with full Webpack control.')
+    )
+    console.log('')
+    console.log(chalk.yellow('Key Features:'))
+    console.log('  • Lightweight and flexible')
+    console.log('  • Full Webpack configuration control')
+    console.log('  • TypeScript support out of the box')
+    console.log('  • Built-in image service')
+    console.log('')
+    console.log(chalk.cyan('Website: ') + 'https://github.com/nsbp/nsbp')
+    console.log(chalk.cyan('Usage:   ') + 'nsbp create my-app')
+  })
 
 // Parse command line arguments
-program.parse();
+program.parse()

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nsbp-cli",
-  "version": "0.2.27",
+  "version": "0.2.30",
   "description": "CLI tool for creating NSBP (Node React SSR by Webpack) projects",
   "main": "index.js",
   "homepage": "https://nsbp.erishen.cn/",

package/templates/basic/.husky/README.md

@@ -0,0 +1,47 @@
+# Husky Git Hooks
+
+This directory contains Git hooks configured by Husky.
+
+## Available Hooks
+
+- **pre-commit**: Runs linting on staged files before commit
+- **pre-push**: Runs full lint check before pushing
+- **commit-msg**: Validates commit message format
+
+## Commit Message Format
+
+Follow the Conventional Commits specification:
+
+```
+<type>(<scope>): <subject>
+
+<body>
+
+<footer>
+```
+
+### Types
+
+- `feat`: A new feature
+- `fix`: A bug fix
+- `docs`: Documentation only changes
+- `style`: Code style changes (formatting, etc.)
+- `refactor`: Code change that neither fixes a bug nor adds a feature
+- `test`: Adding missing tests or correcting existing tests
+- `chore`: Maintenance tasks
+- `build`: Changes that affect the build system
+- `ci`: Changes to CI configuration files
+- `perf`: Performance improvements
+- `revert`: Reverts a previous commit
+
+### Example
+
+```
+feat(core): add SSR data preloading support
+
+- Implement loadData in route config
+- Add server-side data fetching utilities
+- Update hydration logic
+
+Closes #123
+```

package/templates/basic/.husky/commit-msg

@@ -0,0 +1,17 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+# Validate commit message format
+commit_regex='^(feat|fix|docs|style|refactor|test|chore|build|ci|perf|revert|BREAKING CHANGE)(\(.+\))?: .{1,50}'
+
+if ! grep -qE "$commit_regex" "$1"; then
+    echo ""
+    echo "❌ Invalid commit message format."
+    echo ""
+    echo "Valid format: <type>(<scope>): <subject>"
+    echo ""
+    echo "Types: feat, fix, docs, style, refactor, test, chore, build, ci, perf, revert"
+    echo "Example: feat(components): add new button component"
+    echo ""
+    exit 1
+fi

package/templates/basic/.husky/pre-commit

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+npx lint-staged

package/templates/basic/.husky/pre-push

@@ -0,0 +1,4 @@
+#!/bin/sh
+. "$(dirname "$0")/_/husky.sh"
+
+pnpm run lint

package/templates/basic/.prettierrc.js

@@ -0,0 +1,13 @@
+export default {
+  semi: false,
+  singleQuote: true,
+  tabWidth: 2,
+  trailingComma: 'es5',
+  printWidth: 100,
+  arrowParens: 'always',
+  endOfLine: 'lf',
+  plugins: ['prettier-plugin-organize-imports'],
+  importOrder: ['^react', '^@/(.*)$', '^[./]'],
+  importOrderSeparation: true,
+  importOrderSortSpecifiers: true
+}

package/templates/basic/README.md

@@ -2,6 +2,49 @@
 
 🌐 **Online Demo**: [https://nsbp.erishen.cn/](https://nsbp.erishen.cn/)
 
+## 🚀 快速开始
+
+```bash
+# 1. 安装依赖
+pnpm install
+
+# 2. 初始化 Git hooks（代码质量检查）
+pnpm run prepare
+
+# 3. 配置环境变量
+cp .env.example .env
+
+# 4. 启动开发环境
+pnpm run dev
+```
+
+## 📝 开发工具
+
+本项目配置了完整的代码质量检查工具：
+
+- **ESLint**: TypeScript + React 代码质量检查
+- **Prettier**: 自动代码格式化
+- **Husky**: Git hooks 自动化
+
+### 代码检查命令
+
+```bash
+pnpm run lint        # Lint 检查
+pnpm run lint:fix    # Lint 自动修复
+pnpm run format      # 格式化代码
+```
+
+### Git Hooks
+
+- `pre-commit`: 提交前自动 lint 和格式化
+- `pre-push`: 推送前运行完整 lint 检查
+- `commit-msg`: 验证提交信息格式（Conventional Commits）
+
+详细配置请查看：
+- [docs/ESLINT_AND_PRETTIER.md](./docs/ESLINT_AND_PRETTIER.md) - ESLint 和 Prettier 配置
+- [docs/SETUP_GIT_HOOKS.md](./docs/SETUP_GIT_HOOKS.md) - Git hooks 配置
+- [docs/DEVELOPMENT_GUIDE.md](./docs/DEVELOPMENT_GUIDE.md) - 完整开发指南
+
 ## 环境变量配置
 
 ### 快速开始