cocos-obfuscator 1.0.0

package/README/GITEE.md

@@ -0,0 +1,331 @@
+# 使用 Gitee 托管和安装
+
+## ⚠️ 重要说明
+
+**Gitee 目前不支持 npm 包托管功能**，但可以通过以下方式使用：
+
+1. ✅ **从 Gitee Git 仓库直接安装**（推荐）
+2. ✅ **使用其他私有 npm 仓库**（如 Verdaccio、GitLab 等）
+
+---
+
+## 方法一：从 Gitee Git 仓库安装（推荐）
+
+这是最简单的方法，直接将代码推送到 Gitee，然后从 Git 仓库安装。
+
+### 步骤 1：推送到 Gitee
+
+```bash
+# 在 cocos-obfuscator 目录初始化 Git（如果还没有）
+cd cocos-obfuscator
+git init
+
+# 添加文件
+git add .
+
+# 提交
+git commit -m "Initial commit: Cocos Obfuscator"
+
+# 在 Gitee 上创建仓库，然后添加远程仓库
+git remote add origin https://gitee.com/your-username/cocos-obfuscator.git
+
+# 推送代码
+git push -u origin master
+```
+
+### 步骤 2：在其他项目中安装
+
+#### 公开仓库
+
+```bash
+npm install git+https://gitee.com/your-username/cocos-obfuscator.git
+```
+
+或在 `package.json` 中：
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git"
+  }
+}
+```
+
+#### 私有仓库（需要认证）
+
+**方式 A：使用 HTTPS + 用户名密码**
+
+```bash
+npm install git+https://username:password@gitee.com/your-username/cocos-obfuscator.git
+```
+
+**方式 B：使用 SSH（推荐）**
+
+```bash
+npm install git+ssh://git@gitee.com/your-username/cocos-obfuscator.git
+```
+
+或在 `package.json` 中：
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+ssh://git@gitee.com/your-username/cocos-obfuscator.git"
+  }
+}
+```
+
+**方式 C：使用 Gitee Token**
+
+1. 在 Gitee 生成访问令牌：设置 → 安全设置 → 私人令牌
+2. 使用令牌安装：
+
+```bash
+npm install git+https://your-token@gitee.com/your-username/cocos-obfuscator.git
+```
+
+### 步骤 3：指定版本或分支
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git#v1.0.0",
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git#develop"
+  }
+}
+```
+
+### 步骤 4：使用
+
+```bash
+# 安装后使用
+npx cocos-obfuscate
+
+# 或在 package.json 中添加脚本
+npm run obfuscate
+```
+
+---
+
+## 方法二：使用私有 npm 仓库
+
+如果 Gitee 不支持，可以使用其他私有 npm 仓库方案：
+
+### 方案 A：Verdaccio（自建私有 npm 仓库）
+
+#### 1. 安装 Verdaccio
+
+```bash
+npm install -g verdaccio
+```
+
+#### 2. 启动 Verdaccio
+
+```bash
+verdaccio
+```
+
+默认运行在 `http://localhost:4873`
+
+#### 3. 配置 npm 使用 Verdaccio
+
+```bash
+npm config set registry http://localhost:4873
+```
+
+#### 4. 发布包
+
+```bash
+cd cocos-obfuscator
+npm publish
+```
+
+#### 5. 在其他项目中安装
+
+```bash
+npm install cocos-obfuscator
+```
+
+### 方案 B：GitLab Package Registry
+
+如果团队使用 GitLab：
+
+#### 1. 配置 .npmrc
+
+在 `cocos-obfuscator` 目录创建 `.npmrc`：
+
+```
+@your-scope:registry=https://gitlab.com/api/v4/packages/npm/
+//gitlab.com/api/v4/packages/npm/:_authToken=${CI_JOB_TOKEN}
+```
+
+#### 2. 更新 package.json
+
+```json
+{
+  "name": "@your-scope/cocos-obfuscator",
+  "publishConfig": {
+    "@your-scope:registry": "https://gitlab.com/api/v4/projects/YOUR_PROJECT_ID/packages/npm/"
+  }
+}
+```
+
+#### 3. 发布
+
+```bash
+npm publish
+```
+
+### 方案 C：华为云 CodeArts Artifact
+
+#### 1. 创建 npm 私有仓库
+
+在华为云 CodeArts 中创建 npm 私有仓库
+
+#### 2. 配置认证
+
+```bash
+npm config set registry https://your-registry-url
+npm login --registry=https://your-registry-url
+```
+
+#### 3. 发布
+
+```bash
+cd cocos-obfuscator
+npm publish
+```
+
+---
+
+## 方法三：使用 Gitee + npm link（本地开发）
+
+适合本地开发，结合 Gitee 做版本控制：
+
+### 步骤 1：克隆到本地
+
+```bash
+git clone https://gitee.com/your-username/cocos-obfuscator.git
+cd cocos-obfuscator
+npm install
+npm link
+```
+
+### 步骤 2：在其他项目中使用
+
+```bash
+cd /path/to/your/project
+npm link cocos-obfuscator
+```
+
+---
+
+## 推荐方案对比
+
+| 方案 | 优点 | 缺点 | 适用场景 |
+|------|------|------|----------|
+| **Gitee Git 安装** | 简单，无需额外服务 | 安装较慢，无版本管理 | 小团队，私有项目 |
+| **Verdaccio** | 完全控制，快速 | 需要服务器，需维护 | 大团队，企业内网 |
+| **GitLab Package** | 集成 GitLab，功能完善 | 需要 GitLab 服务 | 使用 GitLab 的团队 |
+| **华为云 CodeArts** | 国内访问快，企业级 | 需要付费（部分功能） | 企业用户 |
+
+---
+
+## 完整示例：从 Gitee 安装
+
+### 1. 在 Gitee 创建仓库
+
+- 仓库名：`cocos-obfuscator`
+- 设置为私有（如果需要）
+
+### 2. 推送代码
+
+```bash
+cd cocos-obfuscator
+git init
+git add .
+git commit -m "Initial commit"
+git remote add origin https://gitee.com/your-username/cocos-obfuscator.git
+git push -u origin master
+```
+
+### 3. 在其他项目中安装
+
+创建或编辑 `package.json`：
+
+```json
+{
+  "name": "my-game",
+  "version": "1.0.0",
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git"
+  },
+  "scripts": {
+    "obfuscate": "cocos-obfuscate"
+  }
+}
+```
+
+### 4. 安装和使用
+
+```bash
+npm install
+npm run obfuscate
+```
+
+---
+
+## 私有仓库认证配置
+
+### 使用 .npmrc 文件（推荐）
+
+在项目根目录创建 `.npmrc`：
+
+```
+@gitee:registry=https://gitee.com/api/v4/packages/npm/
+//gitee.com/api/v4/packages/npm/:_authToken=YOUR_TOKEN
+```
+
+**注意**：Gitee 目前不支持 npm registry，此方法仅适用于其他支持 npm 的 Git 服务（如 GitLab）。
+
+---
+
+## 常见问题
+
+### Q: Gitee 支持 npm 包托管吗？
+
+A: 目前不支持。但可以从 Git 仓库直接安装。
+
+### Q: 如何更新从 Git 安装的包？
+
+A: 
+
+```bash
+npm update cocos-obfuscator
+# 或
+npm install git+https://gitee.com/your-username/cocos-obfuscator.git
+```
+
+### Q: 可以指定版本吗？
+
+A: 可以，使用 Git 标签：
+
+```bash
+# 在 cocos-obfuscator 仓库中打标签
+git tag v1.0.0
+git push origin v1.0.0
+
+# 在其他项目中安装指定版本
+npm install git+https://gitee.com/your-username/cocos-obfuscator.git#v1.0.0
+```
+
+### Q: 私有仓库如何认证？
+
+A: 使用 SSH 密钥或访问令牌（Token）。
+
+---
+
+## 总结
+
+虽然 Gitee 不支持 npm 包托管，但**从 Git 仓库安装是最简单可行的方案**。对于需要完整 npm 仓库功能的团队，建议使用 Verdaccio 或其他支持 npm 的 Git 服务。
+

