@zedtech/zedkit-quality

Shared quality setup: UI lint preset, route/view/data layer boundaries, one strict TypeScript base, and repo hygiene bins. Consume it from any repo — do not copy it. Original work by the same author.

Install

pnpm add -D @zedtech/zedkit-quality

Peer dependencies (eslint, eslint-plugin-jsx-a11y, eslint-plugin-better-tailwindcss, typescript-eslint) install alongside it.

Usage

// eslint.config.mjs
import { defineLayers, uiPreset } from "@zedtech/zedkit-quality";

export default [
  ...uiPreset({ entryPoint: "./app/globals.css" }),
  ...defineLayers({
    kitPackage: "@acme/ui",
    viewDirs: ["app/**/ui/**"],
    dataDirs: ["lib/**"],
    actionPatterns: ["@/lib/*", "**/actions", "**/actions/**"],
  }),
];

// tsconfig.json
{
  "extends": "@zedtech/zedkit-quality/tsconfig",
  "compilerOptions": { "outDir": "dist", "rootDir": "src" },
  "include": ["src"]
}

// package.json — hygiene bins (optional extra --dirs/--files/--allow)
{
  "scripts": {
    "dev": "zedkit-sync-env && next dev",
    "check": "zedkit-check-no-artifacts && zedkit-check-no-secrets"
  }
}

When to use

Reach for this package when several repos must enforce the same gates: UI lint rules, layer boundaries, one strict tsconfig base, and the same artifact / secret / .env hygiene. One import (or bin) per need, versioned updates everywhere. For AI agent setup (skills, subagents, commands) see @zedtech/zedkit-ai instead.

API

• nodePreset({ tryCatchSource? }) — flat-config blocks for Node/TS packages: eslint + typescript-eslint recommended, raw try/catch ban, deep relative import ban. Default message points at @zedtech/zedkit-core; override tryCatchSource when the consumer re-exports the helpers under another name.
• uiPreset({ entryPoint }) — flat-config blocks for .tsx/.jsx: jsx-a11y recommended, Tailwind hygiene, tokens-only classes (no) w-[13px] / gap-[0.75rem]; Radix w-[var(--radix-*)] stays; no focus:ring-2 / focus-visible:ring-2 — use focus-ring), no style attributes, no forwardRef (ref is a prop; see packages/ui/src/button.tsx), no explicit any, files ≤ 300 lines and functions ≤ 60, no raw try/catch. entryPoint (your Tailwind CSS entry) is required: it is the one thing that varies per repo.
• defineLayers({ kitPackage, viewDirs, dataDirs, actionPatterns, extraPatterns }) — no-restricted-imports blocks for routes -> views -> data: the UI kit is only imported from views, views never import data clients or actions, data files import no UI. extraPatterns (optional, { kitScope?, viewData?, dataUi? }) merges your own bans into each block — use it instead of a second no-restricted-imports block, which would replace these per flat-config key semantics.
• defineLayers({ preset: "feature-folders", kitPackage, featureRoot }) — same helper, feature-folder mapping: UI imports ports (not adapters), adapters are injected at the composition root, model is pure. Bans apply only under featureRoot. Live example: apps/docs/features/note-list (running at /examples/note-list).
• @zedtech/zedkit-quality/tsconfig — the strict base (strict, exactOptionalPropertyTypes, noUncheckedIndexedAccess, noUnusedLocals, and more). Extend it, do not copy it.
• zedkit-sync-env [root] — copy .env.example to .env when missing; otherwise append keys the example gained. Existing values stay.
• zedkit-check-no-artifacts — fail if tracked files match the default artifact list (build/cache dirs, *.tsbuildinfo, Playwright reports…), match .gitignore (uses --no-index so ignored-but-tracked files are caught), or exceed 200KB. --dirs / --files / --allow (repeatable) append to the defaults; --max-bytes changes the cap.
• zedkit-check-no-secrets — fail if a tracked .env other than .env.example or a high-signal token/key pattern is in git.

Find helpers by need in CATALOG.md.

Install or copy?

Install it: these configs must stay identical across repos, and a copy drifts silently. Versioned updates propagate through normal bump PRs.

Verify

pnpm --filter @zedtech/zedkit-quality typecheck && pnpm --filter @zedtech/zedkit-quality lint && pnpm --filter @zedtech/zedkit-quality test