longbridge__developers

skills/longbridge__developers

Fork 0

mirror of https://github.com/longbridge/developers.git synced 2026-09-19 03:34:09 +08:00

Commit Graph

Author	SHA1	Message	Date
hold-baby	b952761fa6	Complete .com→.cn hostname rewrite for CN region build (#1100 ) ## Merge Verdict [APPROVE] — Region URL rewriting is now complete across every artifact channel; global build verified untouched. > 6 files · +73 / -26 · `docs/.vitepress` `scripts/` `package.json` --- ## Summary - Extract a shared `buildRegionUrlReplacements()` in `region-utils.ts` that emits four rules per non-default hostname (protocol-prefixed + bare-text for both `siteHostname` and `apiBaseUrl`), and route the four pre-existing rewrite sites (`region-filter.ts`, `transformHtml`, `buildEnd install`, plus the new ones) through it. - Add a new Vite `region-source-url-rewrite` plugin (`enforce: 'pre'`) that rewrites hardcoded hostnames inside `.vue/.ts/.json/.yaml` source modules — this is the only channel that reaches Vite-compiled JS bundles (install command strings in Vue components, `mcp-tools.json` connect links, `openapi.yaml` error-message text). - Bring `.md` copies + `llms.txt` into region rewriting: `normalize_md.ts` (the real writer of `dist/*/.md`) and `generate-llms.ts` (the static `llms-intro.md` injection point) now share the same helper. - Fix root-cause env-leak: `build:cn` now also passes `VITE_REGION=cn` to the `bun run build:llms` segment — previously `cross-env` only scoped to the `vitepress build` process, so `normalize_md`/`generate-llms` never knew it was a CN build and silently produced `.com` artifacts. --- ## Risk Analysis \| Risk \| Level \| Mitigation \| \|------\|-------\|-----------\| \| Global build (`build:release`) accidentally rewritten \| ✅ \| Shared helper returns `[]` when `VITE_REGION` is unset → every call site is a no-op. Verified: `dist/longbridge-terminal/install.ps1` is byte-identical to source; `mcp.html` keeps all 9 `.com`; `llms-full.txt` keeps all 112 `open.longbridge.com`. \| \| Bare-rule replacement double-matches \| ✅ \| `open.longbridge.com` is not a substring of `openapi.longbridge.com` (5th char `.` vs `a`), so the four rules are mutually independent regardless of order. \| \| Vite `transform` runs on every module — performance hit \| 🟢 \| `buildRegionUrlReplacements()` is lightweight (one env read + small array build). On global builds it short-circuits via `replacements.length === 0`. \| \| `enforce: 'pre'` ordering vs `yaml-transform` \| ✅ \| `'pre'` plugins run before normal plugins, so this transform sees raw YAML text and rewrites it before `yaml-transform` JSON-stringifies it. \| \| Hardcoded global hostnames in helper \| 🟡 \| Helper compares against the literal `'https://open.longbridge.com'` / `'https://openapi.longbridge.com'`. If the global domain ever changes, this file plus `region.config.ts` must be updated together. Same constraint already existed before this PR. \| --- ## Design Decisions - Centralize rules in `region-utils.ts` instead of inlining at four call sites — four sites already drifted (HTML had two rules but markdown had only the URL form before the previous PR). One source of truth prevents future drift. - Pre-stage Vite transform rather than a post-build dist scan — keeps source maps intact and lets the rewrite participate in dependency invalidation. It also naturally covers `openapi.yaml` (huge but fine — string `split/join` is O(n) and only runs once per module per build). - Bare-hostname rules alongside URL rules — covers `[open.longbridge.com/connect](https://...)` markdown patterns where only the link target gets matched by URL rules; the display text needs the bare-host rule. - Source `install` / `install.ps1` keep `.com` — global build's `buildEnd` already had a rewrite pass; making source `.com`-default lets the existing rewrite mechanism do the work and avoids two source-of-truth files. --- ## Code Notes 1. [Info] `region-utils.ts:25` comment "first so bare rules don't double-match" In practice both orderings are correct because after either rule runs the other one's "from" string no longer exists in the result. The note is defensive rather than load-bearing. — Author note: deferred to next iteration. 2. [Info] `config.mts` Vite transform hook calls `buildRegionUrlReplacements()` per module The helper is cheap but is invoked once per source module on every build. Could be hoisted to the closure top if profiling ever flags it; not worth the structural change today. — Author note: deferred to next iteration. 3. [Info] `package.json` build:cn duplicates `cross-env VITE_REGION=cn` across two segments Maintainable but easy to forget if a third stage is added later. Could be solved with `cross-env-shell` wrapping the whole chain, but that's a separate cleanup. — Author note: deferred to next iteration. 4. [Needs review] Vite `transform` regex includes `.yaml`/`.yml` This is intentional — `openapi.yaml` ships hardcoded `https://open.longbridge.com/sdk` and error-message URLs that must be rewritten for CN. Reviewer should confirm there's no other YAML in the dependency graph whose `.com` strings must be preserved as global references. None observed in the current tree. --- ## Verification - ✅ `bun run build:cn` succeeds; `rg -l '(open\|openapi)\.longbridge\.com' docs/.vitepress/dist` → zero residual `.com` across HTML/MD/JS/scripts. - ✅ `bun run build:release` succeeds; `install.ps1` and `install` are byte-identical to source; `mcp.html` keeps 9× `.com`; `llms-full.txt` keeps 112× `open.longbridge.com`; CN endpoint mentions inside docs (`getting-started.md` etc.) are preserved as intended. - ✅ `openapi-quote.longbridge.cn` / `openapi-trade.longbridge.cn` counts in `getting-started.html` match source 1:1 (no over-rewrite). - 📋 Reviewer to confirm: CN site (`open.longbridge.cn`) renders `mcp.md` / `skill/install` pages with the new URLs after deploy. Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>	2026-06-18 11:37:13 +08:00
Endless	8becc115ca	feat(quote-permission): add quote permission notices to CLI docs, API docs, and API Reference (#939 ) 🤖 Auto-generated by Endless. --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com> Co-authored-by: Jason Lee <huacnlee@gmail.com>	2026-05-05 18:37:25 +08:00
Jason Lee	0add508ae2	feat: add Skill page with interactive demo (#376 ) ## Summary - New `/skill` page with full trilingual support (en / zh-CN / zh-HK) - Interactive chat demo: 4 scenarios (Live Quote, Portfolio, Subscription, Earnings) × 5 AI clients (OpenClaw, ChatGPT, Claude, Claude Code, Codex) with typewriter animation - Rich response rendering: tables with Shadcn-style borders, mini SVG sparkline charts, syntax-highlighted code blocks - Scenario cards section below the demo describing use cases - Nav update: Skill link added to all three locale nav configs ## Bug Fixes - Syntax highlighter: replaced chained-regex approach with a single-pass tokenizer. The old code ran number → keyword → string regexes sequentially on the same string — the keyword regex matched `class` inside generated `<span class="hl-n">` attributes, and the string regex matched `"hl-n"` as a string literal, corrupting the HTML structure entirely - v-html routing: replaced `currentMessages[2]?.rich` template condition with an explicit `isRichResponse` ref set in `runAnimation()` to prevent incorrect branch selection when switching client tabs ## Test plan - [ ] Visit `/skill`, `/zh-CN/skill`, `/zh-HK/skill` — page loads in all locales - [ ] Click through all 4 scenario tabs — animation plays correctly for each - [ ] Click through all 5 client tabs — correct message shown, Claude Code tab shows syntax-highlighted code (not raw HTML) - [ ] Verify sparkline charts render in the Live Quote / OpenClaw scenario - [ ] Verify table borders render correctly (outer border + row dividers, no missing bottom border) - [ ] Verify gain/loss values show green/red colors in tables 🤖 Generated with [Claude Code](https://claude.com/claude-code) --------- Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>	2026-03-23 20:03:14 +08:00

Author

SHA1

Message

Date

hold-baby

b952761fa6

Complete .com→.cn hostname rewrite for CN region build (#1100 )

## Merge Verdict
**[APPROVE]** — Region URL rewriting is now complete across every
artifact channel; global build verified untouched.
> 6 files · +73 / -26 · `docs/.vitepress` `scripts/` `package.json`

---
## Summary
- Extract a shared `buildRegionUrlReplacements()` in `region-utils.ts`
that emits **four** rules per non-default hostname (protocol-prefixed +
bare-text for both `siteHostname` and `apiBaseUrl`), and route the four
pre-existing rewrite sites (`region-filter.ts`, `transformHtml`,
`buildEnd install`, plus the new ones) through it.
- Add a new Vite `region-source-url-rewrite` plugin (`enforce: 'pre'`)
that rewrites hardcoded hostnames inside `.vue/.ts/.json/.yaml` source
modules — this is the only channel that reaches Vite-compiled JS bundles
(install command strings in Vue components, `mcp-tools.json` connect
links, `openapi.yaml` error-message text).
- Bring `.md` copies + `llms.txt` into region rewriting:
`normalize_md.ts` (the real writer of `dist/**/*.md`) and
`generate-llms.ts` (the static `llms-intro.md` injection point) now
share the same helper.
- Fix root-cause env-leak: `build:cn` now also passes `VITE_REGION=cn`
to the `bun run build:llms` segment — previously `cross-env` only scoped
to the `vitepress build` process, so `normalize_md`/`generate-llms`
never knew it was a CN build and silently produced `.com` artifacts.

---
## Risk Analysis
| Risk | Level | Mitigation |
|------|-------|-----------|
| Global build (`build:release`) accidentally rewritten | ✅ | Shared
helper returns `[]` when `VITE_REGION` is unset → every call site is a
no-op. Verified: `dist/longbridge-terminal/install.ps1` is
byte-identical to source; `mcp.html` keeps all 9 `.com`; `llms-full.txt`
keeps all 112 `open.longbridge.com`. |
| Bare-rule replacement double-matches | ✅ | `open.longbridge.com` is
**not** a substring of `openapi.longbridge.com` (5th char `.` vs `a`),
so the four rules are mutually independent regardless of order. |
| Vite `transform` runs on every module — performance hit | 🟢 |
`buildRegionUrlReplacements()` is lightweight (one env read + small
array build). On global builds it short-circuits via
`replacements.length === 0`. |
| `enforce: 'pre'` ordering vs `yaml-transform` | ✅ | `'pre'` plugins
run before normal plugins, so this transform sees raw YAML text and
rewrites it before `yaml-transform` JSON-stringifies it. |
| Hardcoded global hostnames in helper | 🟡 | Helper compares against the
literal `'https://open.longbridge.com'` /
`'https://openapi.longbridge.com'`. If the global domain ever changes,
this file plus `region.config.ts` must be updated together. Same
constraint already existed before this PR. |

---
## Design Decisions
- **Centralize rules in `region-utils.ts`** instead of inlining at four
call sites — four sites already drifted (HTML had two rules but markdown
had only the URL form before the previous PR). One source of truth
prevents future drift.
- **Pre-stage Vite transform** rather than a post-build dist scan —
keeps source maps intact and lets the rewrite participate in dependency
invalidation. It also naturally covers `openapi.yaml` (huge but fine —
string `split/join` is O(n) and only runs once per module per build).
- **Bare-hostname rules alongside URL rules** — covers
`[open.longbridge.com/connect](https://...)` markdown patterns where
only the link target gets matched by URL rules; the display text needs
the bare-host rule.
- **Source `install` / `install.ps1` keep `.com`** — global build's
`buildEnd` already had a rewrite pass; making source `.com`-default lets
the existing rewrite mechanism do the work and avoids two
source-of-truth files.

---
## Code Notes
1. **[Info]** `region-utils.ts:25` comment "first so bare rules don't
double-match"
In practice both orderings are correct because after either rule runs
the other one's "from" string no longer exists in the result. The note
is defensive rather than load-bearing.
   — Author note: deferred to next iteration.
2. **[Info]** `config.mts` Vite transform hook calls
`buildRegionUrlReplacements()` per module
The helper is cheap but is invoked once per source module on every
build. Could be hoisted to the closure top if profiling ever flags it;
not worth the structural change today.
   — Author note: deferred to next iteration.
3. **[Info]** `package.json` build:cn duplicates `cross-env
VITE_REGION=cn` across two segments
Maintainable but easy to forget if a third stage is added later. Could
be solved with `cross-env-shell` wrapping the whole chain, but that's a
separate cleanup.
   — Author note: deferred to next iteration.
4. **[Needs review]** Vite `transform` regex includes `.yaml`/`.yml`
This is intentional — `openapi.yaml` ships hardcoded
`https://open.longbridge.com/sdk` and error-message URLs that must be
rewritten for CN. Reviewer should confirm there's no other YAML in the
dependency graph whose `.com` strings must be preserved as global
references. None observed in the current tree.

---
## Verification
- ✅ `bun run build:cn` succeeds; `rg -l
'(open|openapi)\.longbridge\.com' docs/.vitepress/dist` → **zero
residual `.com`** across HTML/MD/JS/scripts.
- ✅ `bun run build:release` succeeds; `install.ps1` and `install` are
byte-identical to source; `mcp.html` keeps 9× `.com`; `llms-full.txt`
keeps 112× `open.longbridge.com`; CN endpoint mentions inside docs
(`getting-started.md` etc.) are preserved as intended.
- ✅ `openapi-quote.longbridge.cn` / `openapi-trade.longbridge.cn` counts
in `getting-started.html` match source 1:1 (no over-rewrite).
- 📋 Reviewer to confirm: CN site (`open.longbridge.cn`) renders `mcp.md`
/ `skill/install` pages with the new URLs after deploy.

Co-authored-by: 袁昌瑞 <changrui.yuan@longbridge-inc.com>

2026-06-18 11:37:13 +08:00

Endless

8becc115ca

feat(quote-permission): add quote permission notices to CLI docs, API docs, and API Reference (#939 )

🤖 Auto-generated by Endless.

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>
Co-authored-by: Jason Lee <huacnlee@gmail.com>

2026-05-05 18:37:25 +08:00

Jason Lee

0add508ae2

feat: add Skill page with interactive demo (#376 )

## Summary

- **New `/skill` page** with full trilingual support (en / zh-CN /
zh-HK)
- **Interactive chat demo**: 4 scenarios (Live Quote, Portfolio,
Subscription, Earnings) × 5 AI clients (OpenClaw, ChatGPT, Claude,
Claude Code, Codex) with typewriter animation
- **Rich response rendering**: tables with Shadcn-style borders, mini
SVG sparkline charts, syntax-highlighted code blocks
- **Scenario cards section** below the demo describing use cases
- **Nav update**: Skill link added to all three locale nav configs

## Bug Fixes

- **Syntax highlighter**: replaced chained-regex approach with a
single-pass tokenizer. The old code ran number → keyword → string
regexes sequentially on the same string — the keyword regex matched
`class` inside generated `<span class="hl-n">` attributes, and the
string regex matched `"hl-n"` as a string literal, corrupting the HTML
structure entirely
- **v-html routing**: replaced `currentMessages[2]?.rich` template
condition with an explicit `isRichResponse` ref set in `runAnimation()`
to prevent incorrect branch selection when switching client tabs

## Test plan

- [ ] Visit `/skill`, `/zh-CN/skill`, `/zh-HK/skill` — page loads in all
locales
- [ ] Click through all 4 scenario tabs — animation plays correctly for
each
- [ ] Click through all 5 client tabs — correct message shown, Claude
Code tab shows syntax-highlighted code (not raw HTML)
- [ ] Verify sparkline charts render in the Live Quote / OpenClaw
scenario
- [ ] Verify table borders render correctly (outer border + row
dividers, no missing bottom border)
- [ ] Verify gain/loss values show green/red colors in tables

🤖 Generated with [Claude Code](https://claude.com/claude-code)

---------

Co-authored-by: Claude Sonnet 4.6 <noreply@anthropic.com>

2026-03-23 20:03:14 +08:00

3 Commits