nsbp-cli 0.2.3 → 0.2.5

package/README.md

@@ -4,149 +4,152 @@ 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
+## Installation
 
-Install globally from npm registry:
-
-\`\`\`bash
-# Install globally
+### Global Installation (npm)
+```bash
 npm install -g nsbp-cli
+```
 
-# Or use npx (no installation required)
+### Using npx (No Installation)
+```bash
 npx nsbp-cli create my-app
+```
 
-# Verify installation
-nsbp-cli --version
-\`\`\`
-
-## Local Usage
+### Verify Installation
+```bash
+nsbp --version
+```
 
-The CLI is also located in \`cli/\` directory of the NSBP project. Run it locally for development:
-
-\`\`\`bash
-# Navigate to CLI directory
-cd cli
+## Quick Start
 
-# Show help
-node ./bin/nsbp-cli.js --help
+Create a new NSBP project with a single command:
 
-# Show NSBP information
-node ./bin/nsbp-cli.js info
+```bash
+nsbp create my-app
+cd my-app
+pnpm install  # NSBP CLI uses pnpm as package manager
+pnpm run dev
+```
 
-# Create a new project
-node ./bin/nsbp-cli.js create my-app
+For development with Docker (recommended):
+```bash
+cd my-app
+make dev  # Starts development environment with hot reload
+```
 
-# Skip npm install
-node ./bin/nsbp-cli.js create my-app --skip-install
-\`\`\`
+## Command Reference
 
-## Usage
+### Create a New Project
+```bash
+nsbp create <app-name> [options]
 
-### Create a new project
-
-\`\`\`bash
-# From npm (after global install)
-nsbp-cli create my-app
-
-# From npx
-npx nsbp-cli create my-app
+# Examples
+nsbp create my-app
+nsbp create my-app --skip-install  # Skip npm install
+nsbp create my-app --template basic  # Specify template (basic is default)
+```
 
-# From local CLI directory
-node ./bin/nsbp-cli.js create my-app
+### Display Framework Information
+```bash
+nsbp info
+```
 
-# Skip npm install
-nsbp-cli create my-app --skip-install
+### Help
+```bash
+nsbp --help          # Show all commands
+nsbp create --help   # Show create command options
+```
 
-# Specify template (currently only basic is available)
-nsbp-cli create my-app --template basic
-\`\`\`
+## Templates
 
-### Display information
+The CLI provides project templates to get started quickly:
 
-\`\`\`bash
-# Show NSBP framework information
-nsbp-cli info
-\`\`\`
+- **basic** (default) - Complete NSBP stack with React SSR, TypeScript, and Webpack
+  - Includes full Docker support for development and production
+  - Pre-configured with Makefile for easy Docker operations
+  - Ready-to-use project structure
 
-### Help
+- **blog** - Blog-focused template with article layouts (coming soon)
+- **ecommerce** - E-commerce template with product pages (coming soon)
 
-\`\`\`bash
-# Show all commands
-nsbp-cli --help
+## Docker Support
 
-# Show create command help
-nsbp-cli create --help
-\`\`\`
+The **basic** template includes comprehensive Docker configuration:
 
-## Templates
+### Docker Files Included
+- `.dockerignore` - Docker build ignore rules
+- `docker-compose.yml` - Production environment configuration
+- `docker-compose.dev.yml` - Development environment with hot reload
+- `Dockerfile` - Multi-stage production build
+- `Dockerfile.dev` - Development build
+- `Makefile` - Convenient Docker commands
 
-- **basic**: Default template with core NSBP features (currently available)
-- **blog**: Blog-focused template with article layouts (coming soon)
-- **ecommerce**: E-commerce template with product pages (coming soon)
+### Available Make Commands
+```bash
+make dev      # Start development environment (hot reload)
+make prod     # Start production environment
+make rebuild  # Rebuild and restart production containers
+make logs     # View container logs
+make down     # Stop and remove containers
+make shell    # Open shell in production container
+make shell-dev # Open shell in development container
+```
 
-## How it works
+## How It Works
 
-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.
+The CLI copies the 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, including complete Docker support.
 
 ## Template Synchronization
 
 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 CLI directory
-cd /path/to/nsbp-cli/cli
-
-# Run sync script
-pnpm run sync-template
-# or
-npm run sync-template
-
-# Or use to update shortcut
-pnpm run update
-# or
-npm run update
-\`\`\`
+```bash
+cd cli
+pnpm run update  # CLI项目使用pnpm，运行同步脚本
+# 或者使用 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 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\`
+- **Smart copying** - Copies only source code and configuration files
+- **Build artifact filtering** - Automatically excludes build artifacts from the public directory
+- **Template transformation** - Converts main project's package.json to template format
+- **Integrity verification** - Checks for required files before synchronization
+
+### Synchronized Files
+- `src/` - React components and routing
+- `public/` - Static assets
+- `scripts/` - Startup and utility scripts
+- `webpack.*.js` - Webpack configuration
+- `tsconfig.json` - TypeScript configuration
+- `postcss.config.js` - PostCSS configuration
+- `package.json` - Project configuration (templatized)
+- `.gitignore`, `.prettierrc`, `.prettierignore`, `README.md`
+- **Docker files**: `.dockerignore`, `docker-compose.yml`, `docker-compose.dev.yml`, `Dockerfile`, `Dockerfile.dev`, `Makefile`
 
 ## Development
 
 To work on the CLI locally:
 
