Skip to content

Use it in your project

There are two ways in. Start a new repo from the template, or bring the plugin into an existing pnpm workspace.

Terminal window
gh repo create <name> --template JakubSzwajka/house-rules
cd <name>
corepack enable
pnpm install --frozen-lockfile
pnpm check && pnpm test

Then make it yours:

  1. Rename @hosti/ everywhere: package names, imports, Context.Service keys, and the scope passed to layout() in .dependency-cruiser.cjs.
  2. Rewrite AGENTS.md for your project, and write your own VISION.md.
  3. Replace apps/api and packages/bookings with your own code. Keep their shape.
  4. Run pnpm check and pnpm test again.

The README’s adapt it list names every file to copy when you start from an existing repo instead.

The plugin is not on npm. Install it from GitHub, pinned to a full 40-character commit, with a pnpm subpath:

{
"devDependencies": {
"@house-rules/rules": "github:JakubSzwajka/house-rules#<full-40-char-sha>&path:/packages/rules"
}
}

You need Node 24.21 or later, pnpm, and a pnpm-workspace.yaml with a packages: list. Each entry point has optional peers that you install yourself. The README of the plugin lists them: packages/rules/README.md. Then wire the thin configs as the stack shows.

@house-rules/capability installs the same way, with &path:/packages/capability. It needs effect pinned to the exact version it names as a peer. Its README walks through the tsconfig flags, Next.js, and tests: packages/capability/README.md.

Change the SHA, run pnpm install, and run your checks. Read the rule docs that changed between the two commits first. A new rule can fail code that passed yesterday, and that is the point.