@oinone/cli 7.2.1

package/README.md

@@ -0,0 +1,115 @@
+# Quick Start
+
+Read this in [中文](README_zh-CN.md).
+
+## Global Installation of `@oinone/cli`
+
+```shell
+npm install -g @oinone/cli
+```
+
+## Create Frontend Project
+
+Create a frontend project in any directory. We provide two modes: interactive creation and silent creation.
+
+### 1. **Interactive Creation**
+
+Follow the prompts to enter the company abbreviation, project name, select the Oinone edition, version, and whether to download the latest static resources.
+
+```shell
+oinone-frontend
+```
+
+**Example:**
+
+```shell
+Please enter the company name (e.g. ss): ss
+Please enter the project name (e.g. oms): oms
+Please select the Oinone edition: Community Edition (Default)
+Please select the Oinone version: 7.2.0 (Default)
+Do you want to download the latest static resources? (Y/n): Y
+
+✔ Project created successfully!
+
+To get started:
+
+  cd ss-oms-frontend
+  pnpm install
+  pnpm run dev
+```
+
+### 2. Silent Creation
+
+If you want to skip the interactive steps to quickly create a project, you can directly append the project name after the command. In silent creation mode, the sub-packages and file prefixes in the project will default to this project name, the Oinone version will default to `7.2.0`, and the edition will default to `community`.
+
+```shell
+oinone-frontend <project-name>
+```
+
+**Parameters:**
+- `<project-name>`: The name of the project you want to create (will be used as the project folder name and module prefix).
+- `--download-static-resource`: Controls whether to automatically download static resources. Optional values are `true` (default) or `false`.
+- `--oinone-version`: Specifies the Oinone version number (e.g., `7.2.0` or `6.4.0`). The default value is `7.2.0`.
+- `--edition`: Specifies the Oinone edition to use. Optional values are `community` (default) or `enterprise`.
+
+**Example (Create, skip resource download, and specify version number and edition):**
+
+```shell
+oinone-frontend my-project --download-static-resource=true --oinone-version="7.2.0" --edition="enterprise"
+```
+
+When you disable the automatic download of the resource package, the CLI will output the script commands required for manual download after the project creation is completed.
+
+### 3. Cache Management
+
+The CLI caches downloaded static resources in the system's temporary directory to speed up subsequent project creations. You can manage this cache using the `cache` command.
+
+**View Cache Information:**
+```shell
+oinone-frontend cache info
+```
+
+**Clean Cache:**
+```shell
+oinone-frontend cache clean
+```
+
+**Cache Help Command:**
+You can use the `-h` or `--help` option with the `cache` command to view its specific help documentation.
+```shell
+oinone-frontend cache -h
+```
+
+### 4. Help Command
+
+You can use the `-h` or `--help` option to view the CLI's standard help documentation.
+
+```shell
+oinone-frontend -h
+```
+
+**Output:**
+
+```shell
+Usage: cli [options] [command]
+
+Oinone Frontend Template CLI
+
+Options:
+  -V, --version                       output the version number
+  -h, --help                          display help for command
+
+Commands:
+  cache                               Manage the local static resources cache
+  help [command]                      display help for command
+```
+
+## Uninstall `@oinone/cli`
+
+If you need to uninstall the CLI tool, you can run the following command:
+
+```shell
+npm uninstall -g @oinone/cli
+```
+
+> **Note:** Uninstalling the CLI will **not** automatically clean up the cached static resources in your temporary directory. If you want to completely remove the cache, please run `oinone-frontend cache clean` before uninstalling, or manually delete the `oinone-cli-cache` folder in your system's temporary directory.

package/README_zh-CN.md

