Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

feat: getClashNodeNames 增加默认节点 #251

Merged
merged 4 commits into from
Jan 19, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion docs/guide/custom-template.md
Original file line number Diff line number Diff line change
Expand Up @@ -295,11 +295,12 @@ ss://[email protected]:1234/?group=subscribe_demo#%F0%9F%87%AD%F0%9F

### getClashNodeNames

`getClashNodeNames(nodeList, filter?, prependNodeNames?)`
`getClashNodeNames(nodeList, filter?, prependNodeNames?, defaultNodeNames?)`

:::tip 提示
- `filter` 为可选参数
- `prependNodeNames` 为可选参数。可以通过这个参数在过滤结果前加入自定义节点名
- `defaultNodeNames` 为可选参数。可以通过这个参数实现在过滤结果为空的情况下,使用默认的自定义节点名
- [Clash 规则维护指南](/guide/client/clash.md)
:::

Expand All @@ -317,6 +318,12 @@ getClashNodeNames(nodeList, netflixFilter);
getClashNodeNames(nodeList, netflixFilter, ['测试节点']);
```

需要过滤 Netflix 节点,如果没有 Netflix 相关节点,则使用 `默认节点`

```js
getClashNodeNames(nodeList, netflixFilter, [], ['默认节点']);
```

### getLoonNodes

`getLoonNodes(nodeList, filter?)`
Expand Down
8 changes: 7 additions & 1 deletion src/utils/__tests__/clash.test.ts
Original file line number Diff line number Diff line change
Expand Up @@ -39,10 +39,16 @@ test('getClashNodeNames', async (t) => {
nodeNameList,
(nodeConfig) => nodeConfig.nodeName !== 'Test Node 3',
)

const result4 = clash.getClashNodeNames(
nodeNameList,
(nodeConfig) => nodeConfig.nodeName === 'Test Node 4',
[],
['DIRECT'],
)
t.deepEqual(result1, ['Test Node 1', 'Test Node 3'])
t.deepEqual(result2, ['TEST', 'Test Node 1', 'Test Node 3'])
t.deepEqual(result3, ['Test Node 1'])
t.deepEqual(result4, ['DIRECT'])

t.deepEqual(
clash.getClashNodeNames([
Expand Down
5 changes: 5 additions & 0 deletions src/utils/clash.ts
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,7 @@ export const getClashNodeNames = function (
list: ReadonlyArray<PossibleNodeConfigType>,
filter?: NodeFilterType | SortedNodeFilterType,
prependNodeNames?: ReadonlyArray<string>,
defaultNodeNames?: ReadonlyArray<string>,
): ReadonlyArray<string> {
// istanbul ignore next
if (arguments.length === 2 && typeof filter === 'undefined') {
Expand All @@ -47,6 +48,10 @@ export const getClashNodeNames = function (

result = result.concat(getClashNodes(list, filter).map((item) => item.name))

if (result.length === 0 && defaultNodeNames) {
result = result.concat(defaultNodeNames)
}

return result
}

Expand Down
Loading