docs: explain third-party client integration

This commit is contained in:
xweiba
2026-08-09 01:07:25 +08:00
parent 8cc65172b2
commit 893f674004
6 changed files with 157 additions and 2 deletions
+8
View File
@@ -53,6 +53,14 @@ test "$(grep -c '^## ' "$ZH")" -eq "$(grep -c '^## ' "$EN")" \
grep -q '当前项目不支持在 Windows 上直接构建 iOS 应用' "$ZH" || fail "Chinese README must reject Windows source builds"
grep -q 'Building the iOS app directly on Windows is not supported' "$EN" || fail "English README must reject Windows source builds"
grep -q 'docs/COMMUNITY_TUTORIALS.md' "$ZH" || fail "Chinese README must link the community tutorial submission guide"
grep -q '^#### 配置接口与客户端适配$' "$ZH" \
|| fail "Chinese README must document the third-party integration contract"
grep -q '^#### Configuration API and Client Integration$' "$EN" \
|| fail "English README must document the third-party integration contract"
for contract in 'action=query' 'action=clear' 'lon=<WGS-84'; do
grep -q "$contract" "$ZH" || fail "Chinese README is missing third-party contract: $contract"
grep -q "$contract" "$EN" || fail "English README is missing third-party contract: $contract"
done
grep -q '除敏感信息遮挡外,不要自行添加箭头、编号、边框、说明文字或其他标注' \
"$ROOT/docs/COMMUNITY_TUTORIALS.md" \
|| fail "tutorial submissions must keep source screenshots free of non-privacy annotations"
+10
View File
@@ -27,6 +27,16 @@ grep -Fq 'Label("打开 \(client.name)"' "$SETUP" \
grep -Fq 'Label("打开 \(thirdPartyClient.selectedClient.name)"' "$SETTINGS" || fail "Settings must expose a client launch action"
! grep -q '在浏览器打开模块文件' "$SETTINGS" || fail "Settings must not open the module URL as the primary client action"
grep -q 'requestThirdPartySetup' "$SETTINGS" || fail "Settings must reopen third-party setup"
grep -q 'static let configurationEndpoint' "$MANAGER" \
|| fail "the third-party configuration endpoint must have one shared owner"
grep -q 'DisclosureGroup("第三方客户端适配说明")' "$SETUP" \
|| fail "client selection must expose the third-party integration contract"
grep -Fq '查询:GET ?action=query' "$SETUP" \
|| fail "client integration guidance must document the query action"
grep -Fq '保存:GET ?lon=<经度>&lat=<纬度>&acc=<精度>' "$SETUP" \
|| fail "client integration guidance must document WGS-84 coordinate saving"
grep -Fq '清除:GET ?action=clear' "$SETUP" \
|| fail "client integration guidance must document the clear action"
for file in wloc.module wloc.sgmodule wloc.conf wloc.lpx wloc.stoverride; do
test -s "$MODULES/$file" || fail "missing bundled module: $file"