@@ -0,0 +1,115 @@
+# 快速开始
+
+Read this in [English](README.MD).
+
+## 全局安装 `@oinone/cli`
+
+``` shell
+npm install -g @oinone/cli
+```
+
+## 创建前端工程
+
+在任意目录下创建前端工程。我们提供了交互式创建和静默创建两种模式。
+
+### 1. 交互式创建
+
+根据提示输入公司简称, 项目名称、选择 Oinone 版本（社区/企业）、版本号以及是否下载最新静态资源包即可。
+
+``` shell
+oinone-frontend
+```
+
+**示例：**
+
+``` shell
+Please enter the company name (e.g. ss): ss
+Please enter the project name (e.g. oms): oms
+Please select the Oinone edition: Community Edition (Default)
+Please select the Oinone version: 7.2.0 (Default)
+Do you want to download the latest static resources? (Y/n): Y
+
+✔ Project created successfully!
+
+To get started:
+
+  cd ss-oms-frontend
+  pnpm install
+  pnpm run dev
+```
+
+### 2. 静默创建
+
+如果您希望跳过交互步骤快速创建工程，可以直接在命令后追加项目名称。静默创建时，项目中的子包及文件前缀将默认使用该项目名称，Oinone 版本号默认为 `7.2.0`，版本默认为 `community`（社区版）。
+
+``` shell
+oinone-frontend <project-name>
+```
+
+**参数说明：**
+- `<project-name>`: 您要创建的项目名称（将作为项目文件夹名称和各模块前缀）。
+- `--download-static-resource`: 控制是否自动下载静态资源包。可选值为 `true` (默认) 或 `false`。
+- `--oinone-version`: 指定 Oinone 的版本号（如 `7.2.0` 或 `6.4.0`）。默认值为 `7.2.0`。
+- `--edition`: 指定要使用的 Oinone 版本（社区版/企业版）。可选值为 `community` (默认) 或 `enterprise`。
+
+**示例（创建并跳过资源下载，指定版本号及企业版）：**
+
+```shell
+oinone-frontend my-project --download-static-resource=true --oinone-version="7.2.0" --edition="enterprise"
+```
+
+当您禁用自动下载资源包时，CLI 在项目创建完成后会输出手动下载所需执行的脚本命令。
+
+### 3. 缓存管理
+
+CLI 会在系统临时目录中缓存下载过的静态资源，以加快后续项目的创建速度。您可以通过 `cache` 命令来管理这些缓存文件。
+
+**查看缓存信息：**
+```shell
+oinone-frontend cache info
+```
+
+**清理缓存：**
+```shell
+oinone-frontend cache clean
+```
+
+**缓存帮助文档：**
+您可以使用 `-h` 或 `--help` 选项来查看 `cache` 命令的专属帮助文档。
+```shell
+oinone-frontend cache -h
+```
+
+### 4. 查看帮助文档
+
+您可以使用 `-h` 或 `--help` 选项来查看 CLI 的标准帮助文档。
+
+```shell
+oinone-frontend -h
+```
+
+**输出：**
+
+```shell
+Usage: cli [options] [command]
+
+Oinone Frontend Template CLI
+
+Options:
+  -V, --version                       output the version number
+  -h, --help                          display help for command
+
+Commands:
+  cache                               Manage the local static resources cache
+  help [command]                      display help for command
+```
+
+## 卸载 `@oinone/cli`
+
+如果您需要卸载该 CLI 工具，可以运行以下命令：
+
+```shell
+npm uninstall -g @oinone/cli
+```
+
+> **注意：** 卸载 CLI **不会**自动清理存储在系统临时目录中的静态资源缓存文件。如果您希望完全移除缓存，请在卸载前执行 `oinone-frontend cache clean`，或者手动删除系统临时目录下的 `oinone-cli-cache` 文件夹。

package/bin/cli.js

