@oinone/cli 7.2.5 → 7.2.7

package/README.md

@@ -1,115 +1,144 @@
-# Quick Start
+# Oinone Frontend CLI
 
-Read this in [中文](README_zh-CN.md).
+CLI scaffolding tool to generate Oinone frontend projects.
 
-## Global Installation of `@oinone/cli`
+- Package: `@oinone/cli`
+- Binary: `oinone-frontend`
+- 中文文档: [README_zh-CN.md](./README_zh-CN.md)
 
-```shell
-npm install -g @oinone/cli
-```
+## Features
 
-## Create Frontend Project
+- Interactive project scaffolding with sensible defaults
+- Non-interactive (CI-friendly) mode via CLI options
+- Optional enterprise registry credential file generation
+- Static resource cache management via `cache`
+- Environment check via `doctor`
 
-Create a frontend project in any directory. We provide two modes: interactive creation and silent creation.
+## Requirements
 
-### 1. **Interactive Creation**
+- Node.js to run the CLI
+- pnpm is recommended for installing dependencies in the generated project
 
-Follow the prompts to enter the company abbreviation, project name, select the Oinone edition, version, and whether to download the latest static resources.
+## Installation
 
-```shell
-oinone-frontend
+```bash
+npm install -g @oinone/cli
 ```
 
-**Example:**
+Or run with `npx`:
 
-```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
+```bash
+npx @oinone/cli create my-project
+```
 
-✔ Project created successfully!
+## Usage
 
-To get started:
+### Quick create (recommended)
 
-  cd ss-oms-frontend
-  pnpm install
-  pnpm run dev
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community
 ```
 
-### 2. Silent Creation
+```bash
+oinone-frontend create my-project-enterprise --oinone-version 7.2.0 --edition enterprise --auth-token <token> --write-project-credential
+```
 
-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`.
+### More examples
 
-```shell
-oinone-frontend <project-name>
-```
+Create project (interactive):
 
-**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`.
+```bash
+oinone-frontend create
+```
 
-**Example (Create, skip resource download, and specify version number and edition):**
+Create project (non-interactive):
 
-```shell
-oinone-frontend my-project --download-static-resource=true --oinone-version="7.2.0" --edition="enterprise"
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community
 ```
 
-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.
+Create project with `--company-name` / `--project-name`:
 
-### 3. Cache Management
+```bash
+oinone-frontend create --company-name ss --project-name oms --oinone-version 7.2.0 --edition community
+```
 
-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.
+Dry-run (no files written):
 
-**View Cache Information:**
-```shell
-oinone-frontend cache info
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community --dry-run
 ```
 
-**Clean Cache:**
-```shell
-oinone-frontend cache clean
+Create project (Oinone `6.4.*`):
+
+```bash
+oinone-frontend create my-project-64 --oinone-version 6.4.0 --edition community
 ```
 
-**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
+### Check environment
+
+```bash
+oinone-frontend doctor --oinone-version 7.2.0
 ```
 
-### 4. Help Command
+## Command reference
 
-You can use the `-h` or `--help` option to view the CLI's standard help documentation.
+### Global options
 
-```shell
-oinone-frontend -h
-```
+| Option | Description |
+| --- | --- |
+| `-l, --lang <lang>` | Language (`zh-CN` or `en-US`) |
+| `-v, --version` | Print version |
+| `-h, --help` | Show help |
 
-**Output:**
+### `oinone-frontend create [projectName]`
 
