nsbp-cli 0.1.0

package/CHANGELOG.md

@@ -0,0 +1,102 @@
+# 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/README.md

@@ -0,0 +1,150 @@
+# NSBP CLI
+
+Command-line interface for creating NSBP (Node React SSR by Webpack) projects.
+
+## Local Usage
+
+The CLI is located in the `cli/` directory of the NSBP project. Run it locally:
+
+```bash
+# Navigate to CLI directory
+cd cli
+
+# Show help
+node ./bin/nsbp.js --help
+
+# Show NSBP information
+node ./bin/nsbp.js info
+
+# Create a new project
+node ./bin/nsbp.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
+```
+
+## Usage
+
+### Create a new project
+
+```bash
+# Basic usage
+node ./bin/nsbp.js create my-app
+
+# Or after npm link
+nsbp create my-app
+
+# Skip npm install
+node ./bin/nsbp.js create my-app --skip-install
+# or
+nsbp create my-app --skip-install
+
+# Specify template (currently only basic is available)
+nsbp create my-app --template basic
+```
+
+### Display information
+
+```bash
+# Show NSBP framework information
+nsbp info
+# or
+node ./bin/nsbp.js info
+```
+
+### Help
+
+```bash
+# Show all commands
+nsbp --help
+# or
+node ./bin/nsbp.js --help
+
+# Show create command help
+nsbp create --help
+```
+
+## Templates
+
+- **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)
+
+## 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.
+
+## Template Synchronization
+
+The CLI includes a synchronization script that keeps the built-in templates up-to-date with the main NSBP project code.
+
+### Sync Script
+Location: `cli/scripts/sync-template.js`
+
+### Usage
+```bash
+# From the CLI directory
+cd /path/to/nsbp/cli
+
+# Run the sync script
+npm run sync-template
+
+# Or use the update shortcut
+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")
+- **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`
+
+## Development
+
+To work on the CLI locally:
+
+```bash
+cd cli
+pnpm install
+# or
+npm install
+node ./bin/nsbp.js create test-app
+```
+
+## Package Information
+
+- **Package Name**: `nsbp-cli`
+- **Bin Command**: `nsbp`
+- **Dependencies**: chalk, commander, fs-extra, inquirer
+- **Package Manager**: Supports both npm and pnpm
+
+
+## License
+
+ISC

package/bin/nsbp.js

@@ -0,0 +1,145 @@
+#!/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 program = new Command();
+
+program
+  .name('nsbp')
+  .description('CLI tool to create NSBP (Node React SSR by Webpack) projects')
+  .version('0.1.0');
+
+program
+  .command('create <project-name>')
+  .description('Create a new NSBP project')
+  .option('-t, --template <template>', 'Specify template (basic, blog, ecommerce)', 'basic')
+  .option('--skip-install', 'Skip npm install')
+  .action(async (projectName, options) => {
+    console.log(chalk.cyan(`🚀 Creating NSBP project: ${projectName}`));
+    
+    try {
+      // Check if directory already exists
+      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,
+          },
+        ]);
+        if (!overwrite) {
+          console.log(chalk.yellow('Operation cancelled.'));
+          process.exit(0);
+        }
+        fs.removeSync(targetDir);
+      }
+
+      // Create project directory
+      fs.ensureDirSync(targetDir);
+
+      // Get template source path from built-in templates
+      const templateSource = path.join(__dirname, '../templates/basic');
+      
+      // List of files/directories to copy
+      const copyItems = [
+        'src',
+        'public',
+        'scripts',
+        'webpack.base.js',
+        'webpack.client.js', 
+        'webpack.server.js',
+        'tsconfig.json',
+        'postcss.config.js',
+        '.prettierrc',
+        '.prettierignore',
+        '.gitignore',
+        'README.md'
+      ];
+
+      // Copy each item
+      console.log(chalk.cyan('📦 Copying project files...'));
+      for (const item of copyItems) {
+        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.
+                const excluded = ['node_modules', '.temp_cache', 'build', '.git', '.DS_Store', '.serena'];
+                return !excluded.some(ex => src.includes(ex));
+              }
+            });
+          } else {
+            fs.copySync(source, target);
+          }
+        }
+      }
+
+      // Create package.json for new project
+      const originalPackage = require(path.join(templateSource, 'package.json'));
+      const newPackage = {
+        name: projectName,
+        version: '1.0.0',
+        description: `NSBP project: ${projectName}`,
+        scripts: originalPackage.scripts,
+        dependencies: originalPackage.dependencies,
+        devDependencies: originalPackage.devDependencies,
+        keywords: originalPackage.keywords,
+        author: originalPackage.author,
+        license: originalPackage.license
+      };
+
+      fs.writeFileSync(
+        path.join(targetDir, 'package.json'),
+        JSON.stringify(newPackage, null, 2)
+      );
+
+      // Optionally install dependencies
+      if (!options.skipInstall) {
+        console.log(chalk.cyan('📦 Installing dependencies...'));
+        process.chdir(targetDir);
+        execSync('npm install', { stdio: 'inherit' });
+      }
+
+      console.log(chalk.green(`✅ NSBP project "${projectName}" created successfully!`));
+      console.log(chalk.yellow('\nNext steps:'));
+      console.log(`  cd ${projectName}`);
+      if (options.skipInstall) {
+        console.log('  npm install');
+      }
+      console.log('  npm run dev');
+      console.log(chalk.cyan('\nHappy coding! 🎉'));
+
+    } catch (error) {
+      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');
+  });
+
+// Parse command line arguments
+program.parse();

package/package.json

@@ -0,0 +1,43 @@
+{
+  "name": "nsbp-cli",
+  "version": "0.1.0",
+  "description": "CLI tool for creating NSBP (Node React SSR by Webpack) projects",
+  "main": "index.js",
+  "bin": {
+    "nsbp": "./bin/nsbp.js"
+  },
+  "scripts": {
+    "start": "node ./bin/nsbp.js",
+    "test": "echo \"Error: no test specified\" && exit 1",
+    "sync-template": "node ./scripts/sync-template.js",
+    "update": "npm run sync-template"
+  },
+  "keywords": [
+    "nsbp",
+    "cli",
+    "react",
+    "ssr",
+    "webpack",
+    "scaffold",
+    "generator"
+  ],
+  "author": "Erishen Sun",
+  "license": "ISC",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/erishen/nsbp"
+  },
+  "bugs": {
+    "url": "https://github.com/erishen/nsbp/issues"
+  },
+  "homepage": "https://github.com/erishen/nsbp#readme",
+  "dependencies": {
+    "chalk": "^4.1.2",
+    "commander": "^11.0.0",
+    "fs-extra": "^11.2.0",
+    "inquirer": "^8.2.6"
+  },
+  "engines": {
+    "node": ">=16.0.0"
+  }
+}