archprint 0.4.1 → 0.6.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (106) hide show
  1. package/CHANGELOG.md +71 -0
  2. package/README.md +74 -51
  3. package/dist/cli/adoption-readme.d.ts +7 -0
  4. package/dist/cli/adoption-readme.d.ts.map +1 -0
  5. package/dist/cli/adoption-readme.js +76 -0
  6. package/dist/cli/adoption-readme.js.map +1 -0
  7. package/dist/cli/archprint-config.d.ts +33 -0
  8. package/dist/cli/archprint-config.d.ts.map +1 -0
  9. package/dist/cli/archprint-config.js +83 -0
  10. package/dist/cli/archprint-config.js.map +1 -0
  11. package/dist/cli/generate.d.ts +44 -37
  12. package/dist/cli/generate.d.ts.map +1 -1
  13. package/dist/cli/generate.js +167 -258
  14. package/dist/cli/generate.js.map +1 -1
  15. package/dist/cli/ignore-file.d.ts +8 -0
  16. package/dist/cli/ignore-file.d.ts.map +1 -0
  17. package/dist/cli/ignore-file.js +37 -0
  18. package/dist/cli/ignore-file.js.map +1 -0
  19. package/dist/cli/layout.d.ts +24 -0
  20. package/dist/cli/layout.d.ts.map +1 -0
  21. package/dist/cli/layout.js +74 -0
  22. package/dist/cli/layout.js.map +1 -0
  23. package/dist/cli/migrate.d.ts +27 -0
  24. package/dist/cli/migrate.d.ts.map +1 -0
  25. package/dist/cli/migrate.js +177 -0
  26. package/dist/cli/migrate.js.map +1 -0
  27. package/dist/cli/outputs-manifest.d.ts +0 -6
  28. package/dist/cli/outputs-manifest.d.ts.map +1 -1
  29. package/dist/cli/outputs-manifest.js +2 -29
  30. package/dist/cli/outputs-manifest.js.map +1 -1
  31. package/dist/cli/program.d.ts +1 -0
  32. package/dist/cli/program.d.ts.map +1 -1
  33. package/dist/cli/program.js +237 -51
  34. package/dist/cli/program.js.map +1 -1
  35. package/dist/cli/recommend.d.ts +5 -1
  36. package/dist/cli/recommend.d.ts.map +1 -1
  37. package/dist/cli/recommend.js +42 -2
  38. package/dist/cli/recommend.js.map +1 -1
  39. package/dist/cli/report.d.ts +4 -2
  40. package/dist/cli/report.d.ts.map +1 -1
  41. package/dist/cli/report.js +31 -5
  42. package/dist/cli/report.js.map +1 -1
  43. package/dist/cli/wiring.d.ts +2 -13
  44. package/dist/cli/wiring.d.ts.map +1 -1
  45. package/dist/cli/wiring.js +63 -110
  46. package/dist/cli/wiring.js.map +1 -1
  47. package/dist/detector/family-maturity.d.ts.map +1 -1
  48. package/dist/detector/family-maturity.js +0 -2
  49. package/dist/detector/family-maturity.js.map +1 -1
  50. package/dist/generator/console-isolation-emitters.d.ts +3 -0
  51. package/dist/generator/console-isolation-emitters.d.ts.map +1 -1
  52. package/dist/generator/console-isolation-emitters.js +5 -1
  53. package/dist/generator/console-isolation-emitters.js.map +1 -1
  54. package/dist/generator/deep-relative-emitters.d.ts +4 -0
  55. package/dist/generator/deep-relative-emitters.d.ts.map +1 -1
  56. package/dist/generator/deep-relative-emitters.js +4 -0
  57. package/dist/generator/deep-relative-emitters.js.map +1 -1
  58. package/dist/generator/depcruise-exempt.d.ts +5 -0
  59. package/dist/generator/depcruise-exempt.d.ts.map +1 -0
  60. package/dist/generator/depcruise-exempt.js +8 -0
  61. package/dist/generator/depcruise-exempt.js.map +1 -0
  62. package/dist/generator/dependency-internals-emitters.d.ts +1 -1
  63. package/dist/generator/dependency-internals-emitters.d.ts.map +1 -1
  64. package/dist/generator/dependency-internals-emitters.js +5 -2
  65. package/dist/generator/dependency-internals-emitters.js.map +1 -1
  66. package/dist/generator/env-access-emitters.d.ts +1 -1
  67. package/dist/generator/env-access-emitters.d.ts.map +1 -1
  68. package/dist/generator/env-access-emitters.js +3 -1
  69. package/dist/generator/env-access-emitters.js.map +1 -1
  70. package/dist/generator/eslint-preset-emitter.d.ts +4 -1
  71. package/dist/generator/eslint-preset-emitter.d.ts.map +1 -1
  72. package/dist/generator/eslint-preset-emitter.js +6 -4
  73. package/dist/generator/eslint-preset-emitter.js.map +1 -1
  74. package/dist/generator/eslint-scope.d.ts +10 -0
  75. package/dist/generator/eslint-scope.d.ts.map +1 -0
  76. package/dist/generator/eslint-scope.js +37 -0
  77. package/dist/generator/eslint-scope.js.map +1 -0
  78. package/dist/generator/phantom-dependency-emitters.d.ts +1 -1
  79. package/dist/generator/phantom-dependency-emitters.d.ts.map +1 -1
  80. package/dist/generator/phantom-dependency-emitters.js +4 -1
  81. package/dist/generator/phantom-dependency-emitters.js.map +1 -1
  82. package/dist/generator/public-api-emitters.d.ts +1 -1
  83. package/dist/generator/public-api-emitters.d.ts.map +1 -1
  84. package/dist/generator/public-api-emitters.js +2 -1
  85. package/dist/generator/public-api-emitters.js.map +1 -1
  86. package/dist/generator/test-isolation-emitters.d.ts +3 -1
  87. package/dist/generator/test-isolation-emitters.d.ts.map +1 -1
  88. package/dist/generator/test-isolation-emitters.js +26 -2
  89. package/dist/generator/test-isolation-emitters.js.map +1 -1
  90. package/dist/generator/workspace-package-emitters.d.ts +1 -1
  91. package/dist/generator/workspace-package-emitters.d.ts.map +1 -1
  92. package/dist/generator/workspace-package-emitters.js +2 -0
  93. package/dist/generator/workspace-package-emitters.js.map +1 -1
  94. package/dist/index.d.ts +2 -1
  95. package/dist/index.d.ts.map +1 -1
  96. package/dist/index.js +2 -1
  97. package/dist/index.js.map +1 -1
  98. package/dist/scanner/enforcers.d.ts +8 -0
  99. package/dist/scanner/enforcers.d.ts.map +1 -0
  100. package/dist/scanner/enforcers.js +74 -0
  101. package/dist/scanner/enforcers.js.map +1 -0
  102. package/package.json +8 -8
  103. package/dist/cli/init.d.ts +0 -21
  104. package/dist/cli/init.d.ts.map +0 -1
  105. package/dist/cli/init.js +0 -19
  106. package/dist/cli/init.js.map +0 -1