-```shell
-Usage: cli [options] [command]
+| Option | Description |
+| --- | --- |
+| `--company-name <name>` | Company/organization name (silent mode) |
+| `--project-name <name>` | Project name (silent mode) |
+| `--download-static-resource <boolean>` | Download static resources (`true`/`false`) |
+| `-o, --oinone-version <version>` | Oinone version (e.g. `7.2.0`, `6.4.0`) |
+| `-e, --edition <edition>` | Edition (`community`, `enterprise`) |
+| `--auth-token <token>` | Enterprise registry auth token (optional) |
+| `--write-project-credential` | Write `.npmrc` into the project and auto-add to `.gitignore` |
+| `-f, --force` | Overwrite/merge into existing directory |
+| `-d, --dry-run` | Dry-run (no files written) |
 
-Oinone Frontend Template CLI
+### `oinone-frontend doctor`
 
-Options:
-  -V, --version                       output the version number
-  -h, --help                          display help for command
+| Option | Description |
+| --- | --- |
+| `-o, --oinone-version <version>` | Oinone version to validate against (`6.4.*` or `7.2+`) |
 
-Commands:
-  cache                               Manage the local static resources cache
-  help [command]                      display help for command
-```
+### `oinone-frontend cache`
+
+| Command | Description |
+| --- | --- |
+| `cache info` | Print cache directory information |
+| `cache clean` | Clean cached static resources |
+
+## Enterprise credentials
+
+When `--write-project-credential` is enabled for enterprise edition, the CLI writes `.npmrc` into the project directory and appends it to `.gitignore`.
+
+## Template mapping
 
-## Uninstall `@oinone/cli`
+- `6.4.*` → `template-6.4.0`
+- `7.2+` → `template-7.2.0`
 
-If you need to uninstall the CLI tool, you can run the following command:
+Unsupported versions fail fast.
 
-```shell
-npm uninstall -g @oinone/cli
+## Notes
+
+Uninstalling the CLI does not remove cached static resources. To clean the cache:
+
+```bash
+oinone-frontend cache clean
 ```
 
-> **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.
+## Development
+
+```bash
+npm test
+```

package/README_zh-CN.md

@@ -1,115 +1,144 @@
-# 快速开始
+# Oinone Frontend CLI
 
-Read this in [English](README.MD).
+用于生成 Oinone 前端工程的脚手架 CLI。
 
-## 全局安装 `@oinone/cli`
+- 包名：`@oinone/cli`
+- 命令：`oinone-frontend`
+- English: [README.md](./README.md)
 
-``` shell
-npm install -g @oinone/cli
-```
+## 功能特性
 
-## 创建前端工程
+- 交互式创建工程，内置默认值与合理校验
+- 支持参数静默创建（适用于 CI/CD）
+- 企业版可选生成仓库凭证文件
+- 提供 `cache` 静态资源缓存管理
+- 提供 `doctor` 环境检查
 
-在任意目录下创建前端工程。我们提供了交互式创建和静默创建两种模式。
+## 环境要求
 
-### 1. 交互式创建
+- 运行 CLI：Node.js
+- 安装生成的前端工程依赖：建议使用 pnpm
 
-根据提示输入公司简称, 项目名称、选择 Oinone 版本（社区/企业）、版本号以及是否下载最新静态资源包即可。
+## 安装
 
-``` shell
-oinone-frontend
+```bash
+npm install -g @oinone/cli
 ```
 
-**示例：**
+或使用 `npx`：
 
-``` 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
+```bash
+npx @oinone/cli create my-project
+```
 
-✔ Project created successfully!
+## 使用
 
-To get started:
+### 快速创建（推荐）
 
-  cd ss-oms-frontend
-  pnpm install
-  pnpm run dev
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community
 ```
 
-### 2. 静默创建
+```bash
+oinone-frontend create my-project-enterprise --oinone-version 7.2.0 --edition enterprise --auth-token <token> --write-project-credential
+```
 
-如果您希望跳过交互步骤快速创建工程，可以直接在命令后追加项目名称。静默创建时，项目中的子包及文件前缀将默认使用该项目名称，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`。
+```bash
+oinone-frontend create
+```
 
-**示例（创建并跳过资源下载，指定版本号及企业版）：**
+创建项目（静默式）：
 
-```shell
-oinone-frontend my-project --download-static-resource=true --oinone-version="7.2.0" --edition="enterprise"
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community
 ```
 
-当您禁用自动下载资源包时，CLI 在项目创建完成后会输出手动下载所需执行的脚本命令。
+使用 `--company-name` / `--project-name` 创建：
 
-### 3. 缓存管理
+```bash
+oinone-frontend create --company-name ss --project-name oms --oinone-version 7.2.0 --edition community
+```
 
-CLI 会在系统临时目录中缓存下载过的静态资源，以加快后续项目的创建速度。您可以通过 `cache` 命令来管理这些缓存文件。
+演练模式（不落盘）：
 
-**查看缓存信息：**
-```shell
-oinone-frontend cache info
+```bash
+oinone-frontend create my-project --oinone-version 7.2.0 --edition community --dry-run
 ```
 