@@ -0,0 +1,429 @@
+#!/usr/bin/env node
+
+const { program } = require('commander');
+const inquirer = require('inquirer');
+const fs = require('fs-extra');
+const path = require('path');
+const chalk = require('chalk');
+const ora = require('ora');
+const https = require('https');
+const os = require('os');
+const AdmZip = require('adm-zip');
+const cliProgress = require('cli-progress');
+const packageJson = require('../package.json');
+
+const downloadAndExtractZip = (url, targetDir) => {
+  return new Promise((resolve, reject) => {
+    const req = https.request(url, { method: 'HEAD' }, (headRes) => {
+      if (headRes.statusCode !== 200) {
+        reject(new Error(`Failed to fetch file info: ${headRes.statusCode}`));
+        return;
+      }
+      
+      let etag = headRes.headers['etag'];
+      if (etag) {
+        etag = etag.replace(/"/g, ''); // Clean quotes
+      } else {
+        etag = headRes.headers['last-modified'] ? Buffer.from(headRes.headers['last-modified']).toString('hex') : 'default';
+      }
+      
+      const cacheDir = path.join(os.tmpdir(), 'oinone-cli-cache');
+      fs.ensureDirSync(cacheDir);
+      
+      const cachedZipPath = path.join(cacheDir, `static-resources-${etag}.zip`);
+      
+      if (fs.existsSync(cachedZipPath)) {
+        console.log(chalk.cyan('Using cached static resources...'));
+        try {
+          const zip = new AdmZip(cachedZipPath);
+          zip.extractAllTo(targetDir, true);
+          resolve();
+        } catch (err) {
+          fs.unlinkSync(cachedZipPath);
+          reject(err);
+        }
+        return;
+      }
+
+      const file = fs.createWriteStream(cachedZipPath);
+      
+      https.get(url, (response) => {
+        if (response.statusCode !== 200) {
+          reject(new Error(`Failed to download: ${response.statusCode}`));
+          return;
+        }
+        
+        const totalBytes = parseInt(response.headers['content-length'], 10);
+        let isMB = false;
+        let totalDisplay = 0;
+        let unit = 'KB';
+        
+        if (totalBytes > 10 * 1024 * 1024) {
+          isMB = true;
+          unit = 'MB';
+          totalDisplay = (totalBytes / (1024 * 1024)).toFixed(2);
+        } else {
+          totalDisplay = Math.round(totalBytes / 1024);
+        }
+        
+        let downloadedBytes = 0;
+        let startTime = Date.now();
+        
+        const progressBar = new cliProgress.SingleBar({
+          format: chalk.cyan('Downloading ') + `[{bar}] {percentage}% | ETA: {eta}s | {value}/{total} ${unit} | Speed: {speed} {speedUnit}/s`,
+          barCompleteChar: '\u2588',
+          barIncompleteChar: '\u2591',
+          hideCursor: true,
+          forceRedraw: true
+        });
+        
+        progressBar.start(Number(totalDisplay), 0, { speed: '0.00', speedUnit: 'KB' });
+
+        response.on('data', (chunk) => {
+          downloadedBytes += chunk.length;
+          let downloadedDisplay = 0;
+          if (isMB) {
+            downloadedDisplay = Number((downloadedBytes / (1024 * 1024)).toFixed(2));
+          } else {
+            downloadedDisplay = Math.round(downloadedBytes / 1024);
+          }
+          
+          const currentTime = Date.now();
+          const elapsedSeconds = (currentTime - startTime) / 1000;
+          let speed = 0;
+          let speedUnit = 'KB';
+          
+          if (elapsedSeconds > 0) {
+            const speedInBytes = downloadedBytes / elapsedSeconds;
+            if (speedInBytes > 1024 * 1024) {
+              speed = speedInBytes / (1024 * 1024);
+              speedUnit = 'MB';
+            } else {
+              speed = speedInBytes / 1024;
+              speedUnit = 'KB';
+            }
+          }
+          
+          progressBar.update(downloadedDisplay, { speed: speed.toFixed(2), speedUnit });
+        });
+
+        response.pipe(file);
+        file.on('finish', () => {
+          progressBar.stop();
+          file.close();
+          try {
+            const zip = new AdmZip(cachedZipPath);
+            zip.extractAllTo(targetDir, true);
+            resolve();
+          } catch (err) {
+            if (fs.existsSync(cachedZipPath)) fs.unlinkSync(cachedZipPath);
+            reject(err);
+          }
+        });
+      }).on('error', (err) => {
+        if (fs.existsSync(cachedZipPath)) fs.unlink(cachedZipPath, () => {});
+        reject(err);
+      });
+    });
+
+    req.on('error', (err) => {
+      reject(err);
+    });
+    
+    req.end();
+  });
+};
+
+program
+  .version(packageJson.version)
+  .description('Oinone Frontend Template CLI')
+  .helpOption('-h, --help', 'display help for command');
+
+// Cache Command
+const cacheCmd = program
+  .command('cache')
+  .description('Manage the local static resources cache')
+  .action(() => {
+    // If just "cache" is typed without subcommands, show cache help
+    cacheCmd.help();
+  });
+
+cacheCmd
+  .command('clean')
+  .description('Clean the local static resources cache')
+  .action(() => {
+    const cacheDir = path.join(os.tmpdir(), 'oinone-cli-cache');
+    if (fs.existsSync(cacheDir)) {
+      fs.removeSync(cacheDir);
+      console.log(chalk.green(`✔ Cache cleaned successfully at ${cacheDir}`));
+    } else {
+      console.log(chalk.yellow(`Cache directory does not exist: ${cacheDir}`));
+    }
+  });
+
+cacheCmd
+  .command('info')
+  .description('Print cache directory information')
+  .action(async () => {
+    const cacheDir = path.join(os.tmpdir(), 'oinone-cli-cache');
+    console.log(chalk.cyan('Cache Directory: ') + cacheDir);
+    
+    if (fs.existsSync(cacheDir)) {
+      const files = await fs.readdir(cacheDir);
+      let totalSize = 0;
+      
+      console.log(chalk.cyan('Cached Files:'));
+      for (const file of files) {
+        const filePath = path.join(cacheDir, file);
+        const stat = await fs.stat(filePath);
+        totalSize += stat.size;
+        
+        let displaySize = '';
+        if (stat.size > 1024 * 1024) {
+          displaySize = `${(stat.size / (1024 * 1024)).toFixed(2)} MB`;
+        } else {
+          displaySize = `${Math.round(stat.size / 1024)} KB`;
+        }
+        
+        console.log(`  - ${file} (${displaySize})`);
+      }
+      
+      let totalDisplaySize = '';
+      if (totalSize > 1024 * 1024) {
+        totalDisplaySize = `${(totalSize / (1024 * 1024)).toFixed(2)} MB`;
+      } else {
+        totalDisplaySize = `${Math.round(totalSize / 1024)} KB`;
+      }
+      
+      console.log(chalk.cyan(`Total Cache Size: `) + totalDisplaySize);
+    } else {
+      console.log(chalk.yellow('Cache is currently empty.'));
+    }
+  });
+
+// Create Command (Default Behavior)
+program
+  .argument('[project-name]', 'Name of the project to create silently')
+  .option('--download-static-resource <value>', 'Download static resources (true/false)', 'true')
+  .option('--oinone-version <value>', 'Oinone version to use (e.g. 7.2.0, 6.4.0)', '7.2.0')
+  .option('--edition <value>', 'Oinone edition to use (community/enterprise)', 'community')
+  .action(async (projectNameArg, options) => {
+    // If command is 'cache', skip create logic
+    if (projectNameArg === 'cache') {
+      return;
+    }
+    
+    try {
+      let prefix;
+      let fullProjectName;
+      let oinoneVersion;
+      let edition;
+      let downloadStaticResources;
+
+      if (projectNameArg) {
+        // Remove '-frontend' suffix if it exists to form the prefix
+        prefix = projectNameArg.endsWith('-frontend') 
+          ? projectNameArg.slice(0, -9) 
+          : projectNameArg;
+        fullProjectName = projectNameArg;
+        oinoneVersion = options.oinoneVersion;
+        // Ensure oinoneVersion has a tilde prefix
+        if (!oinoneVersion.startsWith('~')) {
+          oinoneVersion = `~${oinoneVersion}`;
+        }
+        edition = options.edition;
+        downloadStaticResources = options.downloadStaticResource !== 'false';
+      } else {
+        const answers = await inquirer.prompt([
+        {
+          type: 'input',
+          name: 'companyName',
+          message: 'Please enter the company name (e.g. ss):',
+          default: 'ss',
+          validate: (input) => {
+            if (input.trim() === '') return 'Company name cannot be empty.';
+            return true;
+          },
+        },
+        {
+          type: 'input',
+          name: 'projectName',
+          message: 'Please enter the project name (e.g. oms):',
+          default: 'oms',
+          validate: (input) => {
+            if (input.trim() === '') return 'Project name cannot be empty.';
+            return true;
+          },
+        },
+        {
+          type: 'list',
+          name: 'edition',
+          message: 'Please select the Oinone edition:',
+          choices: [
+            { name: 'Community Edition (Default)', value: 'community' },
+            { name: 'Enterprise Edition', value: 'enterprise' }
+          ],
+          default: 'community'
+        },
+        {
+          type: 'list',
+          name: 'oinoneVersion',
+          message: 'Please select the Oinone version:',
+          choices: [
+            { name: '7.2.0 (Default)', value: '~7.2.0' },
+            { name: '6.4.0', value: '~6.4.0' }
+          ],
+          default: '~7.2.0'
+        },
+        {
+          type: 'confirm',
+          name: 'downloadStaticResources',
+          message: 'Do you want to download the latest static resources?',
+          default: true
+        }
+      ]);
+
+        prefix = answers.companyName;
+        fullProjectName = `${answers.companyName}-${answers.projectName}-frontend`;
+        oinoneVersion = answers.oinoneVersion;
+        edition = answers.edition;
+        downloadStaticResources = answers.downloadStaticResources;
+      }
+
+      const targetPath = path.resolve(process.cwd(), fullProjectName);
+
+      if (fs.existsSync(targetPath)) {
+        console.log(chalk.red(`\nError: Directory ${fullProjectName} already exists.\n`));
+        process.exit(1);
+      }
+
+      const spinner = ora('Creating project...').start();
+
+      const versionDir = oinoneVersion.replace(/[^0-9.]/g, ''); // Extract '7.2.0' or '6.4.0'
+      const templatePath = path.resolve(__dirname, `../template-${versionDir}-${edition}`);
+
+      if (!fs.existsSync(templatePath)) {
+        spinner.fail(chalk.red(`Template for version ${oinoneVersion} (${edition} edition) not found.`));
+        process.exit(1);
+      }
+
+      // Helper function to process files recursively
+      const processDirectory = async (dirPath) => {
+        const files = await fs.readdir(dirPath);
+        for (const file of files) {
+          const currentPath = path.join(dirPath, file);
+          const stat = await fs.stat(currentPath);
+
+          // Rename directory if it starts with 'ss-'
+          let newPath = currentPath;
+          if (file.startsWith('ss-')) {
+            const newFile = file.replace(/^ss-/, `${prefix}-`);
+            newPath = path.join(dirPath, newFile);
+            await fs.rename(currentPath, newPath);
+          }
+
+          if (stat.isDirectory()) {
+            await processDirectory(newPath);
+          } else {
+            // Check if it's a text file
+            const ext = path.extname(newPath);
+            const isTextFile = !['.png', '.ico', '.jpg', '.jpeg', '.gif'].includes(ext);
+            
+            if (isTextFile) {
+              let content = await fs.readFile(newPath, 'utf8');
+              let hasChanges = false;
+
+              // Replace 'ss-' with '${prefix}-' but avoid replacing within words
+              // We use a regex that matches 'ss-' either at the start of a string or preceded by non-word characters
+              // To prevent changing things like postcss -> postprefix
+              const regex = /(^|[^a-zA-Z])ss-/g;
+              if (regex.test(content)) {
+                content = content.replace(regex, `$1${prefix}-`);
+                hasChanges = true;
+              }
+
+              // Replace '@ss/oinone' with `@${prefix}/oinone`
+              if (content.includes('@ss/')) {
+                content = content.replace(/@ss\//g, `@${prefix}/`);
+                hasChanges = true;
+              }
+
+              if (hasChanges) {
+                await fs.writeFile(newPath, content, 'utf8');
+              }
+            }
+          }
+        }
+      };
+
+      // Copy template files
+      await fs.copy(templatePath, targetPath, {
+        filter: (src) => {
+          // Ignore node_modules just in case
+          const relativePath = path.relative(templatePath, src);
+          if (relativePath.split(path.sep).includes('node_modules')) return false;
+          return true;
+        }
+      });
+
+      // Process the copied files (rename and replace content)
+      await processDirectory(targetPath);
+
+      // Handle package.json
+      const pkgPath = path.join(targetPath, '_package.json');
+      const newPkgPath = path.join(targetPath, 'package.json');
+      if (fs.existsSync(pkgPath)) {
+        const pkgContent = await fs.readJson(pkgPath);
+        pkgContent.name = fullProjectName;
+        await fs.writeJson(newPkgPath, pkgContent, { spaces: 2 });
+        await fs.remove(pkgPath);
+      }
+
+      // Handle gitignore
+      const gitignorePath = path.join(targetPath, 'gitignore');
+      const newGitignorePath = path.join(targetPath, '.gitignore');
+      if (fs.existsSync(gitignorePath)) {
+        await fs.move(gitignorePath, newGitignorePath);
+      }
+
+      // Handle npmrc
+      const npmrcPath = path.join(targetPath, 'npmrc');
+      const newNpmrcPath = path.join(targetPath, '.npmrc');
+      if (fs.existsSync(npmrcPath)) {
+        await fs.move(npmrcPath, newNpmrcPath);
+      }
+
+      if (downloadStaticResources) {
+        spinner.succeed(chalk.green('Project structure created successfully!'));
+        console.log(chalk.cyan('Downloading static resources...'));
+        try {
+          const ossDir = path.join(targetPath, 'packages', `${prefix}-boot`, 'public', 'oss');
+          await fs.ensureDir(ossDir);
+          await downloadAndExtractZip('https://pamirs.oss-cn-hangzhou.aliyuncs.com/oinone/installer/static-resources.zip', ossDir);
+          console.log(chalk.green('✔ Static resources downloaded successfully!'));
+        } catch (err) {
+          console.log(chalk.yellow(`⚠️ Project created, but failed to download static resources: ${err.message}`));
+        }
+      } else {
+        spinner.succeed(chalk.green('Project created successfully!'));
+        const relativeOssDir = `packages/${prefix}-boot/public/oss`;
+        console.log(chalk.yellow(`\n⚠️  You chose not to download static resources automatically.`));
+        console.log(chalk.yellow(`Please download and extract them manually before running the project:`));
+        console.log(chalk.cyan(`  mkdir -p ${fullProjectName}/${relativeOssDir}`));
+        console.log(chalk.cyan(`  curl -L https://pamirs.oss-cn-hangzhou.aliyuncs.com/oinone/installer/static-resources.zip -o static-resources.zip`));
+        console.log(chalk.cyan(`  unzip static-resources.zip -d ${fullProjectName}/${relativeOssDir}`));
+        console.log(chalk.cyan(`  rm static-resources.zip`));
+      }
+
+      console.log(`\nTo get started:\n`);
+      console.log(chalk.cyan(`  cd ${fullProjectName}`));
+      console.log(chalk.cyan(`  pnpm install`));
+      console.log(chalk.cyan(`  pnpm run dev\n`));
+
+    } catch (error) {
+      console.error(chalk.red(`\nAn error occurred: ${error.message}\n`));
+      process.exit(1);
+    }
+  });
+
+program.parse(process.argv);

package/package.json

@@ -0,0 +1,25 @@
+{
+  "name": "@oinone/cli",
+  "version": "7.2.1",
+  "description": "CLI tool to generate Oinone Frontend Template",
+  "main": "index.js",
+  "bin": {
+    "oinone-frontend": "./bin/cli.js"
+  },
+  "scripts": {
+    "test": "echo \"Error: no test specified\" && exit 1"
+  },
+  "keywords": [],
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "adm-zip": "^0.5.17",
+    "chalk": "^4.1.2",
+    "cli-progress": "^3.12.0",
+    "commander": "^14.0.3",
+    "ejs": "^5.0.2",
+    "fs-extra": "^11.3.4",
+    "inquirer": "^8.2.6",
+    "ora": "^5.4.1"
+  }
+}

package/template-6.4.0-community/.eslintignore

@@ -0,0 +1,5 @@
+integration/*
+templates/*
+**/__test__/**/*
+**/*.test.[tj]s?(x)
+link-vls.js