Tampermonkey 配置

简易的 Tampermonkey 脚本配置库

目前为 2023-08-01 提交的版本。查看最新版本。

此脚本不应直接安装，它是一个供其他脚本使用的外部库。如果您需要使用该库，请在脚本元属性加入：// @require https://update.gf.qytechs.cn/scripts/470224/1228521/Tampermonkey%20Config.js

提问、发表评价，或者举报这个脚本。

作者: PRO-2684
版本: 0.3.1
创建于: 2023-07-05
更新于: 2023-08-01
大小: 3.9 KB
许可证: GPL-3.0

`GM_config`

🪄 功能

简易的 Tampermonkey 脚本配置库。 (Greasy Fork镜像) (GitHub)

🎉 特性

自动注册(不可用)菜单
配置修改后自动更新菜单（也支持由脚本修改）
支持监听配置获取/修改事件

🤔 权限

这个库需要以下权限:

// @grant        GM_setValue // 保存配置
// @grant        GM_getValue // 获取配置
// @grant        GM_registerMenuCommand // 注册(不可用)菜单
// @grant        GM_unregisterMenuCommand // 更新菜单

若你复制粘贴了上述代码，记得删去注释，否则可能报错。若有，你需要删去 @grant none。如果你代码内使用了 window 对象，你可能需要 @grant unsafeWindow 然后 let window = unsafeWindow。

📖 使用

let config_desc = { // *配置描述*
    password: {
        name: "Password", // 显示名称
        value: "tmp", // 默认值
        processor: (v) => { // 处理用户输入，若不合法则报错
            if (v.length < 3) throw "Too short!";
            return v;
        }
    },
    enabled: {
        name: "Enabled",
        value: true,
        processor: GM_config_builtin_processors.boolean // 你可以使用内置处理器
    },
    price: {
        name: "Price",
        value: 10,
        processor: GM_config_builtin_processors.integer(0, 100) // 部分内置处理器需要参数
    },
    foo: {
        name: "Foo",
        value: "bar"
        // 若你认为不需要验证或处理用户输入，你也可以忽略 processor 项
    }
}

let config = GM_config(config_desc); // *注册(不可用)菜单命令*
console.log(config.price); // *可以开始使用了 🎉*
window.addEventListener(GM_config_event, (e) => { // *监听配置变化*
    console.log(config, e.detail);
});

📦 内置处理器

名称	接受值	参数	例子
`boolean`	`true` 或 `false`	无	`GM_config_builtin_processors.boolean`
`integer`	任意 [`min`, `max`] 区间内的整数	`min`, `max` (`undefined` 认为是没有限制)	`GM_config_builtin_processors.integer(1, undefined)` (任意正整数)
`values`	任意数组 `accepted` 内的值	`accepted`	`GM_config_builtin_processors.values(["a", "b", "c"])` (允许 "a", "b" 或 "c")

👀 完整的例子

将以下代码安装为脚本，观察它是如何工作的：

// ==UserScript==
// @name         Test Config
// @namespace    http://tampermonkey.net/
// @version      0.2
// @description  This is an example to demostrate the usage of gf.qytechs.cn/scripts/470224.
// @author       PRO
// @match        https://gf.qytechs.cn/*
// @icon         https://gf.qytechs.cn/vite/assets/blacklogo16-bc64b9f7.png
// @grant        GM_setValue
// @grant        GM_getValue
// @grant        GM_registerMenuCommand
// @grant        GM_unregisterMenuCommand
// @require      https://gf.qytechs.cn/scripts/470224-tampermonkey-config/code/Tampermonkey%20Config.js
// @license      gpl-3.0
// ==/UserScript==

(function() {
    'use strict';
    let config_desc = { // Config description
        password: {
            name: "Password", // Display name
            value: "tmp", // Default value
            processor: (v) => { // Process user inputs, throw error if invalid
                if (v.length < 3) throw "Too short!";
                return v;
            }
        },
        enabled: {
            name: "Enabled",
            value: true,
            processor: GM_config_builtin_processors.boolean // You can use builtin processors
        },
        val: {
            name: "Float",
            value: 11.4,
            processor: parseFloat
        }
    }
    let config = GM_config(config_desc); // Register menu commands
    window.addEventListener(GM_config_event, (e) => { // Listen to config changes
        console.log(config, e.detail);
    });
    window.setTimeout(() => { // Change config values, and menu commands will be updated automatically
        config.val += 1;
    }, 2000);
})();

⚠️ 注意

这个项目正处于早期发展阶段

GM_config