@@ -0,0 +1,74 @@
1
+ import { existsSync, readFileSync } from 'node:fs';
2
+ import * as path from 'node:path';
3
+ import { findWorkspaceRoot } from './workspace-packages.js';
4
+ const ESLINT_CONFIGS = [
5
+ 'eslint.config.js',
6
+ 'eslint.config.mjs',
7
+ 'eslint.config.cjs',
8
+ 'eslint.config.ts',
9
+ '.eslintrc',
10
+ '.eslintrc.js',
11
+ '.eslintrc.cjs',
12
+ '.eslintrc.json',
13
+ '.eslintrc.yml',
14
+ '.eslintrc.yaml',
15
+ ];
16
+ const DEPCRUISE_CONFIGS = [
17
+ '.dependency-cruiser.js',
18
+ '.dependency-cruiser.cjs',
19
+ '.dependency-cruiser.mjs',
20
+ '.dependency-cruiser.json',
21
+ 'dependency-cruiser.config.js',
22
+ 'dependency-cruiser.config.mjs',
23
+ ];
24
+ const BIOME_CONFIGS = ['biome.json', 'biome.jsonc'];
25
+ const DEP_FIELDS = [
26
+ 'dependencies',
27
+ 'devDependencies',
28
+ 'peerDependencies',
29
+ 'optionalDependencies',
30
+ ];
31
+ function readDeclaredDependencies(dir) {
32
+ const names = new Set();
33
+ const packageJsonPath = path.join(dir, 'package.json');
34
+ if (!existsSync(packageJsonPath))
35
+ return names;
36
+ try {
37
+ const pkg = JSON.parse(readFileSync(packageJsonPath, 'utf-8'));
38
+ for (const field of DEP_FIELDS) {
39
+ const deps = pkg[field];
40
+ if (deps && typeof deps === 'object')
41
+ for (const name of Object.keys(deps))
42
+ names.add(name);
43
+ }
44
+ }
45
+ catch {
46
+ /* a malformed package.json contributes no signal */
47
+ }
48
+ return names;
49
+ }
50
+ const anyExists = (dir, names) => names.some((name) => existsSync(path.join(dir, name)));
51
+ export function detectEnforcers(startDir) {
52
+ const top = findWorkspaceRoot(startDir);
53
+ const deps = new Set();
54
+ const config = { eslint: false, dependencyCruiser: false, biome: false };
55
+ let dir = path.resolve(startDir);
56
+ for (;;) {
57
+ for (const name of readDeclaredDependencies(dir))
58
+ deps.add(name);
59
+ config.eslint ||= anyExists(dir, ESLINT_CONFIGS);
60
+ config.dependencyCruiser ||= anyExists(dir, DEPCRUISE_CONFIGS);
61
+ config.biome ||= anyExists(dir, BIOME_CONFIGS);
62
+ const parent = path.dirname(dir);
63
+ if (dir === top || parent === dir)
64
+ break;
65
+ dir = parent;
66
+ }
67
+ return {
68
+ eslint: deps.has('eslint') || config.eslint,
69
+ eslintPluginImport: deps.has('eslint-plugin-import') || deps.has('eslint-plugin-import-x'),
70
+ dependencyCruiser: deps.has('dependency-cruiser') || config.dependencyCruiser,
71
+ biome: deps.has('@biomejs/biome') || config.biome,
72
+ };
73
+ }
74
+ //# sourceMappingURL=enforcers.js.map
@@ -0,0 +1 @@
1
+ {"version":3,"file":"enforcers.js","sourceRoot":"","sources":["../../src/scanner/enforcers.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,YAAY,EAAE,MAAM,SAAS,CAAC;AACnD,OAAO,KAAK,IAAI,MAAM,WAAW,CAAC;AAClC,OAAO,EAAE,iBAAiB,EAAE,MAAM,yBAAyB,CAAC;AAS5D,MAAM,cAAc,GAAG;IACrB,kBAAkB;IAClB,mBAAmB;IACnB,mBAAmB;IACnB,kBAAkB;IAClB,WAAW;IACX,cAAc;IACd,eAAe;IACf,gBAAgB;IAChB,eAAe;IACf,gBAAgB;CACjB,CAAC;AACF,MAAM,iBAAiB,GAAG;IACxB,wBAAwB;IACxB,yBAAyB;IACzB,yBAAyB;IACzB,0BAA0B;IAC1B,8BAA8B;IAC9B,+BAA+B;CAChC,CAAC;AACF,MAAM,aAAa,GAAG,CAAC,YAAY,EAAE,aAAa,CAAC,CAAC;AACpD,MAAM,UAAU,GAAG;IACjB,cAAc;IACd,iBAAiB;IACjB,kBAAkB;IAClB,sBAAsB;CACd,CAAC;AAEX,SAAS,wBAAwB,CAAC,GAAW;IAC3C,MAAM,KAAK,GAAG,IAAI,GAAG,EAAU,CAAC;IAChC,MAAM,eAAe,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;IACvD,IAAI,CAAC,UAAU,CAAC,eAAe,CAAC;QAAE,OAAO,KAAK,CAAC;IAC/C,IAAI,CAAC;QACH,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,eAAe,EAAE,OAAO,CAAC,CAA4B,CAAC;QAC1F,KAAK,MAAM,KAAK,IAAI,UAAU,EAAE,CAAC;YAC/B,MAAM,IAAI,GAAG,GAAG,CAAC,KAAK,CAAC,CAAC;YACxB,IAAI,IAAI,IAAI,OAAO,IAAI,KAAK,QAAQ;gBAAE,KAAK,MAAM,IAAI,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC;oBAAE,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QAC9F,CAAC;IACH,CAAC;IAAC,MAAM,CAAC;QACP,oDAAoD;IACtD,CAAC;IACD,OAAO,KAAK,CAAC;AACf,CAAC;AAED,MAAM,SAAS,GAAG,CAAC,GAAW,EAAE,KAAwB,EAAW,EAAE,CACnE,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAEzD,MAAM,UAAU,eAAe,CAAC,QAAgB;IAC9C,MAAM,GAAG,GAAG,iBAAiB,CAAC,QAAQ,CAAC,CAAC;IACxC,MAAM,IAAI,GAAG,IAAI,GAAG,EAAU,CAAC;IAC/B,MAAM,MAAM,GAAG,EAAE,MAAM,EAAE,KAAK,EAAE,iBAAiB,EAAE,KAAK,EAAE,KAAK,EAAE,KAAK,EAAE,CAAC;IACzE,IAAI,GAAG,GAAG,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC;IACjC,SAAS,CAAC;QACR,KAAK,MAAM,IAAI,IAAI,wBAAwB,CAAC,GAAG,CAAC;YAAE,IAAI,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC;QACjE,MAAM,CAAC,MAAM,KAAK,SAAS,CAAC,GAAG,EAAE,cAAc,CAAC,CAAC;QACjD,MAAM,CAAC,iBAAiB,KAAK,SAAS,CAAC,GAAG,EAAE,iBAAiB,CAAC,CAAC;QAC/D,MAAM,CAAC,KAAK,KAAK,SAAS,CAAC,GAAG,EAAE,aAAa,CAAC,CAAC;QAC/C,MAAM,MAAM,GAAG,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,CAAC;QACjC,IAAI,GAAG,KAAK,GAAG,IAAI,MAAM,KAAK,GAAG;YAAE,MAAM;QACzC,GAAG,GAAG,MAAM,CAAC;IACf,CAAC;IACD,OAAO;QACL,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,MAAM;QAC3C,kBAAkB,EAAE,IAAI,CAAC,GAAG,CAAC,sBAAsB,CAAC,IAAI,IAAI,CAAC,GAAG,CAAC,wBAAwB,CAAC;QAC1F,iBAAiB,EAAE,IAAI,CAAC,GAAG,CAAC,oBAAoB,CAAC,IAAI,MAAM,CAAC,iBAAiB;QAC7E,KAAK,EAAE,IAAI,CAAC,GAAG,CAAC,gBAAgB,CAAC,IAAI,MAAM,CAAC,KAAK;KAClD,CAAC;AACJ,CAAC"}
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "archprint",
3
- "version": "0.4.1",
3
+ "version": "0.6.0",
4
4
  "description": "Mine the architecture rules your TypeScript repo already enforces, with the evidence attached.",
5
5
  "keywords": [
6
6
  "eslint",
@@ -54,9 +54,9 @@
54
54
  "typecheck": "tsc --noEmit",
55
55
  "test": "vitest run",
56
56
  "test:watch": "vitest",
57
- "lint": "eslint .",
58
- "format": "prettier --write .",
59
- "format:check": "prettier --check .",
57
+ "lint": "eslint src tests",
58
+ "format": "prettier --write . --ignore-path .prettierignore --ignore-path .git/info/exclude",
59
+ "format:check": "prettier --check . --ignore-path .prettierignore --ignore-path .git/info/exclude",
60
60
  "docs:dev": "vitepress dev docs",
61
61
  "docs:build": "vitepress build docs",
62
62
  "docs:preview": "vitepress preview docs",
@@ -71,13 +71,13 @@
71
71
  "provenance": true
72
72
  },
73
73
  "dependencies": {
74
- "commander": "^14.0.3",
75
- "ignore": "7.0.8",
74
+ "commander": "^15.0.0",
75
+ "ignore": "7.0.9",
76
76
  "ts-morph": "28.0.0",
77
77
  "typescript": "6.0.3"
78
78
  },
79
79
  "devDependencies": {
80
- "@changesets/cli": "^2.31.0",
80
+ "@changesets/cli": "^3.0.3",
81
81
  "@commitlint/cli": "^21.2.0",
82
82
  "@commitlint/config-conventional": "^21.2.0",
83
83
  "@eslint/js": "^10.0.1",
@@ -88,7 +88,7 @@
88
88
  "eslint-config-prettier": "^10.1.8",
89
89
  "get-tsconfig": "^4.14.0",
90
90
  "husky": "^9.1.7",
91
- "lint-staged": "^16.4.0",
91
+ "lint-staged": "^17.5.0",
92
92
  "oxc-resolver": "^11.22.0",
93
93
  "prettier": "^3.9.4",
94
94
  "tsconfig-paths": "^4.2.0",
@@ -1,21 +0,0 @@
1
- import { type Recommendation, type Recommendations } from './recommend.js';
2
- export declare const INIT_MANIFEST_FILE = "archprint.json";
3
- export interface InitManifest {
4
- archprintVersion: string;
5
- app: string;
6
- stack: string[];
7
- rulesDir: string;
8
- enforced: Recommendation[];
9
- review: Recommendation[];
10
- adopt: Recommendation[];
11
- evidence: {
12
- apps: number;
13
- asOf: string;
14
- };
15
- }
16
- export declare function buildInitManifest(recommendations: Recommendations, version: string, location: {
17
- app: string;
18
- rulesDir: string;
19
- }): InitManifest;
20
- export declare function writeInitManifest(manifest: InitManifest, manifestPath: string): void;
21
- //# sourceMappingURL=init.d.ts.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"init.d.ts","sourceRoot":"","sources":["../../src/cli/init.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,KAAK,cAAc,EAAE,KAAK,eAAe,EAAE,MAAM,gBAAgB,CAAC;AAE3E,eAAO,MAAM,kBAAkB,mBAAmB,CAAC;AAEnD,MAAM,WAAW,YAAY;IAC3B,gBAAgB,EAAE,MAAM,CAAC;IACzB,GAAG,EAAE,MAAM,CAAC;IACZ,KAAK,EAAE,MAAM,EAAE,CAAC;IAChB,QAAQ,EAAE,MAAM,CAAC;IACjB,QAAQ,EAAE,cAAc,EAAE,CAAC;IAC3B,MAAM,EAAE,cAAc,EAAE,CAAC;IACzB,KAAK,EAAE,cAAc,EAAE,CAAC;IACxB,QAAQ,EAAE;QAAE,IAAI,EAAE,MAAM,CAAC;QAAC,IAAI,EAAE,MAAM,CAAA;KAAE,CAAC;CAC1C;AAED,wBAAgB,iBAAiB,CAC/B,eAAe,EAAE,eAAe,EAChC,OAAO,EAAE,MAAM,EACf,QAAQ,EAAE;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,QAAQ,EAAE,MAAM,CAAA;CAAE,GAC1C,YAAY,CAWd;AAED,wBAAgB,iBAAiB,CAAC,QAAQ,EAAE,YAAY,EAAE,YAAY,EAAE,MAAM,GAAG,IAAI,CAEpF"}
package/dist/cli/init.js DELETED
@@ -1,19 +0,0 @@
1
- import { writeFileSync } from 'node:fs';
2
- import {} from './recommend.js';
3
- export const INIT_MANIFEST_FILE = 'archprint.json';
4
- export function buildInitManifest(recommendations, version, location) {
5
- return {
6
- archprintVersion: version,
7
- app: location.app,
8
- stack: recommendations.stack,
9
- rulesDir: location.rulesDir,
10
- enforced: recommendations.enforceNow,
11
- review: recommendations.review,
12
- adopt: recommendations.adopt,
13
- evidence: recommendations.evidence,
14
- };
15
- }
16
- export function writeInitManifest(manifest, manifestPath) {
17
- writeFileSync(manifestPath, `${JSON.stringify(manifest, null, 2)}\n`);
18
- }
19
- //# sourceMappingURL=init.js.map
@@ -1 +0,0 @@
1
- {"version":3,"file":"init.js","sourceRoot":"","sources":["../../src/cli/init.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,SAAS,CAAC;AACxC,OAAO,EAA6C,MAAM,gBAAgB,CAAC;AAE3E,MAAM,CAAC,MAAM,kBAAkB,GAAG,gBAAgB,CAAC;AAanD,MAAM,UAAU,iBAAiB,CAC/B,eAAgC,EAChC,OAAe,EACf,QAA2C;IAE3C,OAAO;QACL,gBAAgB,EAAE,OAAO;QACzB,GAAG,EAAE,QAAQ,CAAC,GAAG;QACjB,KAAK,EAAE,eAAe,CAAC,KAAK;QAC5B,QAAQ,EAAE,QAAQ,CAAC,QAAQ;QAC3B,QAAQ,EAAE,eAAe,CAAC,UAAU;QACpC,MAAM,EAAE,eAAe,CAAC,MAAM;QAC9B,KAAK,EAAE,eAAe,CAAC,KAAK;QAC5B,QAAQ,EAAE,eAAe,CAAC,QAAQ;KACnC,CAAC;AACJ,CAAC;AAED,MAAM,UAAU,iBAAiB,CAAC,QAAsB,EAAE,YAAoB;IAC5E,aAAa,CAAC,YAAY,EAAE,GAAG,IAAI,CAAC,SAAS,CAAC,QAAQ,EAAE,IAAI,EAAE,CAAC,CAAC,IAAI,CAAC,CAAC;AACxE,CAAC"}