Merge pull request #28 from beezen/dev

chore: 优化预处理函数执行顺序&文档内容优化

CHANGELOG.md

@@ -2,6 +2,8 @@
 
 All notable changes to this project will be documented in this file. See [standard-version](https://github.com/conventional-changelog/standard-version) for commit guidelines.
 
+### [1.11.1](https://github.com/beezen/nucm/compare/v1.11.0...v1.11.1) (2024-04-16)
+
 ## [1.11.0](https://github.com/beezen/nucm/compare/v1.10.1...v1.11.0) (2024-04-10)
 
 

README.md

@@ -45,7 +45,7 @@ Options:
 
 Commands:
   ls [options]                查看账号列表
-  use <name>                  切换账号
+  use [options] <name>        切换账号
   add <name> <access-tokens>  添加账号
   del <name>                  移除账号
   localize <lang>             使用本地化语言

README_EN.md

@@ -44,7 +44,7 @@ Options:
 
 Commands:
   ls [options]                show account list
-  use <name>                  switch account
+  use [options] <name>        switch account
   add <name> <access-tokens>  add account
   del <name>                  remove account
   localize|language <lang>    use localized languages

coverage/clover.xml

@@ -1,6 +1,6 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<coverage generated="1712751080157" clover="3.2.0">
-  <project timestamp="1712751080157" name="All files">
+<coverage generated="1713247743331" clover="3.2.0">
+  <project timestamp="1713247743331" name="All files">
     <metrics statements="192" coveredstatements="173" conditionals="96" coveredconditionals="59" methods="25" coveredmethods="24" elements="313" coveredelements="256" complexity="0" loc="192" ncloc="192" packages="4" files="5" classes="5"/>
     <package name="actions">
       <metrics statements="66" coveredstatements="60" conditionals="27" coveredconditionals="16" methods="8" coveredmethods="8"/>

docs/README.md

@@ -8,24 +8,24 @@ NUCM 的全称为 NPM User Change Manager，是一款高效而直观的 NPM 账
 
 ![An image](./static/nucm.gif)
 
-**主要特性包括：**
+## **主要特性包括：**
 
-1. 快速账号切换： 使用"NPM User Change Manager"，用户可以通过简单的命令或图形界面迅速切换到他们的不同 NPM 账号，无需反复输入认证信息。
+1. **快速账号切换**： 使用"NPM User Change Manager"，用户可以通过简单的命令或图形界面迅速切换到他们的不同 NPM 账号，无需反复输入认证信息。
 
-2. 账号配置管理： 支持灵活的账号配置，用户可以保存和管理多个 NPM 账号的配置信息，以便在需要时方便地切换。
+2. **账号配置管理**： 支持灵活的账号配置，用户可以保存和管理多个 NPM 账号的配置信息，以便在需要时方便地切换。
 
-3. 命令行和图形用户界面： 提供命令行工具图形用户界面，满足不同用户的使用偏好，使切换账号变得轻松而灵活。
+3. **命令行和图形用户界面**： 提供命令行工具图形用户界面，满足不同用户的使用偏好，使切换账号变得轻松而灵活。
 
-4. 安全性和隐私："NPM User Change Manager"采用安全的认证方式，并确保用户的敏感信息得到妥善保护，提供了安全可靠的账号管理环境。
+4. **安全性和隐私**："NPM User Change Manager"采用安全的认证方式，并确保用户的敏感信息得到妥善保护，提供了安全可靠的账号管理环境。
 
-**NUCM 工具的主要用户群体包括：**
+## **NUCM 工具的主要用户群体包括：**
 
 - 经常遗忘 NPM 账号和密码的开发者
 - 需要频繁切换多个 NPM 账号的开发者
 
-**简易操作指南**
+## **简易操作指南**
 
-NUCM 是一个基于 NPM Access Tokens 机制的账号切换管理工具，它的使用步骤简单易行：
+NUCM 是一个基于 NPM [Access Tokens](more.html#获取-access-token-账号) 机制实现的账号切换管理工具，它的使用步骤简单易懂：
 
 1、添加账号
 

docs/add.md

@@ -4,26 +4,16 @@ title: nucm add 添加账号
 
 # 添加账号
 
-通过添加本地账号（Access Tokens）并设置别名，轻松管理 NPM 账号切换。
+通过添加本地账号（Access Tokens）并设置别名，轻松管理 NPM 账号切换。[点击查看 access-tokens 获取方式](more.html#获取-access-token-账号)
 
 ## 命令
 
 ```bash
 $ nucm add <name> <access-tokens>
 ```
 
-## 配置
+## 参数
 
-`name`
+- `name`：账号别名。为 Access Tokens 账号设置一个易于识别的别名，方便后续账号查找和切换。
 
-- Default: null
-- Required: true
-
-账号别名。为 Access Tokens 账号设置一个易于识别的别名，方便后续账号查找和切换。
-
-`access-tokens`
-
-- Default: null
-- Required: true
-
-NPM 的 Access Tokens 账号。[点击查看 access-tokens 获取方式](start.html#获取-access-token-账号)
+- `access-tokens`：NPM 的 Access Tokens 账号。

docs/del.md

@@ -12,11 +12,6 @@ title: nucm del 移除账号
 $ nucm del <name>
 ```
 
-## 配置
+## 参数
 
-`name`
-
-- Default: null
-- Required: true
-
-账号别名。工具会根据账号别名删除对应的 Access Tokens 账号。
+- `name`：账号别名。工具会根据账号别名删除对应的 Access Tokens 账号。

docs/list.md

@@ -12,37 +12,61 @@ title: nucm ls 查看账号
 $ nucm ls [options]
 ```
 
-## 配置
+## 参数
 
-`options`
+- `options`：可选参数
 
-- Default: null。可选参数：`'-l'` | `'-a'` | `'-al'`
-- Required: false
+| 选项          | 描述                           |
+| ------------- | ------------------------------ |
+| `-l`,`--list` | 明文显示账号详细信息           |
+| `-a`,`--all`  | 脱敏显示所有注册源下的账号列表 |
 
-`options` 表示查看账号列表的详细配置参数。它为空时，显示账号列表（脱敏）；它为 `-l` 时，显示账号详细信息（非脱敏）；它为 `-a` 时，显示所有注册源下的账号列表（脱敏）；它为 `-al` 时，显示所有注册源下的账号列表（非脱敏）。
-
-## 详细
+## 示例
 
 1、仅查看当前源下的账号列表，且账号都脱敏显示
 
 ```bash
 $ nucm ls
+
+【taobao】
+* test01 ------------- ......56789
 ```
 
 2、仅查看当前源下的账号列表，且账号都完整显示（请注意保护自己的账号）
 
 ```bash
 $ nucm ls -l #或 --list
+
+【taobao】
+* test01 ------------- 123456789
 ```
 
 3、查看所有注册源下的账号列表，且账号都脱敏显示
 
 ```bash
 $ nucm ls -a #或 --all
+
+【npm】
+* test01 ------------- ......56789
+
+【cnpm】
+* test01 ------------- ......56789
+
+【artifactory】
+* test01 ------------- ......56789
 ```
 
 4、查看所有注册源下的账号列表，且账号都完整显示（请注意保护自己的账号）
 
 ```bash
 $ nucm ls -al #或 --all --list
+
+【npm】
+* test01 ------------- 123456789
+
+【cnpm】
+* test01 ------------- 123456789
+
+【artifactory】
+* test01 ------------- 123456789
 ```

docs/localize.md

@@ -12,16 +12,11 @@ title: nucm localize 切换语言
 $ nucm localize <lang>
 ```
 
-## 配置
+## 参数
 
-`lang`
+- `lang`：工具显示语言 `en` or `cn`，默认 `cn`。`en` 表示英文，`cn` 表示中文。
 
-- Default: null。可选参数：`'en'` | `'cn'`
-- Required: true
-
-工具语言。`en` 表示英文，`cn` 表示中文。
-
-## 详细
+## 示例
 
 1、切换英文版本
 

docs/more.md

@@ -8,7 +8,7 @@ title: 了解更多...
 
 欢迎任何形式的贡献，不管是一个错别字的修改，还是一次友好的建议，不管是通过提交 [Issue](https://github.com/beezen/nucm/issues), 还是一个帅气 [pull request](https://github.com/beezen/nucm/pulls)。
 
-## NPM auth related configuration
+## NPM 账号关联配置
 
 The settings `_auth`, `_authToken`, `username` and `_password` must all be scoped to a specific registry. This ensures that `npm` will never send credentials to the wrong host.
 
@@ -22,6 +22,31 @@ The full list is:
 - `certfile` (path to certificate file)
 - `keyfile` (path to key file)
 
+## 获取 Access Token 账号
+
+1、[NPM 官网](https://www.npmjs.com/)登录个人账号，在页面的右上角，单击“配置文件”图片，然后单击“访问令牌”
+
+![An image](./static/tokens-profile.png)
+
+2、单击生成新的标记。
+![An image](./static/create-token.png)
+
+3、命名您的令牌。
+
+4、选择访问令牌的类型（一般选 Publish,具体查看文档说明）
+
+![An image](./static/token-level-select.png)
+
+5、点击生成令牌。
+
+6、从页面顶部复制令牌（access-tokens）。
+
+> Access Tokens:
+> An access token is an alternative to using your username and password for authenticating to npm when using the API or the npm command-line interface (CLI). An access token is a hexadecimal string that you can use to authenticate, and which gives you the right to install and/or publish your modules.
+
+> 中文翻译：
+> 访问令牌是使用 API 或 NPM 命令行界面（CLI）时使用您的用户名和密码进行身份验证到 NPM 的替代方案。访问令牌是您可以用于身份验证的十六进制字符串，并为您提供安装和/或发布模块的权利。
+
 ## 参考链接
 
 - [npmrc](https://docs.npmjs.com/cli/v9/configuring-npm/npmrc)

docs/registry.md

@@ -12,53 +12,18 @@ title: nucm registry 镜像源操作
 $ nucm registry <cmd...>
 ```
 
-## `cmd...` 变长参数
+## 参数
 
-### `ls`
+- `cmd...`：变长参数，代表子命令集合。
 
-查看镜像源列表。
+| 子命令             | 描述                                                         |
+| ------------------ | ------------------------------------------------------------ |
+| `ls`               | 查看镜像源列表。                                             |
+| `add <name> <url>` | 添加镜像源和别名。`name`：镜像源的别名， `url`：镜像源的地址 |
+| `use <name>`       | 切换当前镜像源。`name`：镜像源的别名。                       |
+| `del <name>`       | 删除指定镜像源。`name`：镜像源的别名。                       |
 
-### `add <name> <url>`
-
-添加镜像源和别名。
-
-`name`
-
-- Default: null
-- Required: true
-
-镜像源的别名
-
-`url`
-
-- Default: null
-- Required: true
-
-镜像源的地址
-
-### `use <name>`
-
-切换当前镜像源。
-
-`name`
-
-- Default: null
-- Required: true
-
-镜像源的别名
-
-### `del <name>`
-
-删除指定镜像源。
-
-`name`
-
-- Default: null
-- Required: true
-
-镜像源的别名
-
-## 详细
+## 示例
 
 1、查看当前镜像源列表
 

docs/save.md

@@ -12,7 +12,7 @@ title: nucm save 保存账号
 $ nucm save
 ```
 
-## 详细
+## 示例
 
 1、保存当前用户账号，提示输入账号别名（默认为随机名称）