-**清理缓存：**
-```shell
-oinone-frontend cache clean
+创建工程（Oinone `6.4.*`）：
+
+```bash
+oinone-frontend create my-project-64 --oinone-version 6.4.0 --edition community
 ```
 
-**缓存帮助文档：**
-您可以使用 `-h` 或 `--help` 选项来查看 `cache` 命令的专属帮助文档。
-```shell
-oinone-frontend cache -h
+### 检查环境
+
+```bash
+oinone-frontend doctor --oinone-version 7.2.0
 ```
 
-### 4. 查看帮助文档
+## 命令参考
 
-您可以使用 `-h` 或 `--help` 选项来查看 CLI 的标准帮助文档。
+### 全局参数
 
-```shell
-oinone-frontend -h
-```
+| 参数 | 说明 |
+| --- | --- |
+| `-l, --lang <lang>` | 语言（`zh-CN` / `en-US`） |
+| `-v, --version` | 输出版本号 |
+| `-h, --help` | 输出帮助 |
 
-**输出：**
+### `oinone-frontend create [projectName]`
 
-```shell
-Usage: cli [options] [command]
+| 参数 | 说明 |
+| --- | --- |
+| `--company-name <name>` | 静默模式：公司/组织简称 |
+| `--project-name <name>` | 静默模式：项目名；与 `--company-name` 同用时目录名为 `{company}-{project}-frontend` |
+| `--download-static-resource <boolean>` | 是否下载静态资源（`true` / `false`） |
+| `-o, --oinone-version <version>` | Oinone 版本（例如 `7.2.0` / `6.4.0`） |
+| `-e, --edition <edition>` | 版本类型（`community` / `enterprise`） |
+| `--auth-token <token>` | 企业版仓库 auth token（可选） |
+| `--write-project-credential` | 在项目目录写入 `.npmrc` 并自动加入 `.gitignore` |
+| `-f, --force` | 目标目录存在时覆盖/合并 |
+| `-d, --dry-run` | 演练模式：不落盘 |
 
-Oinone Frontend Template CLI
+### `oinone-frontend doctor`
 
-Options:
-  -V, --version                       output the version number
-  -h, --help                          display help for command
+| 参数 | 说明 |
+| --- | --- |
+| `-o, --oinone-version <version>` | 用于校验的 Oinone 版本（仅支持 `6.4.*` 与 `7.2+`） |
 
-Commands:
-  cache                               Manage the local static resources cache
-  help [command]                      display help for command
-```
+### `oinone-frontend cache`
+
+| 命令 | 说明 |
+| --- | --- |
+| `cache info` | 打印缓存目录信息 |
+| `cache clean` | 清理缓存的静态资源 |
+
+## 企业版凭证
+
+当企业版创建时启用 `--write-project-credential`，CLI 会在项目目录写入 `.npmrc`，并把它追加到 `.gitignore`。
+
+## 模板映射
 
-## 卸载 `@oinone/cli`
+- `6.4.*` → `template-6.4.0`
+- `7.2+` → `template-7.2.0`
 
-如果您需要卸载该 CLI 工具，可以运行以下命令：
+不支持的版本会直接报错。
 
-```shell
-npm uninstall -g @oinone/cli
+## 备注
+
+卸载 CLI 不会清理系统临时目录中的静态资源缓存。如需清理：
+
+```bash
+oinone-frontend cache clean
 ```
 
-> **注意：** 卸载 CLI **不会**自动清理存储在系统临时目录中的静态资源缓存文件。如果您希望完全移除缓存，请在卸载前执行 `oinone-frontend cache clean`，或者手动删除系统临时目录下的 `oinone-cli-cache` 文件夹。
+## 开发
+
+```bash
+npm test
+```