mirror of
https://github.com/civitai/civitai.git
synced 2026-09-20 22:08:18 +08:00
docs: drop package and component counts that had gone stale
`@civitai/ui` gaining a vitest config took the packages/* suites to 13, and the primitives under components/ui/ are at 54 — while the prose still said nine and 24. The counts are removed rather than corrected: CI's ledger script already asserts every workspace suite ran, so a number in prose only rots, and both of these had rotted twice. The schema-drift README also said apps/* had no CI job and that the ledger script hardcoded `packages/`. Both stopped being true when the App unit tests + typecheck job landed; it takes the workspace as an argument. Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
@@ -589,7 +589,7 @@ jobs:
|
||||
packages:
|
||||
name: Package unit tests
|
||||
runs-on: ubuntu-latest
|
||||
# The nine `packages/*` suites — 616 tests that, until this job existed, NO CI job ran.
|
||||
# The `packages/*` suites — 616 tests when this job was added, which until then NO CI job ran.
|
||||
# The `unit` job above runs `vitest run --project unit`, whose `include` is root-relative
|
||||
# (`src/**`, `scripts/**`), so nothing in this repo ever invoked a workspace package's
|
||||
# suite. That is not a small gap: the schema-drift detector shipped 81 tests into it,
|
||||
|
||||
@@ -56,7 +56,7 @@ main app's React/Mantine components — these apps are **Svelte 5 / SvelteKit /
|
||||
- [`docs/auth/spoke-integration-guide.md`](auth/spoke-integration-guide.md) + [`docs/auth/auth-hub-spoke-overview.md`](auth/auth-hub-spoke-overview.md)
|
||||
— the hub↔spoke auth contract (`civ-token`, `@civitai/auth`, `createSpokeGuard`).
|
||||
- [`packages/civitai-ui/README.md`](../packages/civitai-ui/README.md) — **`@civitai/ui`**, the shared shadcn-svelte
|
||||
component package (24 primitives + dark-only theme, Tailwind v4). Consume it; add new *shared* components into it, not
|
||||
component package (shadcn-svelte primitives + dark-only theme, Tailwind v4). Consume it; add new *shared* components into it, not
|
||||
into the app.
|
||||
|
||||
**Scaffolding:** use the **`scaffold-civitai-app`** skill to stand up `apps/creator-studio`. It cherry-picks only the
|
||||
|
||||
@@ -21,7 +21,7 @@ app:
|
||||
accessible, Tailwind-styled primitives we'd otherwise get wrong by hand.
|
||||
|
||||
The shadcn-svelte primitives are already vendored as the shared **[@civitai/ui](../../packages/civitai-ui/README.md)**
|
||||
package (24 components + theme, Tailwind v4). New SvelteKit apps consume it rather than re-running the CLI —
|
||||
package (shadcn-svelte primitives + theme, Tailwind v4). New SvelteKit apps consume it rather than re-running the CLI —
|
||||
see its README for the 4-line bootstrap (`workspace:*` dep, `ssr.noExternal`, `@import "@civitai/ui/theme.css"`,
|
||||
one `@source`). Add new shared components *into* that package, not into an app.
|
||||
|
||||
|
||||
@@ -264,7 +264,7 @@ They now run in the `Package unit tests` job, from the `packages/*/vitest.config
|
||||
the root `vitest.config.mts`:
|
||||
|
||||
```bash
|
||||
pnpm run test:packages:run # all nine package suites
|
||||
pnpm run test:packages:run # every package suite
|
||||
pnpm --filter @civitai/db-schema test # just this one
|
||||
```
|
||||
|
||||
@@ -278,11 +278,9 @@ Two things it is worth being precise about, because both are easy to overstate:
|
||||
- **It is not an interlock.** `main` has branch protection but no `required_status_checks`, so
|
||||
a red `Package unit tests` does not prevent a merge. It renders red rather than
|
||||
red-but-ignored, which is the real difference from the `Unit tests` job.
|
||||
- **The workspace gap is not closed, only the `packages/*` part of it.** `apps/*` has four
|
||||
more vitest configs and ~43 test files that still no CI job runs. Same one-line fix — another
|
||||
glob in the same `projects` array — plus teaching the ledger script about `apps/`, which
|
||||
currently hardcodes `packages/`. Deliberately left to a follow-up rather than widened into
|
||||
the change that closed the first part.
|
||||
- **`apps/*` runs in a sibling job**, `App unit tests + typecheck`, closed the same way: another
|
||||
glob in the same `projects` array, and the ledger script takes the workspace (`packages` or
|
||||
`apps`) as an argument rather than hardcoding one.
|
||||
|
||||
## Gating a pull request
|
||||
|
||||
|
||||
Reference in New Issue
Block a user