garbage-maker 0.2.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 Cosmo Lau
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,113 @@
+# garbage-maker
+
+![GitHub](https://img.shields.io/github/license/CosmoLau/garbage-maker)
+
+为项目中的所有 `JavaScript` 和 `TypeScript` 脚本添加垃圾代码。
+
+## 背景
+
+部分国内小游戏平台可能会对小游戏进行代码检测，未通过检测可能无法过审。
+
+如果小游戏发布次数不多，可通过简单粗暴往代码里加垃圾代码的形式提交审核，这就是此项目的用途。
+
+如果小游戏被多次发布，使用本项目进行过审的概率会大大降低，可以在本项目的源码中修改部分内容进行多次尝试，或者使用其他方式来完成您的需求，例如 `代码混淆`。
+
+## 快速使用
+
+> 本项目需要安装 [Node](https://nodejs.org/) 环境。
+
+使用你喜欢的包管理器全局安装 `garbage-maker`：
+
+```shell
+npm install -g garbage-maker
+```
+
+添加垃圾代码：
+
+```shell
+garbage-maker add [文件或目录的绝对路径]
+```
+
+清理垃圾代码：
+
+```shell
+garbage-maker clean [文件或目录的绝对路径]
+```
+
+查看 `garbage-maker` 所有命令的帮助：
+
+```shell
+garbage-maker --help
+```
+
+查看指定命令的帮助：
+
+```shell
+garbage-maker add --help
+```
+
+## 自定义添加垃圾代码
+
+使用 `-c` 或者 `--code` 标志（flag）来添加自定义的垃圾代码：
+
+```shell
+garbage-maker add [绝对路径] -c "console.log();"
+# 或者
+garbage-maker add [绝对路径] --code "console.log();"
+```
+
+> _注意_：自定义添加的垃圾代码最好是未出现在已有代码中的。
+> 在使用 `clean` 命令清理代码时，需要传入与 `add` 命令相同的 `--code` 标志，否则会清理默认的 `(1+1);` 垃圾代码。
+
+使用 `-r` 或者 `--ratio` 标志（flag）控制添加垃圾代码的百分比，即根据文件的字符数量，来添加垃圾代码的字符数量。
+
+```shell
+garbage-maker add [绝对路径] -r 50
+# 或者
+garbage-maker add [绝对路径] --ratio 50
+```
+
+> _注意_：`--ratio` 标志的值为百分比的数字部分，即示例中的 `50` 相当于 `50%`。
+
+## 修改源码
+
+该分支使用 [oclif](https://github.com/oclif/oclif) 作为 CLI 框架进行开发，如需对源码进行修改，按照以下方法进行：
+
+1. 安装依赖：
+
+    ```shell
+    npm install
+    ```
+
+2. 调试命令：
+
+    ```shell
+    # Windows
+    ./bin/dev.cmd --help
+    # MacOS 或 Linux
+    ./bin/dev.js --help
+    ```
+
+3. 构建 CLI：
+
+    ```shell
+    npm link
+    ```
+
+## 分支说明
+
+本项目以 `main` 作为默认分支，老版本的 JavaScript 代码仍包含在本项目中，可以查看 [garbage-maker.js](./garbage-maker.js)。
+
+如需查看老版本文档，可以切换至 `master` 分支查看 `README.md`。
+
+## 赞助
+
+如果该项目对你有帮助，不妨点个 `star` 来支持我。
+
+也可以通过其他方式来赞助我，从零开始将我培养成一个开源工具人。
+
+[爱发电主页](https://afdian.net/a/CosmoLau)
+
+## LICENSE
+
+[MIT License](./LICENSE)

package/bin/dev.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node --loader ts-node/esm --no-warnings=ExperimentalWarning "%~dp0\dev" %*

package/bin/dev.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env -S node --loader ts-node/esm --no-warnings=ExperimentalWarning
+
+import {execute} from '@oclif/core'
+
+await execute({development: true, dir: import.meta.url})

package/bin/run.cmd

@@ -0,0 +1,3 @@
+@echo off
+
+node "%~dp0\run" %*

package/bin/run.js

@@ -0,0 +1,5 @@
+#!/usr/bin/env node
+
+import {execute} from '@oclif/core'
+
+await execute({dir: import.meta.url})

package/dist/commands/add.d.ts

@@ -0,0 +1,15 @@
+import { Command } from '@oclif/core';
+export default class Add extends Command {
+    static args: {
+        path: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        /** 添加的垃圾代码字符串  */
+        code: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        /** 添加垃圾代码的比例 */
+        ratio: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/add.js

@@ -0,0 +1,86 @@
+import { Args, Command, Flags } from '@oclif/core';
+import { statSync } from 'fs';
+import { GarbageMaker, defaultProp } from '../garbage-maker.js';
+import { confirm, input } from '@inquirer/prompts';
+export default class Add extends Command {
+    static args = {
+        path: Args.string({
+            name: 'path',
+            required: true,
+            description: '目标文件或目录的路径'
+        }),
+    };
+    static description = '➕添加垃圾代码';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    static flags = {
+        /** 添加的垃圾代码字符串  */
+        code: Flags.string({
+            name: 'code',
+            description: '自定义添加的垃圾代码',
+            char: 'c',
+            required: false,
+        }),
+        /** 添加垃圾代码的比例 */
+        ratio: Flags.string({
+            name: 'ratio',
+            description: '添加垃圾代码的比例',
+            char: 'r',
+            required: false,
+        })
+    };
+    async run() {
+        const { args, flags } = await this.parse(Add);
+        this.log(`输入的路径：${args.path}`);
+        this.log(`垃圾代码：${flags.code}\n添加比例：${flags.ratio}`);
+        if (!flags.code) {
+            // 如果没有在标志中传参，对其进行询问
+            flags.code = await input({
+                message: '想要添加的垃圾代码：',
+                default: defaultProp.codeStr
+            });
+        }
+        // 检查文件中是否包含垃圾代码
+        let checkCodeConfirm = true;
+        if (GarbageMaker.checkCode(args.path, flags.code)) {
+            checkCodeConfirm = await confirm({
+                message: '现有代码中已包含垃圾代码，是否继续添加？',
+                default: false,
+            });
+        }
+        if (!checkCodeConfirm) {
+            console.log("已取消添加代码");
+            return;
+        }
+        // 如果没有在标志中传参，对其进行询问
+        if (!flags.ratio) {
+            flags.ratio = await input({
+                message: '添加垃圾代码的比例：',
+                default: defaultProp.ratio?.toString()
+            });
+        }
+        try {
+            let stat = statSync(args.path);
+            if (stat.isDirectory()) {
+                this.log("传入的是一个文件夹路径");
+            }
+            else if (stat.isFile()) {
+                this.log("传入的是一个文件路径");
+            }
+            else {
+                this.warn("请输入正确的路径");
+            }
+        }
+        catch (error) {
+            this.error("无法读取路径，请输入正确的路径：" + error);
+        }
+        let prop = {
+            sourcePath: args.path,
+            addShit: true,
+            codeStr: flags.code,
+            ratio: flags.ratio ? Number(flags.ratio) : undefined,
+        };
+        GarbageMaker.execute(prop);
+    }
+}

package/dist/commands/clean.d.ts

@@ -0,0 +1,13 @@
+import { Command } from '@oclif/core';
+export default class Clean extends Command {
+    static args: {
+        path: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+    };
+    static description: string;
+    static examples: string[];
+    static flags: {
+        /** 清理的垃圾代码字符串  */
+        code: import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+    };
+    run(): Promise<void>;
+}

package/dist/commands/clean.js

@@ -0,0 +1,58 @@
+import { Args, Command, Flags } from '@oclif/core';
+import { GarbageMaker, defaultProp } from '../garbage-maker.js';
+import { statSync } from 'fs';
+import { input } from '@inquirer/prompts';
+export default class Clean extends Command {
+    static args = {
+        path: Args.string({
+            name: 'path',
+            required: true,
+            description: '目标文件或目录的路径'
+        }),
+    };
+    static description = '🧹清理垃圾代码';
+    static examples = [
+        '<%= config.bin %> <%= command.id %>',
+    ];
+    static flags = {
+        /** 清理的垃圾代码字符串  */
+        code: Flags.string({
+            name: 'code',
+            description: '需要清理的垃圾代码',
+            char: 'c',
+            required: false,
+        }),
+    };
+    async run() {
+        const { args, flags } = await this.parse(Clean);
+        this.log(`输入的路径：${args.path}`);
+        this.log(`垃圾代码：${flags.codeStr}\n添加比例：${flags.ratio}`);
+        if (!flags.code) {
+            flags.code = await input({
+                message: '需要清理的垃圾代码：',
+                default: defaultProp.codeStr
+            });
+        }
+        try {
+            let stat = statSync(args.path);
+            if (stat.isDirectory()) {
+                this.log("传入的是一个文件夹路径");
+            }
+            else if (stat.isFile()) {
+                this.log("传入的是一个文件路径");
+            }
+            else {
+                this.warn("请输入正确的路径");
+            }
+        }
+        catch (error) {
+            this.error("无法读取路径，请输入正确的路径：" + error);
+        }
+        let prop = {
+            sourcePath: args.path,
+            addShit: false,
+            codeStr: flags.code,
+        };
+        GarbageMaker.execute(prop);
+    }
+}

package/dist/garbage-maker.d.ts

@@ -0,0 +1,34 @@
+/// <reference types="node" resolution-mode="require"/>
+import { PathLike } from "fs";
+/**
+ * garbage-maker 类的参数接口
+ */
+export interface Prop {
+    /** 源文件路径 */
+    sourcePath: PathLike;
+    /** 是否添加垃圾代码 */
+    addShit?: boolean;
+    /** 垃圾代码内容 */
+    codeStr?: string;
+    /** 添加垃圾代码的比例 */
+    ratio?: number;
+}
+/** 默认参数 */
+export declare const defaultProp: Prop;
+/**
+ * garbage-maker 核心代码类
+ */
+export declare class GarbageMaker {
+    /**
+     * 执行代码
+     * @param prop 参数
+     */
+    static execute(prop: Prop): void;
+    /**
+     * 检查垃圾代码是否存在
+     * @param path 文件或文件夹的绝对路径
+     * @param codeStr 代码字符串
+     * @returns
+     */
+    static checkCode(path: PathLike, codeStr: string): boolean;
+}

package/dist/garbage-maker.js

@@ -0,0 +1,106 @@
+import { readFileSync, readdirSync, statSync, writeFileSync } from "fs";
+import { extname, join } from "path";
+/** 默认参数 */
+export const defaultProp = {
+    sourcePath: "",
+    addShit: true,
+    codeStr: "(1+1);",
+    ratio: 35,
+};
+/**
+ * garbage-maker 核心代码类
+ */
+export class GarbageMaker {
+    /**
+     * 执行代码
+     * @param prop 参数
+     */
+    static execute(prop) {
+        /** 已修改的文件数量 */
+        let fileChangeNum = 0;
+        // 检查可选参数
+        prop.addShit = prop.addShit ?? defaultProp.addShit;
+        prop.codeStr = prop.codeStr ?? defaultProp.codeStr;
+        prop.ratio = prop.ratio ?? defaultProp.ratio;
+        /** 添加垃圾代码 */
+        let addCode = (path) => {
+            let context = readFileSync(path, 'utf8');
+            let num = Math.floor(context.length * prop.ratio / 100 / prop.codeStr?.length);
+            for (let i = 0; i < num; i++) {
+                context += prop.codeStr;
+            }
+            writeFileSync(path, context, 'utf8');
+            fileChangeNum++;
+        };
+        /** 清理垃圾代码 */
+        let cleanCode = (path) => {
+            let context = readFileSync(path, 'utf8');
+            let pattern = prop.codeStr?.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            let reg = new RegExp(pattern, 'g');
+            context = context.replace(reg, "");
+            writeFileSync(path, context, 'utf8');
+            fileChangeNum++;
+        };
+        /** 遍历文件夹 */
+        let traverseFile = (path) => {
+            let files = readdirSync(path);
+            files.forEach(val => {
+                let subPath = join(path.toString(), val);
+                let stat = statSync(subPath);
+                if (stat.isFile() && (extname(subPath) == ".ts" || extname(subPath) == ".js")) {
+                    prop.addShit ? addCode(subPath) : cleanCode(subPath);
+                }
+                if (stat.isDirectory()) {
+                    traverseFile(subPath);
+                }
+            });
+        };
+        let stat = statSync(prop.sourcePath);
+        if (stat.isFile() && (extname(prop.sourcePath.toString()) == ".ts" || extname(prop.sourcePath.toString()) == ".js")) {
+            prop.addShit ? addCode(prop.sourcePath) : cleanCode(prop.sourcePath);
+        }
+        if (stat.isDirectory()) {
+            traverseFile(prop.sourcePath);
+        }
+        console.log(`已修改 ${fileChangeNum} 个文件`);
+    }
+    /**
+     * 检查垃圾代码是否存在
+     * @param path 文件或文件夹的绝对路径
+     * @param codeStr 代码字符串
+     * @returns
+     */
+    static checkCode(path, codeStr) {
+        /** 是否存在代码 */
+        let haveCode = false;
+        /** 清理垃圾代码 */
+        let check = (path) => {
+            let context = readFileSync(path, 'utf8');
+            let pattern = codeStr?.replace(/[.*+?^${}()|[\]\\]/g, '\\$&');
+            let reg = new RegExp(pattern, 'g');
+            haveCode = reg.test(context) ? true : haveCode;
+        };
+        /** 遍历文件夹 */
+        let traverseFile = (path) => {
+            let files = readdirSync(path);
+            files.forEach(val => {
+                let subPath = join(path.toString(), val);
+                let stat = statSync(subPath);
+                if (stat.isFile() && (extname(subPath) == ".ts" || extname(subPath) == ".js")) {
+                    check(subPath);
+                }
+                if (stat.isDirectory()) {
+                    traverseFile(subPath);
+                }
+            });
+        };
+        let stat = statSync(path);
+        if (stat.isFile() && (extname(path.toString()) == ".ts" || extname(path.toString()) == ".js")) {
+            check(path);
+        }
+        if (stat.isDirectory()) {
+            traverseFile(path);
+        }
+        return haveCode;
+    }
+}

package/oclif.manifest.json

@@ -0,0 +1,92 @@
+{
+  "commands": {
+    "add": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "目标文件或目录的路径",
+          "name": "path",
+          "required": true
+        }
+      },
+      "description": "➕添加垃圾代码",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "code": {
+          "char": "c",
+          "description": "自定义添加的垃圾代码",
+          "name": "code",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        },
+        "ratio": {
+          "char": "r",
+          "description": "添加垃圾代码的比例",
+          "name": "ratio",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "add",
+      "pluginAlias": "garbage-maker",
+      "pluginName": "garbage-maker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "add.js"
+      ]
+    },
+    "clean": {
+      "aliases": [],
+      "args": {
+        "path": {
+          "description": "目标文件或目录的路径",
+          "name": "path",
+          "required": true
+        }
+      },
+      "description": "🧹清理垃圾代码",
+      "examples": [
+        "<%= config.bin %> <%= command.id %>"
+      ],
+      "flags": {
+        "code": {
+          "char": "c",
+          "description": "需要清理的垃圾代码",
+          "name": "code",
+          "required": false,
+          "hasDynamicHelp": false,
+          "multiple": false,
+          "type": "option"
+        }
+      },
+      "hasDynamicHelp": false,
+      "hiddenAliases": [],
+      "id": "clean",
+      "pluginAlias": "garbage-maker",
+      "pluginName": "garbage-maker",
+      "pluginType": "core",
+      "strict": true,
+      "enableJsonFlag": false,
+      "isESM": true,
+      "relativePath": [
+        "dist",
+        "commands",
+        "clean.js"
+      ]
+    }
+  },
+  "version": "0.2.0"
+}

package/package.json

@@ -0,0 +1,66 @@
+{
+  "name": "garbage-maker",
+  "version": "0.2.0",
+  "description": "garbage-maker，向 JS 和 TS 文件中添加垃圾代码",
+  "keywords": [
+    "oclif",
+    "garbage-maker"
+  ],
+  "homepage": "https://github.com/CosmoLau/garbage-maker",
+  "bugs": "https://github.com/CosmoLau/garbage-maker/issues",
+  "repository": "CosmoLau/garbage-maker",
+  "license": "MIT",
+  "author": "CosmoLau",
+  "type": "module",
+  "exports": "./lib/index.js",
+  "types": "dist/index.d.ts",
+  "bin": {
+    "garbage-maker": "./bin/run.js"
+  },
+  "files": [
+    "/bin",
+    "/dist",
+    "/oclif.manifest.json"
+  ],
+  "scripts": {
+    "build": "shx rm -rf dist && tsc -b",
+    "prepack": "npm run build && oclif manifest && oclif readme",
+    "postpack": "shx rm -f oclif.manifest.json",
+    "prepare": "npm run build",
+    "test": "mocha --forbid-only \"test/**/*.test.ts\"",
+    "version": "oclif readme && git add README.md"
+  },
+  "oclif": {
+    "bin": "garbage-maker",
+    "commands": "./dist/commands",
+    "dirname": "garbage-maker",
+    "plugins": [
+      "@oclif/plugin-help",
+      "@oclif/plugin-plugins"
+    ],
+    "topicSeparator": " "
+  },
+  "dependencies": {
+    "@inquirer/prompts": "^5.0.1",
+    "@oclif/core": "^3",
+    "@oclif/plugin-help": "^6",
+    "@oclif/plugin-plugins": "^5",
+    "@types/inquirer": "^9.0.7"
+  },
+  "devDependencies": {
+    "@oclif/prettier-config": "^0.2.1",
+    "@oclif/test": "^3",
+    "@types/chai": "^4",
+    "@types/mocha": "^10",
+    "@types/node": "^18",
+    "chai": "^4",
+    "mocha": "^10",
+    "oclif": "^4.8.2",
+    "shx": "^0.3.4",
+    "ts-node": "^10.9.2",
+    "typescript": "^5"
+  },
+  "engines": {
+    "node": ">=18.0.0"
+  }
+}