示例与排错

本页按实际需求展示 JavaScript 覆写.每个示例都包含预期结果或失败行为.

修改标量字段

修改端口.js

function main(profile) {
  profile["mixed-port"] = 7890;
  return profile;
}

修改端口 diff.js

function main(profile) {
-  profile["mixed-port"] = 10801; 
+  profile["mixed-port"] = 7890; 
  return profile;
}

按条件修改

条件修改.js

function main(profile) {
  if (profile.mode === "rule") {
    profile["log-level"] = "info";
  }
  return profile;
}

当 mode 为 rule 时：

log-level: info

当条件不满足时，脚本返回原对象，不产生 diff.

添加对象字段

添加 DNS 字段.js

function main(profile) {
  if (!profile.dns) profile.dns = {};
  profile.dns.enable = true;
  profile.dns["enhanced-mode"] = "fake-ip";
  return profile;
}

添加 DNS 字段 diff.yaml

dns:
  enable: true
  enhanced-mode: fake-ip

使用 `deepMerge` 添加规则

添加规则.js

function main(profile) {
  return deepMerge(profile, {
    "+rules": ["DOMAIN-SUFFIX,lan,DIRECT"],
    "rules+": ["DOMAIN-SUFFIX,example.com,PROXY"],
  }, true);
}

添加规则 diff.yaml

rules:
  - DOMAIN-SUFFIX,lan,DIRECT
  - DOMAIN-SUFFIX,old.example,DIRECT
  - DOMAIN-SUFFIX,example.com,PROXY
  - MATCH,PROXY

JavaScript 不会像 YAML 一样自动移动 MATCH.如果原列表没有把 MATCH 放在最后，脚本也不会替你修正.

替换对象或数组

替换 DNS.js

function main(profile) {
  return deepMerge(profile, {
    "dns!": {
      enable: true,
      "enhanced-mode": "fake-ip",
      nameserver: ["1.1.1.1"],
    },
  }, true);
}

替换 DNS diff.yaml

dns:
  enable: false
  nameserver: 
    - 223.5.5.5
  enable: true
  enhanced-mode: fake-ip
  nameserver: 
    - 1.1.1.1

过滤代理

过滤代理.js

function main(profile) {
  const proxies = Array.isArray(profile.proxies) ? profile.proxies : [];
  profile.proxies = proxies.filter((item) => {
    const name = String((item && item.name) || "");
    return !name.includes("过期");
  });
  return profile;
}

过滤代理 diff.yaml

proxies:
  - name: 香港节点
  - name: 过期节点

如果 profile.proxies 不是数组，脚本会使用空数组，最终得到 proxies: [].

修改命名策略组

修改策略组.js

function main(profile) {
  const groups = Array.isArray(profile["proxy-groups"])
    ? profile["proxy-groups"]
    : [];
  const proxy = groups.find((group) => group && group.name === "PROXY");
  if (proxy) proxy.proxies = ["DIRECT"];
  return profile;
}

修改策略组 diff.yaml

proxy-groups:
  - name: PROXY
    proxies: 
      - AUTO
      - DIRECT

如果找不到 PROXY，脚本不会创建新的策略组，也不会报错.

读取远程 YAML

远程 YAML.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/patch.yaml");
  if (!response.ok) return profile;
  return deepMerge(profile, await response.yaml(), true);
}

远程返回：

dns:
  enable: true

预期 diff：

远程 YAML 结果 diff.yaml

dns:
  enable: false
  enable: true

网络失败、只支持 HTTPS、YAML 内容损坏或 Promise 未完成都会使脚本失败.

读取远程 JSON

远程 JSON.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/config.json");
  if (!response.ok) return profile;

  const payload = await response.json();
  if (typeof payload.port === "number") {
    profile["mixed-port"] = payload.port;
  }
  return profile;
}

如果 payload.port 不是数字，脚本会保留原来的 mixed-port.

请求头和请求体

POST 请求.js

async function main(profile) {
  const response = await fetch("http://127.0.0.1:8080/patch", {
    method: "POST",
    headers: {
      "content-type": "application/json",
      authorization: "Bearer token",
    },
    body: {
      mode: profile.mode,
    },
  });

  if (!response.ok) return profile;
  return deepMerge(profile, await response.yaml(), true);
}

对象请求体会在发送前转换为 JSON 字符串.

日志和异常

记录并抛错.js

function main(profile) {
  console.info("开始处理", profile.mode);
  if (!profile.mode) {
    throw new Error("缺少 mode");
  }
  return profile;
}

失败时：

当前覆写写入 [exception] 脚本执行失败.
不会继续执行后续覆写.
普通配置会返回脚本错误和文件路径.
加密配置不会在错误或日志中暴露配置内容和路径.

返回错误值

返回数组.js

function main(profile) {
  return profile.rules;
}

预期结果：

JS override result must be an object

缺少 main.js

const unused = 1;

预期结果：

JS override must define main(profile)

多个 JavaScript 覆写

文件按绑定顺序执行，后一个脚本接收前一个脚本的返回值：

第一个脚本.js

function main(profile) {
  profile.port = 2;
  return profile;
}

第二个脚本.js

function main(profile) {
  profile.port = profile.port + 3;
  return profile;
}

JavaScript 覆写链结果 diff.yaml

mixed-port: 1
mixed-port: 5

第二个脚本缺少 main 时，不会复用第一个脚本的函数，而是直接失败.

开始

指南

覆写

更多

修改标量字段

按条件修改

添加对象字段

使用 `deepMerge` 添加规则

替换对象或数组

过滤代理

修改命名策略组

读取远程 YAML

读取远程 JSON

请求头和请求体

日志和异常

返回错误值

多个 JavaScript 覆写

​修改标量字段

​按条件修改

​添加对象字段

​使用 deepMerge 添加规则

​替换对象或数组

​过滤代理

​修改命名策略组

​读取远程 YAML

​读取远程 JSON

​请求头和请求体

​日志和异常

​返回错误值

​多个 JavaScript 覆写

修改标量字段

按条件修改

添加对象字段

使用 `deepMerge` 添加规则

替换对象或数组

过滤代理

修改命名策略组

读取远程 YAML

读取远程 JSON

请求头和请求体

日志和异常

返回错误值

多个 JavaScript 覆写