@ingenioz-it/caits 0.0.0-stage → 0.5.0

package/template/empty/test/e2e/home.spec.ts

@@ -0,0 +1,6 @@
+import { expect, test } from "@playwright/test";
+
+test("Given a visitor, When they open the home page, Then it shows the name of the app", async ({ page }) => {
+  await page.goto("/");
+  await expect(page.getByRole("heading", { level: 1 })).toHaveText("My app");
+});

package/template/project/AGENTS

@@ -0,0 +1,28 @@
+# AGENTS.md
+
+A CAITS project (Clean Architecture In TypeScript): a Marko app with a backend and a frontend. A harness checks every change.
+
+## Commands
+
+- `npm run check`: all the checks at once: types, lint, architecture rules, unit tests (100% coverage), mutation tests (100% score), end-to-end tests. The work is done only when it passes. It prints only the output of the checks that fail.
+- `npm run tdd`: the unit tests, then at each save the tests of the changed files. In an AI agent, Vitest runs them once and stops: run it again after a change.
+- `npm run lint:architecture`: the architecture rules alone, fast.
+- `npx caits mutation-summary --survivors`: the mutants that survived the last mutation run.
+
+## Where the code goes
+
+- The business lives in bounded contexts: `src/backend/<context>/` and `src/frontend/<context>/`, each with `domain/`, `application/`, `infra/`, `presentation/` and a `di.ts`. To add one, copy the shape of an existing one.
+- Domain: entities, value objects, errors, domain events, and ports (`domain/port/<port>/`), each with its contract (`<Port>.contract.ts`).
+- Application: one folder per use case, `command/<use-case>/` or `query/<use-case>/`, with its DTOs, its handler and its test.
+- Infra: the adapters of the ports, in `infra/<port>/`. The test of each adapter runs the contract of its port.
+- Presentation: the controllers in the backend; the views and the store in the frontend.
+- Dependencies point to the domain. A context imports its own files with `#context/`, never with `../`.
+- `src/routes/` holds the pages and the HTTP handlers: a page places views, a handler gives the request to a controller.
+
+## Rules
+
+- Write the test first. The coverage and the mutation score stay at 100%.
+- A check that fails names the file and the rule: fix the code, not the rule.
+- Do not change `quality/` (the rules, the thresholds, the configuration of the tools) without asking.
+
+Documentation: https://caits.dev/docs

package/template/project/gitignore

@@ -0,0 +1,16 @@
+# Dependencies
+node_modules/
+
+# Build output
+dist/
+.marko-run/
+tsconfig.tsbuildinfo
+
+# Data that the app writes while it runs
+tmp/
+
+# Test, coverage and mutation output
+reports/
+test-results/
+.stryker-tmp/
+playwright-report/

package/template/project/nvmrc

@@ -0,0 +1 @@
+26

package/template/project/quality/architecture.mjs

@@ -0,0 +1,9 @@
+import { rules } from "./caits/architecture.mjs";
+
+/**
+ * The rules of the architecture of this project, which `caits architecture` checks. They start from those of CAITS
+ * (quality/caits/architecture.mjs). Remove, replace or add rules here, for example:
+ *   export default [...rules.filter(rule => rule.name !== "routes-folders"), myRule];
+ * A rule of your own can use what @ingenioz-it/caits/quality/architecture gives (locate, portOf…).
+ */
+export default rules;

package/template/project/quality/eslint.config.js

@@ -0,0 +1,6 @@
+import caits from "./caits/eslint.js";
+
+/** The ESLint configuration of this project: that of CAITS (quality/caits/eslint.js), then the changes of this project, which win. */
+export default [
+  ...caits
+];

package/template/project/quality/playwright.config.ts

@@ -0,0 +1,10 @@
+import { defineConfig } from "@playwright/test";
+import caits from "./caits/playwright.ts";
+
+/**
+ * The Playwright configuration of this project: that of CAITS (quality/caits/playwright.ts), with the changes of this project, which
+ * replace its values. To change one value of an object, copy the others: `use: { ...caits.use, locale: "fr-FR" }`.
+ */
+export default defineConfig({
+  ...caits
+});

package/template/project/quality/stryker.config.mjs

@@ -0,0 +1,6 @@
+import caits from "./caits/stryker.mjs";
+
+/** The Stryker configuration of this project: that of CAITS (quality/caits/stryker.mjs), with the changes of this project. */
+export default {
+  ...caits
+};

package/template/project/quality/vite.config.ts

@@ -0,0 +1,5 @@
+import { mergeConfig } from "vitest/config";
+import caits from "./caits/vite.ts";
+
+/** The configuration of Vite (build, dev server) and Vitest of this project: that of CAITS (quality/caits/vite.ts), with the changes of this project. */
+export default mergeConfig(caits, {});

package/template/project/tsconfig.json

@@ -0,0 +1,4 @@
+{
+  // The TypeScript configuration of this project: that of CAITS (quality/caits/tsconfig.json), with the changes of this project.
+  "extends": "./quality/caits/tsconfig.json"
+}