feat: introduce sing-box support #261
Conversation
✅ Deploy Preview for surgio-documentation ready!
To edit notification comments on pull requests, go to your Netlify site configuration. |
|
非常感谢贡献代码！我稍后新建一个分支线合并过去。 |
|
已经rebase到master并解决CI错误。 |
|
|
||
| export const Socks5NodeConfigValidator = SimpleNodeConfigValidator.extend({ | ||
| export const Socks5NodeConfigValidator = TlsNodeConfigValidator.extend({ |
| @@ -1064,3 +1118,21 @@ module.exports = defineClashProvider({ | |||
| } | |||
| }) | |||
| ``` | |||
|
|
|||
| ## multiplex多路复用 | |||
There was a problem hiding this comment.
mihomo中也有使用，底层也是sing-box
CONTRIBUTING.md
Outdated
| ## test locally | ||
|
|
||
| - Run `pnpm run build` after modifing this repo | ||
| - Update dependencies to `"surgio": "file:path/to/surgio"` in your test repo (eg. `my-rule-store`) and run `pnpm install` |
There was a problem hiding this comment.
"surgio": "file:path/to/surgio"和pnpm link surgio应该是等价的。
我在debug时发现需要先执行pnpm run build生成surgio/build目录，否则无法执行surgio generate，建议考虑完善CONTRIBUTING.md。
There was a problem hiding this comment.
我建议用 link，这样不用对代码进行修改，不会提交到仓库里
src/validators/http.ts
Outdated
| }) | ||
|
|
||
| export const HttpsNodeConfigValidator = TlsNodeConfigValidator.extend({ | ||
| type: z.literal(NodeTypeEnum.HTTPS), | ||
| username: z.string(), | ||
| password: z.string(), | ||
| path: z.string().optional(), | ||
| headers: z.record(z.string(), z.array(z.string())).optional(), |
There was a problem hiding this comment.
headers 是否能先保持和之前一致，用 z.record(z.string())，不然我觉得很混乱
There was a problem hiding this comment.
可以，这里我惯用go中的header结构了
There was a problem hiding this comment.
对，我猜也是 go 的库造成的。咱先不考虑这个情况，实际情况下很少遇到。
There was a problem hiding this comment.
已经统一为z.record(z.string())
| @@ -97,3 +97,17 @@ export const TlsNodeConfigValidator = SimpleNodeConfigValidator.extend({ | |||
| serverCertFingerprintSha256: z.ostring(), | |||
| clientFingerprint: z.ostring(), | |||
| }) | |||
|
|
|||
| export const MultiplexValidator = z.object({ | |||
There was a problem hiding this comment.
这个验证是否能直接作为 SimpleNodeConfigValidator 的一部分，这样就不用逐个写了。隐藏条件是只有 TCP 协议才生效，不过我觉得这个小坑应该不会有太大问题。你觉得呢？
There was a problem hiding this comment.
个人倾向于目前这样做法的原因是：
- 喜欢组合大于继承
- 协议变化并不多，逐个写也挺方便的😀，可以在类型系统上避免udp协议使用此字段
当然目前整体是用的继承，我觉得作为SimpleNodeConfigValidator的一部分也可以。
| return result | ||
| } | ||
|
|
||
| const typeMap = { |
There was a problem hiding this comment.
这个map只列出了sing-box支持的协议，在这里做了不支持的协议拦截。此外socks5在sing-box中是socks。
| list: ReadonlyArray<PossibleNodeConfigType>, | ||
| filter?: NodeFilterType | SortedNodeFilterType, | ||
| ) { | ||
| return JSON.stringify(getSingboxNodes(list, filter)).slice(1, -1) |
|
我对在 Nunjucks 模板里写 JSON 有点抗拒，你还有没有更好的主意…… 代码里问了几个问题，麻烦解答一下，谢谢。 |
|
关于在Nunjucks 模板里写 JSON ，我个人是觉得OK，因为我们只是把yaml、json当作纯文本，并拼凑其中的内容。如果我们不认为这个json配置是template，那就势必要在某种程度上破坏这个项目的整体设计（provider + template -> artifact），在某些地方做特殊判断和处理。 |
|
麻烦修复一下单测，我就合并 |
|
已经修正 |
|
非常感谢，我会尽快发布新版本！ |
Please consider complementing
CONTRIBUTING.md.