v3: src/ gets one layout rule and keeps to it — each layer holds one kind of module, and every layer is split into the same domains — the previous pass sorted components into folders but left hooks, helpers and a barrel inside them, kept hooks/, utils/ and contexts/ flat, and still grouped most tests by theme. The rule: components/ holds only components (.tsx), contexts/ holds FooContext.ts + FooProvider.tsx pairs, hooks/ every hook, utils/ every non-React module, pages/ one component per route and nothing else. Each of components/, contexts/, hooks/ and utils/ is split into the same domains — auth, category, chat, comment, dump, editor, feed, form, layout, player, playlist, profile, social, theme, ws — plus shared/ for what belongs to no one domain, so the chat is components/chat, contexts/chat, hooks/chat and utils/chat. components/ui becomes components/shared to match. Out of components/: useApiForm goes to hooks/form, chat's message.ts and time.ts to utils/chat (with chatDraft and chatText, now draft.ts and text.ts), the emoji skin tone to utils/editor, the remembered volume to utils/player; player/icons.tsx is PlayerIcons.tsx. components/form/index.ts is gone: everything is imported from its own file, FormProvider straight from react-hook-form, and expectOk sits beside friendlyFetchError in utils/shared/api.ts (apiError.ts), since pages that have no form used it too. Out of pages/: the index's feed views, tab bar and presence row move to components/feed; HotFeed and NewFeed, identical but for the sort, are one DumpFeed with an order prop, which also takes over MainFeedProps from pages/index/types.ts. App is a named export like everything else. Tests mirror the tree one file per module — test/<layer>/<domain>/<Module>.test.tsx — so the themed files (hooks/misc, data, editor, sync; utils/misc, text, storage, remote, journal; contexts/providers; pages/auth and UserSubpages; layout/Fabs) are split by subject, the setup each piece needs kept and the rest dropped; the floating-button test becomes one test per button, 627 tests now. The README states the rule. No behaviour changes; the catalogues only move their source references.
Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
This commit is contained in:
34
README.md
34
README.md
@@ -124,29 +124,23 @@ api/
|
||||
uploads/ # User-uploaded files — avatars, dumps, thumbnails, … (not committed)
|
||||
src/ # React frontend (Vite)
|
||||
config/ # API base URL, validation constants, feed tabs, upload limits
|
||||
pages/ # Route-level components
|
||||
index/ # Feed views (hot, new, followed, journal), feed tab bar, presence row
|
||||
components/ # Shared UI components, by feature
|
||||
category/ # Category picker, switcher and manager
|
||||
chat/ # The chat modal and its message rows
|
||||
comment/ # Comment threads, nodes and forms
|
||||
dump/ # Dump cards, rich-content and file previews
|
||||
create/ # The three-step new-dump modal
|
||||
editor/ # Text editor, emoji picker, mentions, Markdown
|
||||
form/ # Reusable form controls
|
||||
layout/ # Header, page shell, floating buttons
|
||||
player/ # Media player, global player, seek bar, waveform
|
||||
playlist/ # Playlist cards, creation and membership
|
||||
profile/ # Profile subpage header, password change
|
||||
social/ # Vote, like and follow buttons, who-voted popover
|
||||
ui/ # Generic pieces: modal, tooltip, tabs, avatar, thumbnails
|
||||
test/ # Frontend tests (Vitest), mirroring src/
|
||||
contexts/ # Auth, WebSocket, player, follows, theme
|
||||
hooks/ # Data fetching and UI hooks
|
||||
utils/ # Formatting, URL, hot-score, waveform, … helpers
|
||||
pages/ # One component per route, nothing else
|
||||
components/ # React components only (.tsx)
|
||||
contexts/ # FooContext.ts + FooProvider.tsx pairs
|
||||
hooks/ # Every hook (useFoo.ts)
|
||||
utils/ # Every non-React module: pure helpers, storage, API glue
|
||||
test/ # Frontend tests (Vitest): test/<layer>/<domain>/<Module>.test.tsx
|
||||
locales/ # Lingui message catalogues (en, fr)
|
||||
themes/ # Per-theme CSS files
|
||||
model.ts # Shared frontend types
|
||||
i18n.ts # Lingui runtime setup
|
||||
public/ # Static assets (favicon, manifest, service worker)
|
||||
```
|
||||
|
||||
Each of `components/`, `contexts/`, `hooks/` and `utils/` is split into the
|
||||
same domain folders — `auth`, `category`, `chat`, `comment`, `dump`, `editor`,
|
||||
`feed`, `form`, `layout`, `player`, `playlist`, `profile`, `social`, `theme`,
|
||||
`ws` — plus `shared/` for what belongs to no single domain. So the chat lives in
|
||||
`components/chat/`, `contexts/chat/`, `hooks/chat/` and `utils/chat/`, and its
|
||||
tests in `test/<same path>`. Files are imported directly (no `index.ts`
|
||||
barrels), and everything uses named exports.
|
||||
|
||||
Reference in New Issue
Block a user