mirror of
https://github.com/MBombeck/HealthLog.git
synced 2026-11-07 04:12:04 +00:00
Marc-André Bombeck
c86c7d1a79
Add the in-repo rule `healthlog/import-boundaries`: - a file under src/lib may not import src/components or src/app (alias, relative, re-export and dynamic forms, type-only included); - a "use client" file may not make a value import of the database client, the crypto module, the Prisma client entry, the job queue, pg, pg-boss or next/headers. Type-only imports and the Prisma enums entry stay legal. The four lib files that still import upward are listed in the rule's allow map with a reason each; a listed file that stops importing upward is reported, so the map can only shrink. Five of the nine upward imports are gone by moving pure modules to their layer, without behaviour change: - supply-runway estimate → src/lib/medications/supply-runway.ts (read by the low-stock job and the medication list read); - weekday BYDAY tokens → src/lib/medications/scheduling/weekday-tokens.ts (read by the medication extraction prompt); - settings section slugs → src/lib/settings/section-slugs.ts (read by the record-settings classification); - the command palette index → src/components/command-palette/ (it is a client index built from component registries). Proof the rule can fail: an import of @/components/ui/card appended to src/lib/medications/supply-runway.ts reported libUpward, and a planted "use client" file importing @/lib/db reported clientServerOnly; both were removed again.
258 lines
14 KiB
JavaScript
258 lines
14 KiB
JavaScript
import { defineConfig, globalIgnores } from "eslint/config";
|
|
import nextVitals from "eslint-config-next/core-web-vitals";
|
|
import nextTs from "eslint-config-next/typescript";
|
|
import healthlogPlugin from "./eslint-plugins/healthlog/index.js";
|
|
|
|
const eslintConfig = defineConfig([
|
|
...nextVitals,
|
|
...nextTs,
|
|
// Override default ignores of eslint-config-next.
|
|
globalIgnores([
|
|
// Default ignores of eslint-config-next:
|
|
".next/**",
|
|
"out/**",
|
|
"build/**",
|
|
"next-env.d.ts",
|
|
// v1.31.4 — ignore local tool worktrees so a worktree on another
|
|
// commit cannot poison `pnpm lint` locally.
|
|
// CI never sees these paths; the rules protect the dev environment.
|
|
// `.wt-*` is the convention actually in use; the two names below predate
|
|
// it. Without the first pattern `pnpm lint` walks every worktree in the
|
|
// root, which is both slow and exactly the poisoning this list prevents.
|
|
".wt-*/**",
|
|
".claude/**",
|
|
".worktrees/**",
|
|
// The project-local ESLint rule plugin is CommonJS (require/module
|
|
// .exports) by ESLint convention; it is not application source and
|
|
// is not linted by the app's TypeScript ruleset.
|
|
"eslint-plugins/**",
|
|
"coverage/**",
|
|
"playwright-report/**",
|
|
"test-results/**",
|
|
// Third-party OCR engine copied from node_modules at prebuild/predev by
|
|
// scripts/stage-tesseract-assets.mjs; gitignored, minified, not ours.
|
|
"public/tesseract/**",
|
|
]),
|
|
// Factory enforcement for every client module: all components/hooks plus
|
|
// `"use client"` app/lib modules. Tests and `src/lib/query-keys/**` own
|
|
// literal fixtures/tuples and are exempt inside the rule.
|
|
{
|
|
plugins: { healthlog: healthlogPlugin },
|
|
rules: {
|
|
// The codebase already marks a deliberately unused binding by prefixing
|
|
// it with an underscore — a required-but-ignored route handler argument,
|
|
// a mock signature that has to match the real one. The rule did not know
|
|
// that convention, so seven such bindings warned and `pnpm lint` could
|
|
// not be read as pass/fail. Teaching it the convention is what makes a
|
|
// real warning visible again.
|
|
"@typescript-eslint/no-unused-vars": [
|
|
"warn",
|
|
{
|
|
argsIgnorePattern: "^_",
|
|
varsIgnorePattern: "^_",
|
|
caughtErrorsIgnorePattern: "^_",
|
|
destructuredArrayIgnorePattern: "^_",
|
|
},
|
|
],
|
|
"healthlog/queryKey-factory": "error",
|
|
// v1.5.6 — every outbound fetch under src/lib + src/app must route
|
|
// through the safeFetch wrapper (manual-redirect + timeout, and the
|
|
// requirePublicHost connect-time pin). The wrapper internals and
|
|
// test files are exempt; see the rule file for the allowlist.
|
|
"healthlog/safe-fetch-required": "error",
|
|
// Every raw fetch in the complete client surface is rejected regardless
|
|
// of whether the endpoint is a literal, template, variable, or map
|
|
// lookup. Envelope JSON uses the verb helpers; deliberate Response-level
|
|
// work and non-API external calls use the explicit `apiFetchRaw` escape
|
|
// hatch. Server-only modules, wrapper internals, and tests are exempt.
|
|
"healthlog/api-fetch-required": "error",
|
|
// v1.26.0 — the design-consistency wave locked the app's colour
|
|
// vocabulary onto semantic tokens. Raw Tailwind palette utilities
|
|
// (`text-amber-500`, `bg-green-500`, `dark:text-red-400`, …) under
|
|
// src/components + src/app are banned so the tokenised palette can't
|
|
// regress. v1.27.x extends the rule with two further error-level
|
|
// checks: colour-shaped JS props carrying a raw `#hex`/`rgb(`/`hsl(`/
|
|
// `oklch(` literal (the Recharts `color`/`stroke`/`fill` blind spot),
|
|
// and Tailwind arbitrary-value colours (`bg-[#…]`).
|
|
// `src/app/global-error.tsx` (renders without the token stylesheet),
|
|
// the `themeColor` viewport metadata, and test files are exempt; see
|
|
// the rule file.
|
|
"healthlog/no-raw-palette-color": [
|
|
"error",
|
|
{ checks: ["palette", "color-props", "arbitrary-value"] },
|
|
],
|
|
// The semantic sweep retired every raw `*-dracula-*` utility site
|
|
// (status meaning → success/warning/info/destructive, purple →
|
|
// primary, pink → the --brand-pink token), so the staged warning is
|
|
// now a hard error. `var(--dracula-*)` references in chart code are
|
|
// token references, not utilities, and stay legal — the light-theme
|
|
// overrides in globals.css keep them AA on both themes.
|
|
"healthlog/no-dracula-utility": ["error", { checks: ["dracula"] }],
|
|
// Spacing-scale discipline. Two error-clean checks: pt-/pb- on
|
|
// CardHeader/CardContent fights the gap-based Card contract (re-opens
|
|
// the sl-001 drift class), and an off-scale `5` step (p-5/py-5/space-y-5/
|
|
// gap-5) on a bg-card+border shell reads denser than every sibling
|
|
// <Card>. The shell check is scoped to the bg-card+border pair so
|
|
// justified list-marker insets (pl-5/pl-7) and form-body rhythm never
|
|
// trip it. Density lives on the Card itself (`gap-2 py-3 md:py-4`) or on
|
|
// a swept `p-4 md:p-6` shell. See the rule header.
|
|
"healthlog/spacing-scale": "error",
|
|
// Every pg-boss queue binding under src/lib/jobs goes through
|
|
// `createAndWork`, whose handler type is `(jobs) => Promise<JobOutcome>`.
|
|
// A bare `boss.work(` accepts a handler that resolves to nothing, which
|
|
// is how a swallowed failure came to read as a completed job. The rule
|
|
// catches the omission only — a handler that returns `{ ok: true }`
|
|
// after swallowing still passes, and its header says so.
|
|
"healthlog/job-handler-outcome": "error",
|
|
// The default zone is named once, in src/lib/tz/format.ts. A copy of the
|
|
// literal anywhere else is where a user outside that zone got someone
|
|
// else's calendar. src/lib/tz/ and test files are exempt; see the rule.
|
|
"healthlog/no-default-zone-literal": "error",
|
|
// A day is cut through src/lib/tz (userDayKey, dateOnlyKey,
|
|
// dateOnlyAtNoonUtc, dayKeyAsUtcMidnight), never by slicing an ISO string or by
|
|
// parsing a key as UTC midnight: each copy put an entry on the
|
|
// neighbouring day for someone off UTC. A site where UTC is meant
|
|
// carries `eslint-disable-next-line ... -- <reason>`; the rule refuses
|
|
// a directive without one. See the rule header.
|
|
"healthlog/no-utc-day-key": "error",
|
|
// A comment does not open with the identifier of the work item that
|
|
// produced it: those point into notes that never ship. A release
|
|
// version and an issue reference may stay. The matcher is shared with
|
|
// scripts/strip-planning-tags.mjs; see eslint-plugins/healthlog/
|
|
// planning-tags.js for the shape and its limits.
|
|
"healthlog/no-planning-tags": "error",
|
|
// A number shown to a person goes through useFormatters() (or
|
|
// makeFormatters / formatDecimal outside React), in src/components,
|
|
// src/app, src/hooks and src/lib: toFixed() prints a full stop in every
|
|
// language and a locale-less toLocaleString() follows the browser
|
|
// instead of the language picked in the app. SVG path data and other
|
|
// machine-read strings carry `eslint-disable-next-line ... -- <reason>`;
|
|
// the rule refuses a directive without one. See the rule header.
|
|
"healthlog/no-unlocalised-decimal": "error",
|
|
// A card surface is a <Card> (or SettingsCard / TrendTile), never a
|
|
// hand-rolled bg-card + border + rounded-xl (UI standards §1). The
|
|
// files below are where a shell is the point; each says why. A new
|
|
// exception is a reviewed change to this list, there is no inline
|
|
// escape. See the rule header.
|
|
"healthlog/no-raw-card-shell": [
|
|
"error",
|
|
{
|
|
allow: [
|
|
// The shell primitives themselves.
|
|
"src/components/settings/settings-card.tsx",
|
|
"src/components/medications/medication-detail-section.tsx",
|
|
// The sanctioned identity surface of the dashboard (§1).
|
|
"src/components/daily/today-hero.tsx",
|
|
"src/components/daily/today-hero-skeleton.tsx",
|
|
// Floating surfaces: a chart tooltip, the tour popovers, the
|
|
// wizard's icon tile.
|
|
"src/components/charts/chart-tooltip.tsx",
|
|
"src/components/onboarding/tour.tsx",
|
|
"src/components/medications/wizard/medication-wizard-dialog.tsx",
|
|
// The chart frame: chart, skeleton and error state paint the
|
|
// same frame so a chart never moves when it loads or fails.
|
|
"src/components/charts/health-chart.tsx",
|
|
"src/components/charts/chart-skeleton.tsx",
|
|
"src/components/charts/chart-error-state.tsx",
|
|
"src/components/charts/medication-compliance-chart.tsx",
|
|
"src/components/insights/derived/score-trend-chart.tsx",
|
|
"src/components/insights/intraday-pulse-chart.tsx",
|
|
// Table frames: a clipped, unpadded border around a table.
|
|
"src/components/medications/medication-table.tsx",
|
|
"src/app/notifications/page.tsx",
|
|
// Surfaces that render outside the app shell: sign-in, register,
|
|
// claim, the key-mismatch gate.
|
|
"src/app/auth/login/page.tsx",
|
|
"src/app/auth/register/page.tsx",
|
|
"src/components/auth/claim-profile.tsx",
|
|
"src/app/key-mismatch-page.tsx",
|
|
// The first-run flow: full-screen steps with their own rhythm.
|
|
"src/components/onboarding/anamnesis-card.tsx",
|
|
"src/components/onboarding/baseline-fields.tsx",
|
|
"src/components/onboarding/confirm-screen.tsx",
|
|
"src/components/onboarding/done-screen.tsx",
|
|
"src/components/onboarding/first-result-screen.tsx",
|
|
"src/components/onboarding/getting-started-checklist.tsx",
|
|
],
|
|
},
|
|
],
|
|
// Layer direction: src/lib never imports src/components or src/app, and
|
|
// a "use client" file makes no value import of the database client,
|
|
// crypto, the Prisma client entry, the job queue, pg or next/headers.
|
|
// The files below still import upward; each says why it has not moved.
|
|
// A listed file that stops importing upward fails until it is removed,
|
|
// so the map only shrinks. See the rule header.
|
|
"healthlog/import-boundaries": [
|
|
"error",
|
|
{
|
|
allow: {
|
|
"src/lib/insights/metric-catalog.ts":
|
|
"reads SUB_PAGE_TABS, which is declared inside the client tab strip component together with its labels and order",
|
|
"src/lib/insights/target-adjust-context.tsx":
|
|
"a React provider that renders TargetEditSheet; it belongs under components but has importers across 21 insight pages",
|
|
"src/lib/errors/error-toast.tsx":
|
|
"a React toast renderer that renders ErrorIdLine; it belongs under components but is imported by most client surfaces",
|
|
"src/lib/module-list-prefs.ts":
|
|
"a client hook module that raises the shared outcome toast; it moves with the module list settings surface",
|
|
},
|
|
},
|
|
],
|
|
},
|
|
},
|
|
// v1.28.17 — every recharts-rendering component funnels through the
|
|
// shared `chart-runtime.ts` barrel (see its file header): pointing N
|
|
// `next/dynamic` boundaries at N different modules mints a separate
|
|
// ~312 KB recharts chunk per boundary, a regression the project already
|
|
// paid for once. Direct `from "recharts"` imports outside the barrel's
|
|
// own static import graph previously only tripped the bundle-budget
|
|
// gate at PR-CI; this rule catches the same mistake at local lint,
|
|
// mirroring how `healthlog/safe-fetch-required` scopes its own
|
|
// wrapper-internals exemption by file list.
|
|
{
|
|
files: ["src/**/*.{ts,tsx}"],
|
|
ignores: [
|
|
"src/components/charts/chart-runtime.ts",
|
|
"src/components/admin/host-metrics-chart.tsx",
|
|
"src/components/charts/health-chart.tsx",
|
|
"src/components/charts/medication-compliance-chart.tsx",
|
|
"src/components/charts/mood-chart.tsx",
|
|
"src/components/charts/nutrient-daily-bar-chart.tsx",
|
|
"src/components/charts/scatter-correlation-chart.tsx",
|
|
"src/components/custom-metrics/custom-metric-chart.tsx",
|
|
"src/components/cycle/bbt-chart.tsx",
|
|
"src/components/insights/derived/delta-sparkline.tsx",
|
|
"src/components/insights/intraday-pulse-chart.tsx",
|
|
"src/components/insights/mood/mood-dimension-trends.tsx",
|
|
"src/components/insights/mood/mood-distribution-chart.tsx",
|
|
"src/components/insights/mood/mood-time-of-day-chart.tsx",
|
|
"src/components/insights/mood/mood-weekday-chart.tsx",
|
|
"src/components/insights/sleep-stage-stacked-bar.tsx",
|
|
"src/components/labs/lab-biomarker-chart.tsx",
|
|
"src/components/medications/detail/efficacy/efficacy-chart.tsx",
|
|
"src/components/medications/dose-strength-curve.tsx",
|
|
"src/components/medications/drug-level-chart.tsx",
|
|
"src/components/mental-health/assessment-history-chart.tsx",
|
|
"src/components/charts/workout-hr-chart.tsx",
|
|
"src/components/charts/workout-elevation-chart.tsx",
|
|
"src/components/insights/coach-panel/result-chart.tsx",
|
|
"src/components/insights/derived/score-trend-chart.tsx",
|
|
],
|
|
rules: {
|
|
"no-restricted-imports": [
|
|
"error",
|
|
{
|
|
paths: [
|
|
{
|
|
name: "recharts",
|
|
message:
|
|
"Import chart components through @/components/charts/chart-runtime (the shared dynamic-import barrel), not recharts directly — a second static import mints a duplicate recharts chunk. Add the component to chart-runtime.ts's export list if it's a new chart.",
|
|
},
|
|
],
|
|
},
|
|
],
|
|
},
|
|
},
|
|
]);
|
|
|
|
export default eslintConfig;
|