开源项目 Userscripts 使用教程

开源项目 Userscripts 使用教程

Userscripts 项目地址: https://gitcode.com/gh_mirrors/usersc/Userscripts

1. 项目的目录结构及介绍

Userscripts/
├── userjs/
│   ├── script1.user.js
│   ├── script2.user.js
│   └── ...
├── .editorconfig
├── .git-blame-ignore-revs
├── .gitignore
├── .prettierignore
├── .prettierrc.json
├── LICENSE
├── README.md
└── package.json

目录结构说明

• userjs/: 存放用户脚本的目录，包含多个 .user.js 文件，每个文件对应一个用户脚本。
• .editorconfig: 配置文件，用于统一代码编辑器的格式设置。
• .git-blame-ignore-revs: Git 配置文件，用于忽略某些提交的 blame 信息。
• .gitignore: Git 配置文件，用于指定不需要版本控制的文件和目录。
• .prettierignore: Prettier 配置文件，用于指定不需要格式化的文件和目录。
• .prettierrc.json: Prettier 配置文件，用于设置代码格式化的规则。
• LICENSE: 项目的开源许可证文件，本项目使用 GPL-3.0 许可证。
• README.md: 项目的说明文档，包含项目的介绍、安装方法、使用说明等。
• package.json: 项目的配置文件，包含项目的元数据、依赖项等信息。

2. 项目的启动文件介绍

本项目没有传统的“启动文件”，因为用户脚本通常是通过浏览器插件（如 Tampermonkey、Greasemonkey 等）直接加载和执行的。每个 .user.js 文件都是一个独立的脚本，用户可以通过浏览器插件管理器安装和启用这些脚本。

3. 项目的配置文件介绍

.editorconfig

root = true

[*]
charset = utf-8
indent_style = space
indent_size = 2
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true

该文件用于配置代码编辑器的格式设置，确保团队成员在不同的编辑器中使用一致的代码格式。

.gitignore

# 忽略 node_modules 目录
node_modules/

# 忽略生成的文件
dist/
build/

该文件用于指定不需要版本控制的文件和目录，例如 node_modules 目录和生成的文件。

.prettierrc.json

{
  "singleQuote": true,
  "trailingComma": "es5",
  "printWidth": 80,
  "tabWidth": 2
}

该文件用于配置 Prettier 代码格式化工具的规则，确保代码风格一致。

package.json

{
  "name": "Userscripts",
  "version": "1.0.0",
  "description": "致力于创造桌面端和移动端用户脚本，改善在浏览器环境中网站浏览体验",
  "license": "GPL-3.0",
  "dependencies": {
    "some-dependency": "^1.0.0"
  },
  "devDependencies": {
    "prettier": "^2.0.0"
  }
}

该文件包含项目的元数据、依赖项等信息。dependencies 和 devDependencies 字段分别列出了项目运行时和开发时所需的依赖包。

Userscripts 项目地址: https://gitcode.com/gh_mirrors/usersc/Userscripts