@dcaldeira/tooling 0.0.0-stage → 0.2.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 (56) hide show
  1. package/LICENSE +9 -0
  2. package/README.md +33 -2
  3. package/checks/a11y.mjs +206 -0
  4. package/checks/architecture.mjs +137 -0
  5. package/checks/audit.mjs +121 -0
  6. package/checks/bundle.mjs +126 -0
  7. package/checks/dependencies.mjs +277 -0
  8. package/checks/duplication.mjs +135 -0
  9. package/checks/lint-scss.mjs +363 -0
  10. package/checks/package.mjs +30 -0
  11. package/checks/playwright-summary.mjs +53 -0
  12. package/checks/sass.mjs +67 -0
  13. package/checks/scan-secrets.mjs +58 -0
  14. package/checks/shared.mjs +86 -0
  15. package/checks/style-property-order.json +498 -0
  16. package/checks/translations.mjs +55 -0
  17. package/checks/visual-compare.mjs +148 -0
  18. package/checks/visual-report-html.mjs +470 -0
  19. package/checks/visual-report.mjs +13 -0
  20. package/config.schema.json +977 -0
  21. package/configs/eslint.mjs +27 -0
  22. package/configs/knip.json +11 -0
  23. package/configs/playwright.mjs +15 -0
  24. package/configs/prettier.mjs +1 -0
  25. package/configs/tsconfig.json +16 -0
  26. package/configs/vitest.mjs +16 -0
  27. package/package.json +103 -4
  28. package/release/evidence.mjs +62 -0
  29. package/release/finalize.mjs +65 -0
  30. package/release/gh.mjs +25 -0
  31. package/release/github.mjs +64 -0
  32. package/release/prepare.mjs +30 -0
  33. package/runner/browsers.mjs +73 -0
  34. package/runner/cache.mjs +121 -0
  35. package/runner/ci-plan.mjs +54 -0
  36. package/runner/cli.mjs +251 -0
  37. package/runner/config.mjs +148 -0
  38. package/runner/docs-install.mjs +93 -0
  39. package/runner/execute.mjs +298 -0
  40. package/runner/generate.mjs +122 -0
  41. package/runner/git.mjs +122 -0
  42. package/runner/graph.mjs +250 -0
  43. package/runner/index.mjs +4 -0
  44. package/runner/insights.mjs +313 -0
  45. package/runner/provision.mjs +53 -0
  46. package/runner/repo-standard.mjs +104 -0
  47. package/runner/report.mjs +35 -0
  48. package/runner/serve-static.mjs +76 -0
  49. package/runner/setup.mjs +241 -0
  50. package/runner/summary.mjs +112 -0
  51. package/runner/watch.mjs +82 -0
  52. package/templates/ci.yml +25 -0
  53. package/templates/dependabot-merge.yml +13 -0
  54. package/templates/dependabot.yml +26 -0
  55. package/templates/pre-push +13 -0
  56. package/templates/release.yml +23 -0
