mirror of
https://github.com/MHSanaei/3x-ui.git
synced 2026-08-20 10:00:58 +00:00
Sanaei
92fb94d856
* chore(frontend,docs): move to TypeScript 7 and replace ESLint with oxlint
TypeScript 7 is the native Go port and ships no programmatic compiler
API, so typescript-eslint cannot run at all: it peer-pins
typescript >=4.8.4 <6.1.0 (canary too) and hard-crashes with
"typescript-eslint does not support TS 7.0". Upstream support is
tracked in typescript-eslint#10940 and targets TS >=7.1.
Rather than wait, or carry Microsoft's side-by-side alias (which keeps
a second TS 6 install alive purely to feed the linter), both projects
move to oxlint, which never depended on the TypeScript API.
Typecheck drops from ~9.7s to ~2.2s and 167 packages leave frontend/.
oxlint has no no-restricted-syntax, so the #6121/#6127 cleared-
InputNumber guard is reimplemented as a JS plugin in
frontend/tools/oxlint/. It was verified to still fire in
pages/settings/** and pages/xray/** and to stay exempt in *Modal.tsx.
The type-aware @deprecated sweep survives too, as
`npm run lint:deprecated`: oxlint's type-aware mode runs on
oxlint-tsgolint, which drives the TS 7 typescript-go checker, so the
TS 7 move is what makes it possible.
Behaviour is preserved rather than tightened. jsx-a11y/prefer-tag-over-role
is off in both configs because it was never part of the recommended sets
ESLint actually ran, and oxlint honours the existing eslint-disable
comments, so no source churn was needed.
Two real fixes fell out of the stricter linting:
- outbound-link-parser.test.ts used `out?.streamSettings` behind an `as`
cast, which hid the optional chain from ESLint and would throw on a
null parse; the rest of the file already used `out!`.
- InputAddon's conditional role/tabIndex/onKeyDown is genuinely
accessible but oxlint cannot evaluate it, so it gets a scoped disable.
* chore(docs): replace Prettier with oxfmt
oxfmt is the oxc project's Prettier-compatible formatter, so this pairs
with the oxlint move and drops the last JS-based tool from the docs
toolchain.
The swap is behaviour-preserving. Running Prettier and oxfmt over the
same files, with the existing .prettierrc.json settings migrated via
`oxfmt --migrate=prettier`, produces byte-identical output on every
file. (Comparing them outside the project directory is misleading:
Prettier silently falls back to its defaults when it cannot find its
config, which looks like a mismatch but is not one.)
The 18 files reformatted here were already failing `pnpm format:check`
before this change — Prettier wanted the exact same edits. The check is
not part of docs-ci.yml, which is why the drift went unnoticed.
.prettierignore becomes ignorePatterns in .oxfmtrc.json, keeping the
deliberate MDX exclusion: reflowing MDX prose merges headings into
paragraphs and collapses lists inside Steps/Callout components. Both
that and the generated fumadocs-openapi reference output were verified
untouched.
oxfmt is pinned to 0.63.0 rather than latest. pnpm 11's built-in
minimumReleaseAge policy rejects same-day releases, and 0.64.0 would
have made pnpm silently append 20 waiver lines to pnpm-workspace.yaml.
* style(frontend): adopt oxfmt and format src
frontend/ has never had a formatter, so this reformats 344 of 497 files
in src/. The change is purely whitespace, quoting and line wrapping —
no logic is touched. It is kept in its own commit so it does not bury
the TypeScript 7 / oxlint migration or the git blame for the code
itself.
Settings match docs/ and the code as it was already written: single
quotes, semicolons, trailing commas, 2-space indent, 100 columns. That
was measured rather than assumed — src/ was already uniformly
single-quoted and 2-space indented, with p90 line length at 75.
Formatting is scoped to src/ (mirroring `oxlint src`) and
.oxfmtrc.json ignores src/generated. Both matter: `make gen-check`
compares src/generated and public/openapi.json, and
`make msw-worker-check` byte-compares public/mockServiceWorker.js
against the installed MSW runtime, so reformatting any of them breaks
the gate.
Reflowing also moves `eslint-disable-next-line` comments off the line
they guard, which broke two suppressions that had been silently
correct before:
- clone-inbound-modal.test.tsx: the object literal became multi-line,
leaving `} as any;` four lines below its no-explicit-any disable.
- ClientsPage.tsx: the useMemo dependency array moved onto its own
line, out from under its exhaustive-deps disable.
Both comments were relocated onto the line they actually guard, and
verified to still suppress by removing them and watching the errors
return.
* ci: enforce formatting in CI and make verify
Adding oxfmt in the previous two commits gave both projects a formatter
but nothing that checks it, which is how docs/ had already drifted to 18
unformatted files: docs-ci.yml runs typecheck, lint, test and build, but
never format:check, so Prettier's complaints were only ever visible to
whoever ran it by hand.
Wire `format:check` into the frontend job in ci.yml and the docs job in
docs-ci.yml, and add a `format-check` target to `make verify` so the
local gate keeps mirroring CI as the Makefile header promises.
Verified the step actually bites rather than passing vacuously: adding
a badly formatted line to a source file in each project makes both
`make format-check` and `pnpm format:check` fail, and reverting it makes
them pass again.
No workflow referenced ESLint or Prettier by name — they all invoke the
package scripts — so the tooling swap needed no other CI changes.
* ci: trigger CI on Makefile changes
The path filters listed **.go, go.mod, go.sum, frontend/**, .nvmrc and
ci.yml itself, but not the Makefile — so a change to the canonical task
runner that ci.yml is meant to mirror could land without any job
running. The previous commit, which edits both, only triggers because
it happens to touch ci.yml too.
* fix(frontend): replace deprecated Ant Design 6 APIs in the geo components
`npm run lint:deprecated` reported five uses of props Ant Design 6 has
deprecated. All five are gone, and the matching runtime warnings no
longer appear in the test output.
Tag `bordered={false}` becomes `variant="filled"` and Space `direction`
becomes `orientation`; both are the one-to-one replacements named in
antd's own deprecation messages, and `direction`/`orientation` share the
same Orientation type.
Input `addonAfter` is the one that is not a rename. It becomes a
`Space.Compact block` wrapping the Input and the browse Button, which is
antd's documented migration. `block` keeps the field filling its form
row as the addon did. Note this is a deliberate visual change: the
button used to be a borderless `type="text"` icon sitting inside the
addon's grey box, and is now a regular button whose border joins the
input. The tooltip, aria-label, ref, id and onBlur wiring are unchanged,
so the react-hook-form binding in RuleFormModal and the existing tests
still address it the same way.
Only these five were deprecated. The other `bordered` props in the tree
sit on QRCode, Table, Descriptions and Alert, where the prop is not
deprecated, and these were the only two Space `direction` uses in the
codebase.
* fix(frontend): restore lint rules lost in the oxlint migration, and test the guard
Addresses the review on #6262.
The frontend config re-enabled only no-explicit-any and no-unused-vars
and left the rest of tseslint's recommended set to oxlint's correctness
category. It does not cover all of it. Confirmed by linting one probe
file against both configs: docs/ (which enumerates the rules) reports
all nine, frontend/ reported four. So ban-ts-comment,
no-empty-object-type, no-namespace, no-require-imports and
no-unsafe-function-type had silently stopped being enforced — a `//
@ts-ignore` or a `namespace` block would have landed unflagged. The ten
rules are now mirrored from docs/.oxlintrc.json, and src/ still passes.
The #6121/#6127 guard was 57 lines of hand-written AST walking with no
test. It now has one: fixtures for the three banned shapes plus an
onNumber()-wrapped control, asserting the rule fires three times and
that .oxlintrc.json still wires it to the right paths. Verified it fails
for the right reason by making walk() enumerate nothing, which is the
silent-death mode the review described — the traversal depends on
Object.keys() seeing AST children as own enumerable properties.
The fixtures deliberately violate the rule, so their oxlint config is
named guard.oxlintrc.json rather than .oxlintrc.json: oxlint discovers
nested configs by directory, which would otherwise turn the fixtures
into three lint errors. The test passes it explicitly with -c.
Also from the review:
- lint and format now cover tools/ as well as src/, so the one piece of
hand-written lint logic in the repo is no longer the least covered
file in it.
- lint-staged runs oxfmt before oxlint --fix. Formatting became a hard
CI gate in this PR while the hook only ran the linter, so a commit
could pass the hook and fail CI on formatting alone.
- .oxfmtrc.json ignores public/, so the artefacts that make gen-check
and make msw-worker-check byte-compare stay safe even if oxfmt is
invoked without a path argument.
- The MDX and generated-reference rationales that .prettierignore
carried are back as comments in docs/.oxfmtrc.json — oxlint and oxfmt
both accept JSONC, so relocating them was unnecessary.
Not applied: the review also suggested restoring ../internal/web/dist to
the ignore lists. Both tools reject `..` patterns outright ("patterns
are resolved within the config file's directory"), and being outside
frontend/ it is unreachable anyway.
73 lines
4.0 KiB
Markdown
73 lines
4.0 KiB
Markdown
# frontend/CLAUDE.md
|
|
|
|
Frontend agent guide. Full detail: `frontend/README.md` and the root
|
|
`CONTRIBUTING.md` ("Working on the frontend"). This is the short version.
|
|
|
|
## What this is
|
|
React 19 + Ant Design 6 + Vite 8 + TypeScript. The Vite config is
|
|
`vite.config.js` (plain JS). Three bundles, each emitted into
|
|
`internal/web/dist/` and embedded into the Go binary:
|
|
- `index.html` — admin panel SPA (entry `src/main.tsx`; react-router under
|
|
`/panel`, lazy routes).
|
|
- `login.html` — login + 2FA (`src/entries/login.tsx`).
|
|
- `subpage.html` — public subscription viewer (`src/entries/subpage.tsx`).
|
|
The `@` import alias maps to `src/`.
|
|
|
|
## Data flow
|
|
- Server state via TanStack Query (`src/api/`, keys in `src/api/queryKeys.ts`);
|
|
invalidate on mutation. WebSocket pushes feed the cache
|
|
(`src/api/websocketBridge.ts`).
|
|
- Local UI state in the page (`useState`); shared concerns via `src/hooks/`.
|
|
Extend an existing hook before adding a global.
|
|
- Zod (`src/schemas/`) is the single source of truth for the xray config model.
|
|
Infer types with `z.infer`. Go-side types are mirrored into `src/generated/`
|
|
by `npm run gen:zod` (`go run ./tools/openapigen`) — do not hand-edit that
|
|
folder (every file is marked `DO NOT EDIT`).
|
|
- xray domain logic (links, defaults, form<->wire adapters) is pure functions in
|
|
`src/lib/xray/`. HTTP goes through `HttpUtil` in `src/utils/index.ts`.
|
|
|
|
## Rules
|
|
- Ant Design 6 for components; no Tailwind/shadcn (a migration was rolled back).
|
|
Form *state* runs on React Hook Form (`src/components/form/rhf/`), not Ant
|
|
Design's `Form` store.
|
|
- Function components + hooks only; no class components.
|
|
- Comments in committed TS/TSX: 2 lines MAX per comment block, spent on the
|
|
*why* a name cannot hold (same rule as root CLAUDE.md). HTML comments are fine.
|
|
- TS strict; oxlint's `typescript/no-explicit-any` is an error. Build forms with `useZodForm` +
|
|
`FormField` from `@/components/form/rhf` (wrap the tree in `FormProvider`);
|
|
validate through the `zodResolver` or per-field
|
|
`rules={{ validate: rhfZodValidate(Schema.shape.field) }}` — messages are Zod
|
|
issue keys resolved via `t()`, never inline `z.string()`. AntD `<Form>` stays
|
|
only as a layout wrapper. Complex shared config editors (FinalMask / Sniffing /
|
|
Sockopt) remain AntD-`Form` islands wrapped as value/onChange adapters in
|
|
`src/lib/xray/forms/fields/`, bound via a `Controller`.
|
|
- New `g.POST`/`g.GET` route => add it to `src/pages/api-docs/endpoints.ts`,
|
|
then `npm run gen`.
|
|
- i18n strings live in `internal/web/translation/<locale>.json`, NOT under
|
|
`frontend/`, and are shared with the Go backend. A new English key must be
|
|
added to every locale. Interpolation here uses single braces `{var}`, not the
|
|
i18next default `{{var}}`.
|
|
- Persian/Arabic (RTL) users are first-class — isolate code identifiers on their
|
|
own line when writing Persian text in labels/toasts.
|
|
- Vite is pinned to an exact version (no `^`) — bump deliberately, then verify
|
|
`npm run dev` AND `npm run build`.
|
|
|
|
## Adding a panel route
|
|
1. `src/pages/<page>/<Page>.tsx` (kebab folder, PascalCase component).
|
|
2. Register in `src/routes.tsx` under `/panel` (lazy import).
|
|
3. Add a sidebar link in `src/layouts/AppSidebar.tsx` if it needs nav.
|
|
Only standalone bundles (login/subpage) need a new `.html` + `src/entries/*` +
|
|
`rollupOptions.input` (in `vite.config.js`) + a Go controller route.
|
|
|
|
## Commands
|
|
- `npm run dev` (HMR on :5173, proxies to the Go panel on :2053 — start Go first).
|
|
- `npm run typecheck` / `npm run lint` / `npm run test` / `npm run build`.
|
|
- `npm run gen` = `gen:zod` (Go → `src/generated/`) + `gen:api`
|
|
(`build-openapi.mjs` → `public/openapi.json`).
|
|
- `npm run storybook` (workbench on :6006) / `npm run build-storybook` (CI
|
|
compile-checks every story). Reusable `src/components/` get a co-located
|
|
`<Component>.stories.tsx` with `tags: ['autodocs']`; document props via
|
|
`argTypes` / `parameters.docs` string metadata, never JSDoc.
|
|
- After `npm run build`, RESTART `go run .` (see the XUI_DEBUG gotcha in root
|
|
CLAUDE.md) before checking the panel.
|