元数据(Metadata)
放在 // ==UserScript== 和 // ==/UserScript== 之间。
| 标签 | 说明 |
|---|---|
| @name | 脚本名称。国际化用 @name:zh 后缀 |
| @namespace | 命名空间(发布地址) |
| @version | 版本号,用于更新检测,每次更新需递增 |
| @description | 简短描述。国际化同 @name |
| @author | 作者 |
| @copyright | 版权声明 |
| @homepage / @homepageURL / @website / @source | 作者主页,会在选项页链接脚本名 |
| @icon / @iconURL / @defaulticon | 低分辨率图标 |
| @icon64 / @icon64URL | 64x64 图标 |
| @grant | 白名单 GM_* 函数、unsafeWindow、window.close/focus/onurlchange。值为 none 时禁用沙盒 |
| @antifeature | 披露变现方式。类型:ads / tracking / miner。支持国际化 |
| @require | 加载外部 JS,在脚本运行前执行。支持 SRI 完整性校验 |
| @resource | 预加载资源,通过 GM_getResourceURL / GM_getResourceText 访问 |
| @include | 脚本运行的页面 URL 模式。支持 * 通配符和正则 /^https:…$/ |
| @match | 类似 Chrome 扩展的 match pattern:<protocol>://<domain><path> |
| @exclude | 排除匹配的 URL |
| @run-at | 注入时机:document-start / document-body / document-end / document-idle(默认)/ context-menu |
| @run-in | 运行环境(v5.3+):normal-tabs / incognito-tabs / container-id-N |
| @sandbox | 沙盒模式:raw(页面上下文)/ JavaScript(需 unsafeWindow)/ DOM(仅 DOM) |
| @tag | 为脚本添加标签,显示在脚本列表 |
| @connect | 允许 GM_xmlhttpRequest 请求的域名。支持 self / localhost / IP / * |
| @noframes | 不在 iframe 中运行 |
| @updateURL | 更新检查 URL |
| @downloadURL | 更新下载 URL,设为 none 则禁用更新 |
| @supportURL | 支持/反馈 URL |
| @webRequest | 实验性 API,定义请求拦截规则(JSON) |
| @unwrap | 无包裹直接注入页面,适用于 Scriptlets |
模板
// ==UserScript==
// @name 脚本名称
// @namespace http://your.site/
// @version 1.0.0
// @description 描述
// @author 作者
// @match https://example.com/*
// @grant GM_setValue
// @grant GM_getValue
// @require https://code.jquery.com/jquery-3.7.1.min.js
// @run-at document-idle
// ==/UserScript==
(function() {
'use strict';
// your code here
})();