@@ -0,0 +1,277 @@
1
+ import { readFileSync } from 'node:fs';
2
+ import { dirname, join, relative, resolve } from 'node:path';
3
+ import { pathToFileURL } from 'node:url';
4
+ import semver from 'semver';
5
+ import { loadConfig, inside } from '../runner/config.mjs';
6
+ import { matches } from '../runner/graph.mjs';
7
+ import {
8
+ compilerOptions,
9
+ importsIn,
10
+ peer,
11
+ rootDirectory,
12
+ sourceFiles,
13
+ writeDetails,
14
+ } from './shared.mjs';
15
+
16
+ export function analyseDependencies(root, settings = {}, manifests, lock, files, ts) {
17
+ const rootManifest = JSON.parse(readFileSync(join(root, 'package.json'), 'utf8'));
18
+ const workspacePatterns = Array.isArray(rootManifest.workspaces)
19
+ ? rootManifest.workspaces
20
+ : (rootManifest.workspaces?.packages ?? []);
21
+ manifests ??= settings.manifests ?? [
22
+ 'package.json',
23
+ ...sourceFiles(root, ['**/package.json']).filter(
24
+ (file) =>
25
+ file !== 'package.json' &&
26
+ workspacePatterns.some((pattern) => matches(dirname(file).replaceAll('\\', '/'), pattern)),
27
+ ),
28
+ ];
29
+ const packages = [...new Set(manifests)].map((file) => ({
30
+ file,
31
+ directory: dirname(file).replaceAll('\\', '/'),
32
+ manifest: JSON.parse(readFileSync(inside(root, file), 'utf8')),
33
+ }));
34
+ const named = new Map();
35
+ const issues = [],
36
+ warnings = [],
37
+ declarations = new Map();
38
+ for (const pkg of packages) {
39
+ const name = pkg.manifest.name;
40
+ if (name && named.has(name))
41
+ issues.push({
42
+ rule: 'duplicate-workspace-name',
43
+ file: pkg.file,
44
+ message: `Duplicate package name ${name}`,
45
+ });
46
+ if (name) named.set(name, pkg);
47
+ for (const section of [
48
+ 'dependencies',
49
+ 'devDependencies',
50
+ 'peerDependencies',
51
+ 'optionalDependencies',
52
+ ])
53
+ for (const [name, range] of Object.entries(pkg.manifest[section] ?? {})) {
54
+ const list = declarations.get(name) ?? [];
55
+ list.push({ pkg, section, range });
56
+ declarations.set(name, list);
57
+ }
58
+ }
59
+ function versionRange(name, entry) {
60
+ const range = entry.range;
61
+ if (typeof range !== 'string') {
62
+ issues.push({
63
+ rule: 'invalid-range',
64
+ file: entry.pkg.file,
65
+ message: `${name}: dependency range must be a string`,
66
+ });
67
+ return null;
68
+ }
69
+ const local = named.get(name);
70
+ if (range.startsWith('workspace:')) {
71
+ if (!local) {
72
+ issues.push({
73
+ rule: 'missing-workspace',
74
+ file: entry.pkg.file,
75
+ message: `${name} uses workspace: but no workspace declares that name`,
76
+ });
77
+ return null;
78
+ }
79
+ const value = range.slice(10);
80
+ return ['*', '^', '~'].includes(value)
81
+ ? value === '*'
82
+ ? local.manifest.version
83
+ : value + local.manifest.version
84
+ : value;
85
+ }
86
+ if (/^(?:file|link):/.test(range)) {
87
+ if (
88
+ local &&
89
+ resolve(root, entry.pkg.directory, range.replace(/^[^:]+:/, '')) !==
90
+ resolve(root, local.directory)
91
+ )
92
+ issues.push({
93
+ rule: 'workspace-target',
94
+ file: entry.pkg.file,
95
+ message: `${name} points to a different local directory`,
96
+ });
97
+ return local?.manifest.version ?? null;
98
+ }
99
+ if (range.startsWith('npm:')) {
100
+ const at = range.lastIndexOf('@');
101
+ return at > 4 ? range.slice(at + 1) : '*';
102
+ }
103
+ return semver.validRange(range) ? range : null;
104
+ }
105
+ for (const [name, entries] of declarations) {
106
+ if (settings.ignore?.includes(name)) continue;
107
+ const normalized = entries.map((entry) => ({
108
+ ...entry,
109
+ normalized: versionRange(name, entry),
110
+ }));
111
+ if (settings.strict?.includes(name) && new Set(entries.map((entry) => entry.range)).size > 1)
112
+ issues.push({
113
+ rule: 'version-drift',
114
+ message: `${name}: ranges differ: ${entries.map((entry) => `${entry.pkg.file}=${entry.range}`).join(', ')}`,
115
+ });
116
+ const expected = settings.expected?.[name];
117
+ if (expected && !semver.validRange(expected))
118
+ throw new Error(`Invalid expected range for ${name}: ${expected}`);
119
+ for (let i = 0; i < normalized.length; i++) {
120
+ const entry = normalized[i],
121
+ local = named.get(name);
122
+ if (entry.normalized && !semver.validRange(entry.normalized)) {
123
+ issues.push({
124
+ rule: 'invalid-range',
125
+ file: entry.pkg.file,
126
+ message: `${name}: invalid workspace range ${entry.range}`,
127
+ });
128
+ continue;
129
+ }
130
+ if (expected && (!entry.normalized || !semver.subset(entry.normalized, expected)))
131
+ issues.push({
132
+ rule: 'expected-version',
133
+ file: entry.pkg.file,
134
+ message: `${name}: ${entry.range} permits versions outside ${expected}`,
135
+ });
136
+ if (
137
+ local &&
138
+ entry.normalized &&
139
+ (!semver.valid(local.manifest.version) ||
140
+ !semver.satisfies(local.manifest.version, entry.normalized))
141
+ )
142
+ issues.push({
143
+ rule: 'workspace-version',
144
+ file: entry.pkg.file,
145
+ message: `${name}@${local.manifest.version} does not satisfy ${entry.range}`,
146
+ });
147
+ for (let j = i + 1; j < normalized.length; j++) {
148
+ const other = normalized[j];
149
+ if (
150
+ entry.normalized &&
151
+ other.normalized &&
152
+ semver.validRange(other.normalized) &&
153
+ !semver.intersects(entry.normalized, other.normalized)
154
+ )
155
+ issues.push({
156
+ rule: 'incompatible-ranges',
157
+ message: `${name}: ${entry.pkg.file} (${entry.range}) and ${other.pkg.file} (${other.range}) are incompatible`,
158
+ });
159
+ }
160
+ }
161
+ }
162
+ if (lock === undefined) {
163
+ try {
164
+ lock = JSON.parse(readFileSync(join(root, 'package-lock.json'), 'utf8'));
165
+ } catch (error) {
166
+ if (error.code !== 'ENOENT') throw error;
167
+ }
168
+ }
169
+ const versions = new Map();
170
+ for (const [path, entry] of Object.entries(lock?.packages ?? {})) {
171
+ const match = path.match(/(?:^|\/)node_modules\/((?:@[^/]+\/)?[^/]+)$/);
172
+ if (!match || !entry.version || entry.link) continue;
173
+ const set = versions.get(match[1]) ?? new Set();
174
+ set.add(entry.version);
175
+ versions.set(match[1], set);
176
+ }
177
+ for (const [name, set] of versions)
178
+ if (set.size > 1 && !settings.ignore?.includes(name)) {
179
+ const issue = {
180
+ rule: 'duplicate-versions',
181
+ message: `${name}: lockfile contains ${[...set].sort().join(', ')}`,
182
+ };
183
+ (settings.singleVersion?.includes(name) ? issues : warnings).push(issue);
184
+ }
185
+ if (settings.checkImports !== false && packages.length > 1) {
186
+ ts ??= peer('typescript', root);
187
+ files ??= sourceFiles(root, settings.include ?? ['**/src/**'], settings.exclude ?? []);
188
+ const byDirectory = [...packages].sort((a, b) => b.directory.length - a.directory.length);
189
+ const owner = (file) =>
190
+ byDirectory.find((pkg) => pkg.directory === '.' || file.startsWith(pkg.directory + '/'));
191
+ const options = new Map(
192
+ packages.map((pkg) => [
193
+ pkg,
194
+ compilerOptions(
195
+ ts,
196
+ root,
197
+ pkg.directory === '.' ? 'tsconfig.json' : `${pkg.directory}/tsconfig.json`,
198
+ ),
199
+ ]),
200
+ );
201
+ const resolutionCaches = new Map(
202
+ packages.map((pkg) => [
203
+ pkg,
204
+ ts.createModuleResolutionCache(
205
+ root,
206
+ (file) => (ts.sys.useCaseSensitiveFileNames ? file : file.toLowerCase()),
207
+ options.get(pkg),
208
+ ),
209
+ ]),
210
+ );
211
+ for (const file of files.filter((file) => /\.[cm]?[jt]sx?$/.test(file))) {
212
+ const from = owner(file);
213
+ if (!from) continue;
214
+ for (const { specifier, line } of importsIn(ts, inside(root, file))) {
215
+ const internal = [...named].find(
216
+ ([name]) => specifier === name || specifier.startsWith(name + '/'),
217
+ );
218
+ const resolved = ts.resolveModuleName(
219
+ specifier,
220
+ join(root, file),
221
+ options.get(from),
222
+ ts.sys,
223
+ resolutionCaches.get(from),
224
+ ).resolvedModule;
225
+ const target =
226
+ internal?.[1] ??
227
+ (resolved
228
+ ? owner(relative(root, resolved.resolvedFileName).replaceAll('\\', '/'))
229
+ : null);
230
+ if (!target || target === from || !target.manifest.name || target.directory === '.')
231
+ continue;
232
+ const name = target.manifest.name;
233
+ if (
234
+ !['dependencies', 'devDependencies', 'peerDependencies', 'optionalDependencies'].some(
235
+ (section) => Object.hasOwn(from.manifest[section] ?? {}, name),
236
+ )
237
+ )
238
+ issues.push({
239
+ rule: 'undeclared-workspace-import',
240
+ file,
241
+ line,
242
+ message: `${from.manifest.name ?? from.file} imports ${name} without declaring it`,
243
+ });
244
+ if (!internal)
245
+ issues.push({
246
+ rule: 'workspace-path-import',
247
+ file,
248
+ line,
249
+ message: `Import ${name} by package name instead of crossing workspace directories: ${specifier}`,
250
+ });
251
+ }
252
+ }
253
+ }
254
+ return { packages: packages.length, issues, warnings };
255
+ }
256
+
257
+ if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href) {
258
+ const root = rootDirectory(),
259
+ { config } = loadConfig(root);
260
+ const result = analyseDependencies(
261
+ root,
262
+ config.dependencyConsistency,
263
+ undefined,
264
+ undefined,
265
+ undefined,
266
+ config.dependencyConsistency?.checkImports === false ? undefined : peer('typescript'),
267
+ );
268
+ writeDetails({ dependencies: result });
269
+ for (const issue of result.issues)
270
+ console.error(
271
+ `${issue.file ?? 'dependencies'}:${issue.line ?? 1} ${issue.message} (${issue.rule})`,
272
+ );
273
+ console.log(
274
+ `Dependency consistency: ${result.packages} packages, ${result.issues.length} errors, ${result.warnings.length} duplicate-version notices`,
275
+ );
276
+ process.exitCode = result.issues.length ? 1 : 0;
277
+ }
@@ -0,0 +1,135 @@
1
+ #!/usr/bin/env node
2
+ // Copy/paste detection with jscpd. Scans the configured paths; when given files (dev profile),
3
+ // fails only on clones that involve one of them, so existing duplication elsewhere does not
4
+ // block unrelated work.
5
+ import { spawnSync } from 'node:child_process';
6
+ import { existsSync, mkdtempSync, readFileSync, rmSync } from 'node:fs';
7
+ import { createRequire } from 'node:module';
8
+ import { tmpdir } from 'node:os';
9
+ import { dirname, join, relative, resolve } from 'node:path';
10
+ import { pathToFileURL } from 'node:url';
11
+ import { loadConfig } from '../runner/config.mjs';
12
+
13
+ const FORMATS = 'typescript,tsx,javascript,jsx,scss,css';
14
+ const DEFAULT_IGNORE = [
15
+ '**/*.test.*',
16
+ '**/*.spec.*',
17
+ '**/__mocks__/**',
18
+ '**/*.gen.*',
19
+ '**/dist/**',
20
+ ];
21
+
22
+ const posix = (path) => path.split('\\').join('/');
23
+
24
+ export function jscpdBin(repo) {
25
+ try {
26
+ const require = createRequire(join(repo, 'package.json'));
27
+ const manifestPath = require.resolve('jscpd/package.json');
28
+ const { bin } = JSON.parse(readFileSync(manifestPath, 'utf8'));
29
+ const rel = typeof bin === 'string' ? bin : bin?.jscpd;
30
+ return rel ? join(dirname(manifestPath), rel) : undefined;
31
+ } catch {
32
+ return undefined;
33
+ }
34
+ }
35
+
36
+ /** Clones from a jscpd JSON report, optionally only those touching `changed` (repo-relative). */
37
+ export function relevantClones(report, repo, changed = []) {
38
+ const wanted = new Set(changed.map(posix));
39
+ const name = (file) => posix(relative(repo, resolve(repo, file.name)));
40
+ return (report.duplicates ?? [])
41
+ .map((clone) => ({
42
+ first: {
43
+ file: name(clone.firstFile),
44
+ start: clone.firstFile.start,
45
+ end: clone.firstFile.end,
46
+ },
47
+ second: {
48
+ file: name(clone.secondFile),
49
+ start: clone.secondFile.start,
50
+ end: clone.secondFile.end,
51
+ },
52
+ lines: clone.lines,
53
+ }))
54
+ .filter(
55
+ (clone) => !wanted.size || wanted.has(clone.first.file) || wanted.has(clone.second.file),
56
+ );
57
+ }
58
+
59
+ function main() {
60
+ const repo = process.env.TOOLING_ROOT ?? process.cwd();
61
+ const { config } = loadConfig(repo);
62
+ const options = config.duplication ?? {};
63
+ const bin = jscpdBin(repo);
64
+ if (!bin) {
65
+ console.error('duplication: install jscpd as a devDependency');
66
+ return 1;
67
+ }
68
+ // Changed files: dev passes them as arguments, push/ci through a list file. Neither (an `--all`
69
+ // run) means there is no change to judge.
70
+ const listed = process.env.TOOLING_CHANGED_FILES
71
+ ? readFileSync(process.env.TOOLING_CHANGED_FILES, 'utf8').split(/\r?\n/).filter(Boolean)
72
+ : undefined;
73
+ const argFiles = process.argv.slice(2).filter((arg) => !arg.startsWith('--'));
74
+ const given = argFiles.length ? argFiles : listed;
75
+ const changed = (given ?? []).map((file) => posix(relative(repo, resolve(repo, file))));
76
+ // scope "changed" (default): only clones touching a changed file fail; with no change list,
77
+ // clones are reported without failing. scope "all": every clone fails (for repos with none).
78
+ const scopeAll = options.scope === 'all';
79
+ const reportOnly = !scopeAll && given === undefined;
80
+ if (!scopeAll && given !== undefined && !changed.length) return 0;
81
+ const configured = options.paths ?? ['src'];
82
+ const paths = configured.filter((path) => existsSync(join(repo, path)));
83
+ if (!paths.length) {
84
+ console.error(`duplication: none of ${configured.join(', ')} exist; set duplication.paths`);
85
+ return 1;
86
+ }
87
+ const output = mkdtempSync(join(tmpdir(), 'tooling-jscpd-'));
88
+ try {
89
+ const result = spawnSync(
90
+ process.execPath,
91
+ [
92
+ bin,
93
+ ...paths,
94
+ '--min-tokens',
95
+ String(options.minTokens ?? 70),
96
+ '--format',
97
+ FORMATS,
98
+ '--ignore',
99
+ [...DEFAULT_IGNORE, ...(options.ignore ?? [])].join(','),
100
+ '--reporters',
101
+ 'json',
102
+ '--output',
103
+ output,
104
+ '--silent',
105
+ '--gitignore',
106
+ ],
107
+ { cwd: repo, encoding: 'utf8' },
108
+ );
109
+ const reportPath = join(output, 'jscpd-report.json');
110
+ if (!existsSync(reportPath)) {
111
+ console.error(result.stderr || result.stdout || 'duplication: jscpd produced no report');
112
+ return 1;
113
+ }
114
+ const report = JSON.parse(readFileSync(reportPath, 'utf8'));
115
+ const clones = relevantClones(report, repo, scopeAll ? [] : changed);
116
+ for (const { first, second, lines } of clones)
117
+ console.log(
118
+ `${first.file}:${first.start}-${first.end} duplicates ${second.file}:${second.start}-${second.end} (${lines} lines). Move it to one shared module.`,
119
+ );
120
+ if (!clones.length) return 0;
121
+ if (reportOnly) {
122
+ console.log(
123
+ `duplication: ${clones.length} existing clone(s), reported only (no changed files to judge; set duplication.scope "all" to fail on them)`,
124
+ );
125
+ return 0;
126
+ }
127
+ console.log(`duplication: ${clones.length} clone(s)`);
128
+ return 1;
129
+ } finally {
130
+ rmSync(output, { recursive: true, force: true });
131
+ }
132
+ }
133
+
134
+ if (process.argv[1] && import.meta.url === pathToFileURL(process.argv[1]).href)
135
+ process.exitCode = main();