nsbp-cli 0.1.0 → 0.1.1

package/README.md

@@ -2,83 +2,81 @@
 
 Command-line interface for creating NSBP (Node React SSR by Webpack) projects.
 
+📦 **Published on npm**: [https://www.npmjs.com/package/nsbp-cli](https://www.npmjs.com/package/nsbp-cli)
+
+## Installation from npm
+
+Install globally from npm registry:
+
+\`\`\`bash
+# Install globally
+npm install -g nsbp-cli
+
+# Or use npx (no installation required)
+npx nsbp-cli create my-app
+
+# Verify installation
+nsbp-cli --version
+\`\`\`
+
 ## Local Usage
 
-The CLI is located in the `cli/` directory of the NSBP project. Run it locally:
+The CLI is also located in \`cli/\` directory of the NSBP project. Run it locally for development:
 
-```bash
+\`\`\`bash
 # Navigate to CLI directory
 cd cli
 
 # Show help
-node ./bin/nsbp.js --help
+node ./bin/nsbp-cli.js --help
 
 # Show NSBP information
-node ./bin/nsbp.js info
+node ./bin/nsbp-cli.js info
 
 # Create a new project
-node ./bin/nsbp.js create my-app
+node ./bin/nsbp-cli.js create my-app
 
 # Skip npm install
-node ./bin/nsbp.js create my-app --skip-install
-```
-
-## Global Installation
-
-To use `nsbp` command globally from anywhere:
-
-```bash
-# Navigate to CLI directory
-cd cli
-
-# Install globally
-npm link
-
-# Now you can use from anywhere
-nsbp create my-app
-nsbp info
-```
+node ./bin/nsbp-cli.js create my-app --skip-install
+\`\`\`
 
 ## Usage
 
 ### Create a new project
 
-```bash
-# Basic usage
-node ./bin/nsbp.js create my-app
+\`\`\`bash
+# From npm (after global install)
+nsbp-cli create my-app
+
+# From npx
+npx nsbp-cli create my-app
 
-# Or after npm link
-nsbp create my-app
+# From local CLI directory
+node ./bin/nsbp-cli.js create my-app
 
 # Skip npm install
-node ./bin/nsbp.js create my-app --skip-install
-# or
-nsbp create my-app --skip-install
+nsbp-cli create my-app --skip-install
 
 # Specify template (currently only basic is available)
-nsbp create my-app --template basic
-```
+nsbp-cli create my-app --template basic
+\`\`\`
 
 ### Display information
 
-```bash
+\`\`\`bash
 # Show NSBP framework information
-nsbp info
-# or
-node ./bin/nsbp.js info
-```
+nsbp-cli info
+\`\`\`
 
 ### Help
 
-```bash
+\`\`\`bash
 # Show all commands
-nsbp --help
-# or
-node ./bin/nsbp.js --help
+nsbp-cli --help
 
 # Show create command help
-nsbp create --help
-```
+nsbp-cli create --help
+\`\`\`
 
 ## Templates
 
@@ -88,63 +86,67 @@ nsbp create --help
 
 ## How it works
 
-The CLI copies the NSBP project structure from templates/basic/ to your target directory and creates a new `package.json` with the appropriate dependencies. You get a fully functional NSBP project ready for development.
+The CLI copies NSBP project structure from \`templates/basic/\` to your target directory and creates a new \`package.json\` with appropriate dependencies. You get a fully functional NSBP project ready for development.
 
 ## Template Synchronization
 
-The CLI includes a synchronization script that keeps the built-in templates up-to-date with the main NSBP project code.
+The CLI includes a synchronization script that keeps built-in templates up-to-date with the main NSBP project code.
 
 ### Sync Script
-Location: `cli/scripts/sync-template.js`
+Location: \`cli/scripts/sync-template.js\`
 
 ### Usage
-```bash
-# From the CLI directory
-cd /path/to/nsbp/cli
+\`\`\`bash
+# From CLI directory
+cd /path/to/nsbp-cli/cli
 
-# Run the sync script
+# Run sync script
+pnpm run sync-template
+# or
 npm run sync-template
 
-# Or use the update shortcut
+# Or use to update shortcut
+pnpm run update
+# or
 npm run update
-```
+\`\`\`
 
 ### Features
 - **Smart copying**: Copies only source code and configuration files
-- **Build artifact filtering**: Automatically excludes .js.map, .css.map, .txt, .json, and .LICENSE.txt files from public directory
-- **Template transformation**: Converts main project's package.json to template format (name: "nsbp-template")
+- **Build artifact filtering**: Automatically excludes .js.map, .css.map, .txt, .json, and .LICENSE.txt files from the public directory
+- **Template transformation**: Converts main project's package.json to template format (name: "nsbp-cli-template")
 - **Integrity verification**: Checks for required files like src/Routers.tsx, scripts/start.js, and package.json
 
 ### What gets synchronized
-- `src/` - React components and routing
-- `public/` - Static assets (images, favicon.ico)
-- `scripts/` - Startup and utility scripts
-- `webpack.*.js` - Webpack configuration files
-- `tsconfig.json` - TypeScript configuration
-- `postcss.config.js` - PostCSS configuration
-- `package.json` - Project configuration (automatically templatized)
-- `.gitignore`, `.prettierrc`, `.prettierignore`, `README.md`
+- \`src/\` - React components and routing
+- \`public/\` - Static assets (images, favicon.ico)
+- \`scripts/\` - Startup and utility scripts
+- \`webpack.*.js\` - Webpack configuration files
+- \`tsconfig.json\` - TypeScript configuration
+- \`postcss.config.js\` - PostCSS configuration
+- \`package.json\` - Project configuration (automatically templatized)
+- \`.gitignore\`, \`.prettierrc\`, \`.prettierignore\`, \`README.md\`
 
 ## Development
 
 To work on the CLI locally:
 
-```bash
+\`\`\`bash
 cd cli
 pnpm install
 # or
 npm install
-node ./bin/nsbp.js create test-app
-```
+node ./bin/nsbp-cli.js create test-app
+\`\`\`
 
 ## Package Information
 
-- **Package Name**: `nsbp-cli`
-- **Bin Command**: `nsbp`
+- **Package Name**: \`nsbp-cli\`
+- **Bin Command**: \`nsbp-cli\`
+- **Version**: \`0.1.0\`
 - **Dependencies**: chalk, commander, fs-extra, inquirer
 - **Package Manager**: Supports both npm and pnpm
 
-
 ## License
 
-ISC
+ISC

package/package.json

@@ -1,8 +1,13 @@
 {
   "name": "nsbp-cli",
-  "version": "0.1.0",
+  "version": "0.1.1",
   "description": "CLI tool for creating NSBP (Node React SSR by Webpack) projects",
   "main": "index.js",
+  "files": [
+    "bin",
+    "templates",
+    "README.md"
+  ],
   "bin": {
     "nsbp": "./bin/nsbp.js"
   },
@@ -40,4 +45,4 @@
   "engines": {
     "node": ">=16.0.0"
   }
-}
+}

package/CHANGELOG.md

@@ -1,102 +0,0 @@
-# NSBP CLI Changelog
-
-All notable changes to the NSBP CLI project will be documented in this file.
-
-The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
-and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
-
-## [0.1.0] - 2026-01-09
-
-### Added
-- **Initial release**: CLI tool for creating NSBP (Node React SSR by Webpack) projects
-- **Create command**: `nsbp create <project-name>` to scaffold new projects
-- **Template system**: Built-in templates (basic, blog, ecommerce support planned)
-- **Interactive prompts**: Confirmation for overwriting existing directories
-- **Template synchronization**: Smart sync script (`scripts/sync-template.js`) to update CLI templates from main NSBP project
-
-### Changed
-- **Package.json handling**: Automatic template name transformation ("nsbp-template" → user project name)
-- **Build artifact filtering**: Exclude .js.map, .css.map, .txt, .json, .LICENSE.txt files from public directory during sync
-
-### Features
-- **Skip installation option**: `--skip-install` flag to skip npm install
-- **Template selection**: `--template <template>` option (currently basic only)
-- **Help system**: Comprehensive help with `--help` flag
-- **Version info**: `--version` flag to display CLI version
-- **Project info**: `nsbp info` command to display framework information
-
-### Technical Details
-- **Dependencies**: 
-  - `commander` for CLI argument parsing
-  - `chalk` for colored console output
-  - `inquirer` for interactive prompts
-  - `fs-extra` for enhanced file operations
-- **Built-in templates**: Located in `cli/templates/basic/`
-- **Sync script**: Located in `cli/scripts/sync-template.js`
-
-### Usage
-
-#### Installation
-```bash
-# Install globally
-npm install -g nsbp
-
-# Or use with npx (no installation required)
-npx nsbp create my-app
-```
-
-#### Create a new project
-```bash
-# Basic usage
-nsbp create my-app
-
-# Skip npm install
-nsbp create my-app --skip-install
-
-# Specify template (currently basic only)
-nsbp create my-app --template basic
-```
-
-#### Update CLI templates
-```bash
-# Run from CLI directory
-cd /path/to/nsbp/cli
-npm run sync-template
-
-# Or use the update shortcut
-npm run update
-```
-
-#### Display information
-```bash
-# Show NSBP framework information
-nsbp info
-
-# Show CLI version
-nsbp --version
-
-# Show help
-nsbp --help
-```
-
-### Notes
-- This is the initial release of NSBP CLI
-- The CLI currently supports the "basic" template only
-- Blog and ecommerce templates are planned for future releases
-- The sync script automatically filters out build artifacts to keep templates clean
-- All templates are built-in; no external downloads required
-
----
-
-## Future Plans
-- **Template expansion**: Add blog and ecommerce templates
-- **Advanced configuration**: Custom webpack and TypeScript configuration options
-- **Plugin system**: Support for third-party templates and plugins
-- **CI/CD integration**: Automated testing and deployment workflows
-- **Internationalization**: Multi-language support for CLI output
-
-## Contributing
-Contributions are welcome! Please see the main NSBP project repository for contribution guidelines.
-
-## License
-ISC © Erishen Sun

package/scripts/sync-template.js

@@ -1,277 +0,0 @@
-#!/usr/bin/env node
-/**
- * 同步 NSBP 主项目代码到 CLI 模板目录
- * 使用：node scripts/sync-template.js
- */
-
-const fs = require('fs-extra');
-const path = require('path');
-const chalk = require('chalk');
-
-// 路径配置
-const ROOT_DIR = path.resolve(__dirname, '../..'); // nsbp 项目根目录
-const CLI_DIR = path.resolve(__dirname, '..'); // cli 目录
-const TARGET_DIR = path.join(CLI_DIR, 'templates/basic');
-
-// 要复制的文件和目录列表
-const COPY_ITEMS = [
-  'src',
-  'public',
-  'scripts',
-  'webpack.base.js',
-  'webpack.client.js',
-  'webpack.server.js',
-  'tsconfig.json',
-  'postcss.config.js',
-  '.gitignore',
-  '.prettierrc',
-  '.prettierignore',
-  'README.md',
-  'package.json'
-];
-
-// 排除的模式（相对路径包含这些字符串的文件将被跳过）
-const EXCLUDE_PATTERNS = [
-  '/node_modules/',
-  '/.temp_cache/',
-  '/build/',
-  '/.git/',
-  '.DS_Store',
-  '/.serena/',
-  '/.vscode/',
-  '/.idea/',
-  '.log',
-  '.tmp',
-  // 构建产物 - 匹配 public 下的特定文件
-  'public/js/',
-  'public/css/',
-  'public/client.',
-  'public/*.js',
-  'public/*.js.map',
-  'public/*.txt',
-  'public/*.json'
-];
-
-// 特殊文件处理配置
-const SPECIAL_FILES = {
-  'package.json': (content) => {
-    const pkg = JSON.parse(content);
-    // 修改为模板名称
-    pkg.name = 'nsbp-template';
-    pkg.description = 'node react ssr by webpack';
-    // 确保版本号
-    pkg.version = '1.0.0';
-    return JSON.stringify(pkg, null, 2);
-  }
-};
-
-// 主函数
-async function syncTemplate() {
-  console.log(chalk.cyan('🔄 开始同步 NSBP 主项目代码到 CLI 模板...'));
-  console.log(chalk.gray(`源目录: ${ROOT_DIR}`));
-  console.log(chalk.gray(`目标目录: ${TARGET_DIR}`));
-
-  // 验证源目录
-  if (!fs.existsSync(ROOT_DIR)) {
-    console.error(chalk.red(`❌ 源目录不存在: ${ROOT_DIR}`));
-    process.exit(1);
-  }
-
-  // 清理目标目录（但保留 templates/basic 本身）
-  if (fs.existsSync(TARGET_DIR)) {
-    console.log(chalk.gray('🧹 清理目标目录...'));
-    await fs.emptyDir(TARGET_DIR);
-  } else {
-    await fs.ensureDir(TARGET_DIR);
-  }
-
-  // 复制文件
-  console.log(chalk.cyan('📦 复制项目文件...'));
-  let copiedCount = 0;
-  let skippedCount = 0;
-
-  for (const item of COPY_ITEMS) {
-    const source = path.join(ROOT_DIR, item);
-    const target = path.join(TARGET_DIR, item);
-
-    if (!fs.existsSync(source)) {
-      console.log(chalk.yellow(`⚠️  源文件不存在，跳过: ${item}`));
-      skippedCount++;
-      continue;
-    }
-
-    // 检查是否为排除项
-    const shouldExclude = EXCLUDE_PATTERNS.some(pattern => {
-      if (pattern.includes('*')) {
-        // 简单的通配符匹配（仅支持后缀）
-        if (pattern.startsWith('*')) {
-          const ext = pattern.substring(1);
-          return item.endsWith(ext);
-        }
-      }
-      return item.includes(pattern);
-    });
-
-    if (shouldExclude) {
-      console.log(chalk.gray(`  跳过排除项: ${item}`));
-      skippedCount++;
-      continue;
-    }
-
-    try {
-      const stat = fs.statSync(source);
-      
-      if (stat.isDirectory()) {
-        // 复制目录，使用自定义过滤器
-        await fs.copy(source, target, {
-        filter: (src) => {
-            const relativePath = path.relative(source, src);
-            // 检查是否匹配排除模式
-            for (const pattern of EXCLUDE_PATTERNS) {
-                if (relativePath.includes(pattern)) {
-                    return false;
-                }
-                // 简单的通配符匹配
-                if (pattern.includes('*')) {
-                    const [prefix] = pattern.split('*');
-                    if (relativePath.startsWith(prefix)) {
-                        return false;
-                    }
-                }
-            }
-            
-            // 排除构建产物文件（避免复制 .js, .js.map, .css, .css.map, .txt, .json 等）
-            // 仅对 public 目录应用此过滤
-            if (item === 'public') {
-                const buildArtifactPatterns = [
-                    '.js.map',
-                    '.css.map',
-                    '.js',
-                    '.css',
-                    '.txt',
-                    '.json',
-                    '.LICENSE.txt'
-                ];
-                
-                // 只检查文件，不检查目录
-                try {
-                    const stat = fs.statSync(src);
-                    if (stat.isFile()) {
-                        const name = path.basename(src);
-                        
-                        // 检查构建产物模式
-                        for (const pattern of buildArtifactPatterns) {
-                            if (name.endsWith(pattern)) {
-                                // 但保留 favicon.ico
-                                if (name === 'favicon.ico') {
-                                    return true;
-                                }
-                                return false;
-                            }
-                        }
-                    }
-                } catch (err) {
-                    // 如果无法获取状态，继续复制
-                    console.warn(chalk.yellow(`⚠️  无法检查文件状态: ${src}`), err.message);
-                }
-            }
-            
-            return true;
-        }
-        });
-        console.log(chalk.green(`  目录复制: ${item}`));
-      } else {
-        // 复制文件
-        await fs.copy(source, target);
-        
-        // 特殊文件处理
-        const basename = path.basename(item);
-        if (SPECIAL_FILES[basename]) {
-          const content = await fs.readFile(target, 'utf8');
-          const processed = SPECIAL_FILES[basename](content);
-          await fs.writeFile(target, processed, 'utf8');
-          console.log(chalk.green(`  文件处理: ${item} (已模板化)`));
-        } else {
-          console.log(chalk.green(`  文件复制: ${item}`));
-        }
-      }
-      copiedCount++;
-    } catch (error) {
-      console.error(chalk.red(`❌ 复制失败: ${item}`), error.message);
-    }
-  }
-
-  // 确保必要的目录存在（即使源目录为空）
-  const requiredDirs = ['public/css', 'public/js', 'public/images'];
-  for (const dir of requiredDirs) {
-    const dirPath = path.join(TARGET_DIR, dir);
-    if (!fs.existsSync(dirPath)) {
-      await fs.ensureDir(dirPath);
-      console.log(chalk.gray(`  创建目录: ${dir}`));
-    }
-  }
-
-  // 清理 public 目录中的构建产物
-  console.log(chalk.cyan('🧹 清理构建产物...'));
-  const publicDir = path.join(TARGET_DIR, 'public');
-  if (fs.existsSync(publicDir)) {
-    const items = await fs.readdir(publicDir, { withFileTypes: true });
-    for (const item of items) {
-      const itemPath = path.join(publicDir, item.name);
-      // 删除 .js, .js.map, .txt, .json 文件（但保留 favicon.ico 和目录）
-      if (item.isFile()) {
-        const ext = path.extname(item.name);
-        if (['.js', '.js.map', '.txt', '.json', '.css'].includes(ext) && item.name !== 'favicon.ico') {
-          await fs.remove(itemPath);
-          console.log(chalk.gray(`    删除: ${item.name}`));
-        }
-      }
-    }
-    // 清理子目录中的文件
-    const subDirs = ['css', 'js'];
-    for (const subDir of subDirs) {
-      const subDirPath = path.join(publicDir, subDir);
-      if (fs.existsSync(subDirPath)) {
-        const subItems = await fs.readdir(subDirPath, { withFileTypes: true });
-        for (const subItem of subItems) {
-          if (subItem.isFile()) {
-            await fs.remove(path.join(subDirPath, subItem.name));
-            console.log(chalk.gray(`    删除: ${subDir}/${subItem.name}`));
-          }
-        }
-      }
-    }
-  }
-
-  // 验证模板完整性
-  console.log(chalk.cyan('🔍 验证模板完整性...'));
-  const requiredFiles = ['src/Routers.tsx', 'scripts/start.js', 'package.json'];
-  let missingFiles = [];
-
-  for (const file of requiredFiles) {
-    if (!fs.existsSync(path.join(TARGET_DIR, file))) {
-      missingFiles.push(file);
-    }
-  }
-
-  if (missingFiles.length > 0) {
-    console.log(chalk.yellow(`⚠️  缺少必要文件: ${missingFiles.join(', ')}`));
-  } else {
-    console.log(chalk.green('✅ 模板完整性验证通过'));
-  }
-
-  console.log(chalk.cyan('\n📊 同步完成'));
-  console.log(chalk.green(`   复制文件: ${copiedCount} 个`));
-  console.log(chalk.yellow(`   跳过文件: ${skippedCount} 个`));
-  console.log(chalk.blue(`   目标目录: ${TARGET_DIR}`));
-  
-  if (missingFiles.length > 0) {
-    console.log(chalk.yellow('\n⚠️  警告：部分必要文件缺失，请检查源项目'));
-  }
-}
-
-// 执行
-syncTemplate().catch(error => {
-  console.error(chalk.red('❌ 同步过程中发生错误:'), error);
-  process.exit(1);
-});