-\`\`\`bash
+```bash
 cd cli
-pnpm install
-# or
-npm install
-node ./bin/nsbp-cli.js create test-app
-\`\`\`
+pnpm install  # CLI项目使用pnpm作为包管理器
+node ./bin/nsbp.js --help  # Test CLI locally
+```
 
 ## Package Information
 
-- **Package Name**: \`nsbp-cli\`
-- **Bin Command**: \`nsbp-cli\`
-- **Version**: \`0.1.0\`
+- **Package Name**: `nsbp-cli`
+- **Bin Command**: `nsbp` (install globally and run `nsbp --help`)
+- **Version**: `0.2.4`
 - **Dependencies**: chalk, commander, fs-extra, inquirer
-- **Package Manager**: Supports both npm and pnpm
+- **Package Manager**: Uses pnpm (also compatible with npm)
+- **Node Version**: >=16.0.0
 
 ## License
 
-ISC
+ISC

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "nsbp-cli",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "CLI tool for creating NSBP (Node React SSR by Webpack) projects",
   "main": "index.js",
   "files": [

package/templates/basic/Makefile

@@ -1,4 +1,4 @@
-.PHONY: help build dev prod down clean logs restart publish-cli
+.PHONY: help build dev prod down clean logs restart
 
 help: ## Show this help message
 	@echo 'Usage: make [target]'
@@ -51,16 +51,4 @@ shell-dev: ## Open shell in development container
 	docker-compose -f docker-compose.dev.yml exec app sh
 
 test: ## Run tests (if configured)
-	docker-compose exec app npm test
-
-publish-cli: ## Publish CLI to npm registry
-	@echo "🚀 Starting CLI publish process..."
-	cd cli && npm run update
-	@echo "📦 Template updated, committing changes..."
-	git add .
-	git diff --quiet && git diff --cached --quiet || git commit -m "chore: update cli template"
-	cd cli && npm version patch
-	cd cli && npm publish
-	@echo "📤 Pushing to git repository..."
-	git push --follow-tags
-	@echo "✅ CLI published successfully!"
+	docker-compose exec app npm test

package/templates/basic/README.md

@@ -134,4 +134,14 @@ make rebuild-dev   # 重新构建并启动开发环境
 可在 `docker-compose.yml` 或 `docker-compose.dev.yml` 中配置环境变量：
 
 - `NODE_ENV`: 运行环境 (production/development)
-- `PORT`: 服务端口 (默认 3001)
+- `PORT`: 服务端口 (默认 3001)
+
+### CLI 发布
+
+从项目根目录发布 CLI 到 npm 注册表：
+
+```bash
+make publish-cli  # 同步模板、更新版本、发布到 npm
+```
+
+注意：此命令仅在项目根目录可用，生成的 NSBP 项目不包含此目标。