# TamperMonkey-CLI

**Repository Path**: lemon399/tampermonkey-cli

## Basic Information

- **Project Name**: TamperMonkey-CLI
- **Description**: 更加高效的开发油猴脚本插件，支持TS、TSX
- **Primary Language**: NodeJS
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 5
- **Forks**: 2
- **Created**: 2022-08-19
- **Last Updated**: 2025-08-11

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# TamperMonkey-CLI

> 更加高效的开发油猴脚本插件

## 修改说明

这个是从项目
[devaper / TamperMonkey-CLI](https://gitee.com/devaper/tampermonkey-cli)
fork 而来，并做了如下修改 :

1. 移除 Vue 适配
2. 补充 d.ts
3. 更换 esbuild 为 rollup
4. 移除 SASS 支持

感谢原项目作者提供如此轻快又好用的脚手架 。

参考如下文档 :

1. [API 文档 | ScriptCat](https://docs.scriptcat.org/dev/api.html)
2. [Violentmonkey APIs](https://violentmonkey.github.io/api/gm/)
3. [Tampermonkey • 文档](https://www.tampermonkey.net/documentation.php)

d.ts 结构参考了
[脚本猫的 d.ts](https://github.com/scriptscat/scriptcat/blob/main/src/types/scriptcat.d.ts)
进行改进

## 特点

1. 完整的 TypeScript 开发体验
2. 完整的油猴 API 类型提示
3. 自动生成 UserScript
4. 根据代码中应用到的命令自动生成 @grant 标记（省时省力！）

## 如何使用

1. 克隆到本地

   ```bash
   git clone git@gitee.com:horizon007/tampermonkey-cli.git
   ```

2. 安装依赖

   ```bash
   yarn
   # 或
   npm install
   ```

3. 在 `projects/{projectName}/main.ts` 中编写入口代码

4. 执行打包命令

   ```bash
   yarn build [项目名称] # 项目名称是projects下的文件夹名称，缺省会自动寻找
   # 或
   npm run build [项目名称]
   ```

## 项目目录

- build
  - config.js 全局配置文件（各种文件的位置、代码压缩等都可以在此处修改配置）
  - ...
- inject 将目录中的代码在打包时通过 esbuild 注入到 bundle 中
- projects 项目目录，其中每个子目录是一个项目
  - example 项目，可以创建多个，目录名称即项目名称
    - main.ts 入口文件

    - \_manifest.ts 清单文件（包含名称、作者等信息，用于生成脚本的 UserScript 标记）

    - \_preset.ts _可选_ 预设变量，会置于脚本靠前位置，方便用户修改

    - \_presets.d.ts _可选_ 预设变量声明 (为了防止被预设变量编译进去，项目只可导入此声明)

    - \_config.ts _可选_ 项目编译配置，相当于全局配置文件中的 `config.build`。此文件不存在会使用全局配置

    - \_cat-config.yaml _可选_ [脚本猫用户配置](https://docs.scriptcat.org/docs/dev/config/)