@freetesh/canon 0.0.0-stage → 0.16.0

package/templates/dependency-cruiser/base.cjs

@@ -0,0 +1,52 @@
+/* global module, require */
+// Managed by canon — `canon sync` rewrites this file from canon's template, so edits here are lost.
+// Put this repo's own rules in the .dependency-cruiser.cjs files that extend it.
+// Each workspace runs on its own because apps map `@/` to their own src, and
+// dependency-cruiser reads one tsconfig per run.
+
+const { existsSync } = require("node:fs");
+
+// recommended's no-orphans exceptions (dot files, .d.ts, tsconfig, babel/webpack configs),
+// restated because the package does not export its rule files…
+const KNOWN_CONFIG_FILES = [
+  "(^|/)\\.[^/]+\\.(js|cjs|mjs|ts|json)$",
+  "\\.d\\.(c|m)?ts$",
+  "(^|/)tsconfig\\.json$",
+  "(^|/)(?:babel|webpack)\\.config\\.(?:js|cjs|mjs|ts|json)$",
+];
+// …plus files a framework or tool loads by convention, so nothing imports them.
+const ENTRY_POINTS = [
+  "(^|/)src/app/[^.]*(page|layout|route|loading|error|not-found|template|default)\\.tsx?$", // Next.js app router
+  "(^|/)src/pages/[^.]+\\.tsx?$", // Next.js pages router
+  "^src/app/[^.]+\\.tsx?$", // Expo Router: every file under app/ is a route
+  "^src/(instrumentation|middleware)\\.ts$", // Next.js hooks
+  "^(scripts|plugins|eslint|e2e|public)/", // run by a tool, not imported
+  "(^|/)__mocks__/", // jest mocks
+  "^(src/)?index\\.ts$", // a package's entry
+  "(^|/)codegen\\.ts$", // GraphQL codegen script
+];
+
+/** @type {import('dependency-cruiser').IConfiguration} */
+module.exports = {
+  extends: "dependency-cruiser/configs/recommended",
+  forbidden: [
+    {
+      name: "no-orphans",
+      comment: "Nothing imports this file: use it or delete it. Add a real entry point to ENTRY_POINTS instead.",
+      severity: "warn",
+      from: { orphan: true, pathNot: [...KNOWN_CONFIG_FILES, ...ENTRY_POINTS] },
+      to: {},
+    },
+  ],
+  options: {
+    // Record imports into a sibling workspace, but leave cruising it to that workspace's own run.
+    doNotFollow: { path: ["node_modules", "^\\.\\./"] },
+    // Specs and tooling configs are not app code.
+    exclude: { path: "^(dist|build|out|generated|coverage|\\.next|\\.expo|\\.turbo)/|^tests/|\\.(spec|test)\\.tsx?$|(^|/)[^/]+\\.config\\.(c|m)?(j|t)s$|(^|/)\\.dependency-cruiser" },
+    tsPreCompilationDeps: true,
+    // Each run starts in its workspace, so this is that workspace's tsconfig (if it has one).
+    ...(existsSync("tsconfig.json") ? { tsConfig: { fileName: "tsconfig.json" } } : {}),
+    // Packages like uuid 13 export only `node`/`default` conditions.
+    enhancedResolveOptions: { exportsFields: ["exports"], conditionNames: ["import", "require", "node", "default", "types"] },
+  },
+};

package/templates/dependency-cruiser/package.cjs

@@ -0,0 +1,31 @@
+/* global module */
+// This package's architecture rules, enforced by `canon check` (architecture module).
+// canon wrote this starter once; it is yours now.
+
+/** @type {import('dependency-cruiser').IConfiguration} */
+module.exports = {
+  extends: "../../.dependency-cruiser.base.cjs",
+  forbidden: [
+    {
+      name: "no-package-to-app",
+      comment: "packages/ are shared; they never depend on an app.",
+      severity: "error",
+      from: {},
+      to: { path: "^\\.\\./\\.\\./apps/" },
+    },
+    {
+      name: "no-orphans",
+      comment: "Off here: apps import a package's files through subpath exports, which a run inside the package cannot see.",
+      severity: "ignore",
+      from: { orphan: true },
+      to: {},
+    },
+    {
+      name: "no-duplicate-dep-types",
+      comment: "Off here: a shared package lists react and friends as both peer and dev dependency on purpose.",
+      severity: "ignore",
+      from: {},
+      to: {},
+    },
+  ],
+};

package/templates/dependency-cruiser/root.cjs

@@ -0,0 +1,15 @@
+/* global module */
+// This repo's architecture rules, enforced by `canon check` (architecture module).
+// canon wrote this starter once; it is yours now. Add the layers this product has
+// (see the rule reference below) and keep the why in a wiki concept page.
+// Rule reference: https://github.com/sverweij/dependency-cruiser/blob/main/doc/rules-reference.md
+
+/** @type {import('dependency-cruiser').IConfiguration} */
+module.exports = {
+  extends: "./.dependency-cruiser.base.cjs",
+  forbidden: [],
+  options: {
+    // The level `canon ui` draws the architecture graph at: one box per match.
+    reporterOptions: { archi: { collapsePattern: "^src/[^/]+|^[^/]+" } },
+  },
+};