https://github.com/cssmagic/sorl2pac
To convert SwitchyOmega rule lists (*.sorl) to PAC script. | 将 SwitchyOmega 规则列表（*.sorl）转换为 PAC 脚本。
https://github.com/cssmagic/sorl2pac
proxy sorl switchyomega
Last synced: about 1 month ago
JSON representation
To convert SwitchyOmega rule lists (*.sorl) to PAC script. | 将 SwitchyOmega 规则列表（*.sorl）转换为 PAC 脚本。
- Host: GitHub
- URL: https://github.com/cssmagic/sorl2pac
- Owner: cssmagic
- License: mit
- Created: 2026-06-15T14:13:34.000Z (about 2 months ago)
- Default Branch: master
- Last Pushed: 2026-06-18T10:05:23.000Z (about 2 months ago)
- Last Synced: 2026-06-18T12:09:28.820Z (about 2 months ago)
- Topics: proxy, sorl, switchyomega
- Language: JavaScript
- Homepage:
- Size: 11.7 KB
- Stars: 1
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
English | [中文](README.zh.md)
# sorl2pac
> To convert SwitchyOmega rule lists (`*.sorl`) to PAC script.
## Usage
```js
import { sorl2pac } from "sorl2pac";
const pacSource = sorl2pac(sorlText, {
matched: "DIRECT",
unmatched: "PROXY 127.0.0.1:7890",
});
```
`pacSource` is a complete PAC script. It contains an internal `match(host)` helper and a standard `FindProxyForURL(url, host)` function.
```js
function FindProxyForURL(url, host) {
return match(host) ? "DIRECT" : "PROXY 127.0.0.1:7890";
}
```
## API
```ts
function sorl2pac(
sorl: string,
results: {
matched: string;
unmatched: string;
},
): string;
```
- `sorl` must be a string containing a supported SwitchyOmega rule list.
- `results.matched` is returned by `FindProxyForURL()` when `match(host)` is `true`.
- `results.unmatched` is returned when `match(host)` is `false`.
- `match(host)` is generated inside the PAC script. It is not an extra package export.
`sorl2pac()` throws `TypeError` for invalid API arguments and `SyntaxError` for unsupported rule-list syntax.
## Supported Syntax
This package intentionally supports a small SwitchyOmega new-format subset:
- `[SwitchyOmega Conditions]`
- blank lines
- `;` comment lines
- `@note` lines
- bare `HostWildcardCondition` rules, such as `*.example.com`
- host wildcard prefixes: `HostWildcard:`, `HostWildcardCondition:`, `Host:`, `H:`, `W:`, `HW:`
- `!` exclusive rules
Unsupported syntax fails instead of being ignored, including old `#BEGIN` rule lists, `@with result`, `+profile`, URL conditions, IP conditions, time conditions, and AutoProxy syntax.
## Matching Behavior
- Rules are checked from top to bottom.
- A normal rule match returns `true`.
- An exclusive rule match returns `false`.
- No match returns `false`.
- An empty rule list is valid and always returns `false`.
- `*.abc.com` matches both `abc.com` and `sub.abc.com`.
- `**.abc.com` matches `sub.abc.com` but not `abc.com`.
Because `results` is configurable, callers can use the same rules for whitelist or blacklist behavior.
```js
const whitelistPac = sorl2pac(sorlText, {
matched: "DIRECT",
unmatched: "PROXY 127.0.0.1:7890",
});
const blacklistPac = sorl2pac(sorlText, {
matched: "PROXY 127.0.0.1:7890",
unmatched: "DIRECT",
});
```
***
## License
> Any code contributed to this project is considered authorized for commercial use by the project authors and their affiliated companies and distributed under this project's license.
>
> 任何贡献到本项目的代码，均视为授权本项目作者及其关联公司用于商业用途，并可按本项目协议进行分发。
MIT