package/README/INSTALL.md

@@ -0,0 +1,261 @@
+# 在其他项目中使用 Cocos Obfuscator
+
+## 方法一：使用 npm link（推荐 - 适合本地开发）
+
+这是最简单的方法，适合在本地开发时使用。
+
+### 步骤 1：在当前项目中链接包
+
+```bash
+# 进入 cocos-obfuscator 目录
+cd cocos-obfuscator
+
+# 创建全局链接
+npm link
+```
+
+### 步骤 2：在其他项目中使用
+
+```bash
+# 进入你的其他 Cocos Creator 项目
+cd /path/to/your/other/project
+
+# 链接到全局包
+npm link cocos-obfuscator
+```
+
+### 步骤 3：使用命令
+
+```bash
+# 交互式选择模式
+cocos-obfuscate
+
+# 或使用命令行参数
+cocos-obfuscate --platform bytedance
+cocos-obfuscate --platform wechatgame --include-subpackages
+```
+
+---
+
+## 方法二：从本地路径安装（推荐 - 适合团队使用）
+
+如果你的项目在同一个机器或共享目录中，可以直接从路径安装。
+
+### 步骤 1：在其他项目的 package.json 中添加依赖
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "file:../cocos-obfuscator"
+  }
+}
+```
+
+**注意**：`../cocos-obfuscator` 是相对于其他项目的路径，请根据实际情况调整。
+
+### 步骤 2：安装依赖
+
+```bash
+cd /path/to/your/other/project
+npm install
+```
+
+### 步骤 3：使用命令
+
+```bash
+# 使用 npx 运行
+npx cocos-obfuscate
+
+# 或在 package.json 中添加脚本
+```
+
+在 `package.json` 中添加：
+
+```json
+{
+  "scripts": {
+    "obfuscate": "cocos-obfuscate",
+    "obfuscate:bytedance": "cocos-obfuscate --platform bytedance",
+    "obfuscate:wechat": "cocos-obfuscate --platform wechatgame --include-subpackages"
+  }
+}
+```
+
+然后运行：
+
+```bash
+npm run obfuscate
+```
+
+---
+
+## 方法三：发布到私有 npm 仓库（适合团队协作）
+
+如果你的团队有私有 npm 仓库（如 npmjs.com、GitLab Package Registry、GitHub Packages 等）。
+
+### 步骤 1：发布包
+
+```bash
+cd cocos-obfuscator
+
+# 登录 npm（如果是私有仓库，需要配置 registry）
+npm login
+
+# 发布包
+npm publish
+```
+
+### 步骤 2：在其他项目中安装
+
+```bash
+cd /path/to/your/other/project
+npm install cocos-obfuscator --save-dev
+```
+
+### 步骤 3：使用
+
+```bash
+npx cocos-obfuscate
+```
+
+---
+
+## 方法四：从 Git 仓库安装（适合版本控制，支持 Gitee）
+
+如果包在 Git 仓库中（包括 Gitee、GitHub、GitLab 等），可以直接从 Git 安装。
+
+### 步骤 1：推送到 Git 仓库（如 Gitee）
+
+```bash
+cd cocos-obfuscator
+git init
+git add .
+git commit -m "Initial commit"
+git remote add origin https://gitee.com/your-username/cocos-obfuscator.git
+git push -u origin master
+```
+
+### 步骤 2：在其他项目的 package.json 中添加
+
+**Gitee 公开仓库：**
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://gitee.com/your-username/cocos-obfuscator.git"
+  }
+}
+```
+
+**Gitee 私有仓库（使用 SSH）：**
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+ssh://git@gitee.com/your-username/cocos-obfuscator.git"
+  }
+}
+```
+
+**GitHub/GitLab：**
+
+```json
+{
+  "devDependencies": {
+    "cocos-obfuscator": "git+https://github.com/your-username/cocos-obfuscator.git"
+  }
+}
+```
+
+### 步骤 3：安装
+
+```bash
+npm install
+```
+
+### 步骤 4：使用
+
+```bash
+npx cocos-obfuscate
+```
+
+**注意**：Gitee 目前不支持 npm 包托管，但可以从 Git 仓库直接安装。详细说明请查看 [GITEE.md](./GITEE.md)。
+
+---
+
+## 完整使用示例
+
+假设你有一个新的 Cocos Creator 项目，想要使用混淆工具：
+
+### 1. 安装包（选择一种方法）
+
+```bash
+# 方法一：npm link
+npm link cocos-obfuscator
+
+# 方法二：从路径安装（在 package.json 中配置后）
+npm install
+
+# 方法三：从 npm 安装（如果已发布）
+npm install cocos-obfuscator --save-dev
+```
+
+### 2. 在 package.json 中添加脚本（可选但推荐）
+
+```json
+{
+  "scripts": {
+    "build": "你的构建命令",
+    "obfuscate": "cocos-obfuscate",
+    "build:obfuscate": "npm run build && npm run obfuscate"
+  }
+}
+```
+
+### 3. 使用
+
+```bash
+# 交互式选择
+npm run obfuscate
+
+# 或直接使用命令
+cocos-obfuscate --platform bytedance
+
+# 构建后自动混淆
+npm run build:obfuscate
+```
+
+---
+
+## 常见问题
+
+### Q: 找不到命令？
+
+A: 确保已经正确安装，使用 `npx cocos-obfuscate` 或 `npm run obfuscate`。
+
+### Q: 如何更新包？
+
+A: 
+- 如果使用 npm link：在 `cocos-obfuscator` 目录修改后，重新运行 `npm link`
+- 如果使用 file: 路径：运行 `npm install` 重新安装
+- 如果从 npm 安装：运行 `npm update cocos-obfuscator`
+
+### Q: 可以全局安装吗？
+
+A: 可以，但不推荐。如果确实需要：
+
+```bash
+cd cocos-obfuscator
+npm install -g .
+```
+
+然后可以在任何地方使用 `cocos-obfuscate` 命令。
+
+---
+
+## 推荐工作流程
+
+1. **开发阶段**：使用 `npm link` 方法，方便调试和更新
+2. **生产环境**：使用 `file:` 路径或发布到私有 npm 仓库
+3. **团队协作**：发布到私有 npm 仓库或使用 Git 仓库安装
+