ddd-ts-kit 0.0.0-stage → 0.1.1

package/dist/check/commands/check-command.js

@@ -0,0 +1,63 @@
+import path from 'node:path';
+import { CliError } from '../../cli-error.js';
+import { Arguments } from '../../commands/arguments.js';
+import { findRoot } from '../../commands/find-root.js';
+import {} from '../../commands/command.js';
+import { isOneOf } from '../../config/index.js';
+import { CLEAN_RULE_IDS } from '../catalogue/clean-rule-ids.js';
+import { formatCheck } from '../engine/format-check.js';
+import { runCheck } from '../engine/run-check.js';
+import { summarize } from '../engine/summarize.js';
+import { loadLooseProject } from '../project/load-loose-project.js';
+import { loadProject } from '../project/load-project.js';
+import { toPosix } from '../project/to-posix.js';
+import { changedFiles } from './changed-files.js';
+import { knownRules } from './known-rules.js';
+import { selfCheck } from './self-check.js';
+const FORMATS = ['text', 'json', 'github', 'gitlab'];
+export const checkCommand = (argv, io) => {
+    const args = Arguments.parse(argv, {
+        rule: { type: 'string', multiple: true },
+        format: { type: 'string' },
+        'changed-since': { type: 'string' },
+        self: { type: 'boolean', default: false },
+        'clean-only': { type: 'boolean', default: false },
+    });
+    if (args.flag('self')) {
+        return selfCheck(args, io);
+    }
+    const format = formatOf(args);
+    const rules = knownRules(args.many('rule'));
+    const result = args.flag('clean-only') ? checkCleanliness(args, rules) : checkProject(args, rules);
+    io.out(formatCheck(result, format));
+    return result.errorCount > 0 ? 1 : 0;
+};
+function formatOf(args) {
+    const format = args.json ? 'json' : (args.text('format') ?? 'text');
+    if (isOneOf(FORMATS, format)) {
+        return format;
+    }
+    throw new CliError(`Unknown format "${format}".`, `Use one of: ${FORMATS.join(', ')}.`);
+}
+/** The rules that judge a file on its own, on any directories: no project, no config. */
+function checkCleanliness(args, rules) {
+    const directories = args.positionals.length > 0 ? args.positionals : ['.'];
+    const selected = rules.length > 0 ? rules.filter((id) => CLEAN_RULE_IDS.includes(id)) : CLEAN_RULE_IDS;
+    const project = loadLooseProject(args.workingDirectory, directories.map((entry) => toPosix(path.normalize(entry))));
+    return runCheck(project, { rules: selected });
+}
+function checkProject(args, rules) {
+    const cwd = args.workingDirectory;
+    const root = findRoot(cwd);
+    const result = runCheck(loadProject(root), { rules });
+    const scopes = args.positionals.map((entry) => toPosix(path.relative(root, path.resolve(cwd, entry))).replace(/\/$/, ''));
+    const ref = args.text('changed-since');
+    const changed = ref === undefined ? undefined : changedFiles(root, ref);
+    const reported = result.violations.filter((violation) => isInScope(violation, scopes) && (changed === undefined || changed.has(violation.file)));
+    return summarize(reported, result);
+}
+function isInScope(violation, scopes) {
+    return (scopes.length === 0 ||
+        scopes.some((scope) => scope === '' || violation.file === scope || violation.file.startsWith(`${scope}/`)));
+}
+//# sourceMappingURL=check-command.js.map

package/dist/check/commands/check-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-command.js","sourceRoot":"","sources":["../../../src/check/commands/check-command.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,uBAAuB,CAAC;AAChD,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAEhE,OAAO,EAAE,WAAW,EAAoB,MAAM,2BAA2B,CAAC;AAC1E,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AAEnD,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AACjD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAClD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,MAAM,OAAO,GAA2B,CAAC,MAAM,EAAE,MAAM,EAAE,QAAQ,EAAE,QAAQ,CAAC,CAAC;AAE7E,MAAM,CAAC,MAAM,YAAY,GAAY,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;IAChD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE;QACjC,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,QAAQ,EAAE,IAAI,EAAE;QACxC,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,eAAe,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QACnC,IAAI,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;QACzC,YAAY,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,OAAO,EAAE,KAAK,EAAE;KAClD,CAAC,CAAC;IAEH,IAAI,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,CAAC;QACtB,OAAO,SAAS,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IAC7B,CAAC;IAED,MAAM,MAAM,GAAG,QAAQ,CAAC,IAAI,CAAC,CAAC;IAC9B,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,CAAC;IAC5C,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,YAAY,CAAC,CAAC,CAAC,CAAC,gBAAgB,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC;IAEnG,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC,CAAC;IAEpC,OAAO,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,SAAS,QAAQ,CAAC,IAAe;IAC/B,MAAM,MAAM,GAAG,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,MAAM,CAAC,CAAC;IAEpE,IAAI,OAAO,CAAC,OAAO,EAAE,MAAM,CAAC,EAAE,CAAC;QAC7B,OAAO,MAAM,CAAC;IAChB,CAAC;IAED,MAAM,IAAI,QAAQ,CAAC,mBAAmB,MAAM,IAAI,EAAE,eAAe,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1F,CAAC;AAED,yFAAyF;AACzF,SAAS,gBAAgB,CAAC,IAAe,EAAE,KAAwB;IACjE,MAAM,WAAW,GAAG,IAAI,CAAC,WAAW,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IAC3E,MAAM,QAAQ,GAAG,KAAK,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,cAAc,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,cAAc,CAAC;IAEvG,MAAM,OAAO,GAAG,gBAAgB,CAC9B,IAAI,CAAC,gBAAgB,EACrB,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,CAC3D,CAAC;IAEF,OAAO,QAAQ,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,QAAQ,EAAE,CAAC,CAAC;AAChD,CAAC;AAED,SAAS,YAAY,CAAC,IAAe,EAAE,KAAwB;IAC7D,MAAM,GAAG,GAAG,IAAI,CAAC,gBAAgB,CAAC;IAClC,MAAM,IAAI,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC;IAC3B,MAAM,MAAM,GAAG,QAAQ,CAAC,WAAW,CAAC,IAAI,CAAC,EAAE,EAAE,KAAK,EAAE,CAAC,CAAC;IAEtD,MAAM,MAAM,GAAG,IAAI,CAAC,WAAW,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAC5C,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,OAAO,CAAC,GAAG,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC,CAC1E,CAAC;IAEF,MAAM,GAAG,GAAG,IAAI,CAAC,IAAI,CAAC,eAAe,CAAC,CAAC;IACvC,MAAM,OAAO,GAAG,GAAG,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,YAAY,CAAC,IAAI,EAAE,GAAG,CAAC,CAAC;IAExE,MAAM,QAAQ,GAAG,MAAM,CAAC,UAAU,CAAC,MAAM,CACvC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,SAAS,EAAE,MAAM,CAAC,IAAI,CAAC,OAAO,KAAK,SAAS,IAAI,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,IAAI,CAAC,CAAC,CACtG,CAAC;IAEF,OAAO,SAAS,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;AACrC,CAAC;AAED,SAAS,SAAS,CAAC,SAAoB,EAAE,MAAyB;IAChE,OAAO,CACL,MAAM,CAAC,MAAM,KAAK,CAAC;QACnB,MAAM,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,EAAE,IAAI,SAAS,CAAC,IAAI,KAAK,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,KAAK,GAAG,CAAC,CAAC,CAC3G,CAAC;AACJ,CAAC"}

package/dist/check/commands/check-file-command.d.ts

@@ -0,0 +1,3 @@
+import { type Command } from '../../commands/command.js';
+export declare const checkFileCommand: Command;
+//# sourceMappingURL=check-file-command.d.ts.map

package/dist/check/commands/check-file-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-file-command.d.ts","sourceRoot":"","sources":["../../../src/check/commands/check-file-command.ts"],"names":[],"mappings":"AAKA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,2BAA2B,CAAC;AASzD,eAAO,MAAM,gBAAgB,EAAE,OAmB9B,CAAC"}

package/dist/check/commands/check-file-command.js

@@ -0,0 +1,34 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { CliError } from '../../cli-error.js';
+import { Arguments } from '../../commands/arguments.js';
+import { findRoot } from '../../commands/find-root.js';
+import {} from '../../commands/command.js';
+import { readConfig } from '../../config/index.js';
+import { formatCheck } from '../engine/format-check.js';
+import { runCheck } from '../engine/run-check.js';
+import { summarize } from '../engine/summarize.js';
+import { isSource } from '../project/is-source.js';
+import { loadProject } from '../project/load-project.js';
+import { toPosix } from '../project/to-posix.js';
+export const checkFileCommand = (argv, io) => {
+    const args = Arguments.parse(argv, {});
+    const [target, ...extra] = args.positionals;
+    if (target === undefined || extra.length > 0) {
+        throw new CliError('check-file expects exactly one path.', 'Usage: ddd-ts-kit check-file <path> [--json]');
+    }
+    const absolute = path.resolve(args.workingDirectory, target);
+    const root = findRoot(path.dirname(absolute));
+    const file = toPosix(path.relative(root, absolute));
+    const result = isProjectSource(root, file)
+        ? runCheck(loadProject(root, { onlyFile: file }), { fileScopeOnly: true })
+        : summarize([]);
+    io.out(formatCheck(result, args.json ? 'json' : 'text'));
+    return result.errorCount > 0 ? 1 : 0;
+};
+/** Files outside the source root, or that are not sources, have no per-file rule: a hook stays silent on them. */
+function isProjectSource(root, file) {
+    const { config } = readConfig(root);
+    return isSource(file) && file.startsWith(`${config.sourceRoot}/`) && fs.existsSync(path.join(root, file));
+}
+//# sourceMappingURL=check-file-command.js.map

package/dist/check/commands/check-file-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"check-file-command.js","sourceRoot":"","sources":["../../../src/check/commands/check-file-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,6BAA6B,CAAC;AACvD,OAAO,EAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,2BAA2B,CAAC;AACxD,OAAO,EAAE,QAAQ,EAAE,MAAM,wBAAwB,CAAC;AAClD,OAAO,EAAE,SAAS,EAAE,MAAM,wBAAwB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,yBAAyB,CAAC;AACnD,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,OAAO,EAAE,MAAM,wBAAwB,CAAC;AAEjD,MAAM,CAAC,MAAM,gBAAgB,GAAY,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;IACpD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,CAAC,MAAM,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;IAE5C,IAAI,MAAM,KAAK,SAAS,IAAI,KAAK,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAC7C,MAAM,IAAI,QAAQ,CAAC,sCAAsC,EAAE,8CAA8C,CAAC,CAAC;IAC7G,CAAC;IAED,MAAM,QAAQ,GAAG,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,gBAAgB,EAAE,MAAM,CAAC,CAAC;IAC7D,MAAM,IAAI,GAAG,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,CAAC,CAAC;IAC9C,MAAM,IAAI,GAAG,OAAO,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,EAAE,QAAQ,CAAC,CAAC,CAAC;IAEpD,MAAM,MAAM,GAAG,eAAe,CAAC,IAAI,EAAE,IAAI,CAAC;QACxC,CAAC,CAAC,QAAQ,CAAC,WAAW,CAAC,IAAI,EAAE,EAAE,QAAQ,EAAE,IAAI,EAAE,CAAC,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC;QAC1E,CAAC,CAAC,SAAS,CAAC,EAAE,CAAC,CAAC;IAElB,EAAE,CAAC,GAAG,CAAC,WAAW,CAAC,MAAM,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC;IAEzD,OAAO,MAAM,CAAC,UAAU,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACvC,CAAC,CAAC;AAEF,kHAAkH;AAClH,SAAS,eAAe,CAAC,IAAY,EAAE,IAAY;IACjD,MAAM,EAAE,MAAM,EAAE,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAEpC,OAAO,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,MAAM,CAAC,UAAU,GAAG,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAAC;AAC5G,CAAC"}

package/dist/check/commands/explain-command.d.ts

@@ -0,0 +1,3 @@
+import { type Command } from '../../commands/command.js';
+export declare const explainCommand: Command;
+//# sourceMappingURL=explain-command.d.ts.map

package/dist/check/commands/explain-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"explain-command.d.ts","sourceRoot":"","sources":["../../../src/check/commands/explain-command.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAczD,eAAO,MAAM,cAAc,EAAE,OAyB5B,CAAC"}

package/dist/check/commands/explain-command.js

@@ -0,0 +1,59 @@
+import { CliError } from '../../cli-error.js';
+import { Arguments } from '../../commands/arguments.js';
+import {} from '../../commands/command.js';
+import { DELEGATED_RULES } from '../catalogue/delegated-rules.js';
+import { KNOWN_RULE_IDS } from '../catalogue/known-rule-ids.js';
+import { RULES } from '../catalogue/rules.js';
+import { SUPPRESSION_RULE } from '../catalogue/suppression-rule.js';
+import { RULE_DOCS } from '../explain/rule-docs.js';
+import { knownRules } from './known-rules.js';
+export const explainCommand = (argv, io) => {
+    const args = Arguments.parse(argv, {});
+    const [id] = args.positionals;
+    if (id === undefined) {
+        throw new CliError('explain needs a rule id.', `Use one of: ${KNOWN_RULE_IDS.join(', ')}.`);
+    }
+    const delegated = DELEGATED_RULES.find((rule) => rule.id === id);
+    if (delegated !== undefined) {
+        io.out(args.json
+            ? JSON.stringify({ id, description: delegated.description, checkedBy: delegated.checkedBy }, null, 2)
+            : [id, '', delegated.description, '', delegated.where].join('\n'));
+        return 0;
+    }
+    const explanation = explanationOf(id);
+    io.out(args.json ? JSON.stringify(explanation, null, 2) : formatExplanation(explanation));
+    return 0;
+};
+function explanationOf(id) {
+    knownRules([id]);
+    const rule = [...RULES, SUPPRESSION_RULE].find((candidate) => candidate.id === id);
+    const doc = RULE_DOCS[id];
+    if (rule === undefined || doc === undefined) {
+        throw new CliError(`The rule "${id}" has no explanation.`, 'Report this as a bug of ddd-ts-kit.');
+    }
+    return { id, description: rule.description, ...doc };
+}
+function formatExplanation(explanation) {
+    const indent = (block) => block
+        .split('\n')
+        .map((line) => `    ${line}`)
+        .join('\n');
+    const suppress = `Suppress one line (with a reason): // ddd-ts-kit-disable-next-line ${explanation.id} -- <reason>`;
+    const { id, description, why, bad, good } = explanation;
+    return [
+        id,
+        '',
+        description,
+        '',
+        `Why: ${why}`,
+        '',
+        'Bad:',
+        indent(bad),
+        '',
+        'Good:',
+        indent(good),
+        '',
+        suppress,
+    ].join('\n');
+}
+//# sourceMappingURL=explain-command.js.map

package/dist/check/commands/explain-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"explain-command.js","sourceRoot":"","sources":["../../../src/check/commands/explain-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,cAAc,EAAE,MAAM,gCAAgC,CAAC;AAChE,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AACpE,OAAO,EAAE,SAAS,EAAE,MAAM,yBAAyB,CAAC;AAEpD,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAO9C,MAAM,CAAC,MAAM,cAAc,GAAY,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;IAClD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,CAAC,EAAE,CAAC,GAAG,IAAI,CAAC,WAAW,CAAC;IAE9B,IAAI,EAAE,KAAK,SAAS,EAAE,CAAC;QACrB,MAAM,IAAI,QAAQ,CAAC,0BAA0B,EAAE,eAAe,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;IAC9F,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IAEjE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,EAAE,CAAC,GAAG,CACJ,IAAI,CAAC,IAAI;YACP,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,WAAW,EAAE,SAAS,CAAC,WAAW,EAAE,SAAS,EAAE,SAAS,CAAC,SAAS,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC;YACrG,CAAC,CAAC,CAAC,EAAE,EAAE,EAAE,EAAE,SAAS,CAAC,WAAW,EAAE,EAAE,EAAE,SAAS,CAAC,KAAK,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACpE,CAAC;QAEF,OAAO,CAAC,CAAC;IACX,CAAC;IAED,MAAM,WAAW,GAAG,aAAa,CAAC,EAAE,CAAC,CAAC;IAEtC,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,WAAW,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,iBAAiB,CAAC,WAAW,CAAC,CAAC,CAAC;IAE1F,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,EAAU;IAC/B,UAAU,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC;IAEjB,MAAM,IAAI,GAAG,CAAC,GAAG,KAAK,EAAE,gBAAgB,CAAC,CAAC,IAAI,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,SAAS,CAAC,EAAE,KAAK,EAAE,CAAC,CAAC;IACnF,MAAM,GAAG,GAAG,SAAS,CAAC,EAAE,CAAC,CAAC;IAE1B,IAAI,IAAI,KAAK,SAAS,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QAC5C,MAAM,IAAI,QAAQ,CAAC,aAAa,EAAE,uBAAuB,EAAE,qCAAqC,CAAC,CAAC;IACpG,CAAC;IAED,OAAO,EAAE,EAAE,EAAE,WAAW,EAAE,IAAI,CAAC,WAAW,EAAE,GAAG,GAAG,EAAE,CAAC;AACvD,CAAC;AAED,SAAS,iBAAiB,CAAC,WAAwB;IACjD,MAAM,MAAM,GAAG,CAAC,KAAa,EAAU,EAAE,CACvC,KAAK;SACF,KAAK,CAAC,IAAI,CAAC;SACX,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,OAAO,IAAI,EAAE,CAAC;SAC5B,IAAI,CAAC,IAAI,CAAC,CAAC;IAEhB,MAAM,QAAQ,GAAG,sEAAsE,WAAW,CAAC,EAAE,cAAc,CAAC;IACpH,MAAM,EAAE,EAAE,EAAE,WAAW,EAAE,GAAG,EAAE,GAAG,EAAE,IAAI,EAAE,GAAG,WAAW,CAAC;IAExD,OAAO;QACL,EAAE;QACF,EAAE;QACF,WAAW;QACX,EAAE;QACF,QAAQ,GAAG,EAAE;QACb,EAAE;QACF,MAAM;QACN,MAAM,CAAC,GAAG,CAAC;QACX,EAAE;QACF,OAAO;QACP,MAAM,CAAC,IAAI,CAAC;QACZ,EAAE;QACF,QAAQ;KACT,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC"}

package/dist/check/commands/known-rules.d.ts

@@ -0,0 +1,3 @@
+/** The ids given, when this checker runs them all; an id it does not run is a mistake of the caller. */
+export declare function knownRules(ids: readonly string[]): readonly string[];
+//# sourceMappingURL=known-rules.d.ts.map

package/dist/check/commands/known-rules.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"known-rules.d.ts","sourceRoot":"","sources":["../../../src/check/commands/known-rules.ts"],"names":[],"mappings":"AAIA,wGAAwG;AACxG,wBAAgB,UAAU,CAAC,GAAG,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,MAAM,EAAE,CAiBpE"}

package/dist/check/commands/known-rules.js

@@ -0,0 +1,16 @@
+import { CliError } from '../../cli-error.js';
+import { DELEGATED_RULES } from '../catalogue/delegated-rules.js';
+import { RULE_IDS } from '../catalogue/rule-ids.js';
+/** The ids given, when this checker runs them all; an id it does not run is a mistake of the caller. */
+export function knownRules(ids) {
+    const unknown = ids.find((id) => !RULE_IDS.includes(id));
+    if (unknown === undefined) {
+        return ids;
+    }
+    const delegated = DELEGATED_RULES.find((rule) => rule.id === unknown);
+    if (delegated !== undefined) {
+        throw new CliError(`The rule "${unknown}" is ${delegated.authority}, not by this command.`, `Run \`${delegated.script}\` for it; \`ddd-ts-kit check\` holds the rules listed by \`ddd-ts-kit rules\` without that mention.`);
+    }
+    throw new CliError(`Unknown rule "${unknown}".`, `Use one of: ${RULE_IDS.join(', ')}.`);
+}
+//# sourceMappingURL=known-rules.js.map

package/dist/check/commands/known-rules.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"known-rules.js","sourceRoot":"","sources":["../../../src/check/commands/known-rules.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,QAAQ,EAAE,MAAM,oBAAoB,CAAC;AAC9C,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,wGAAwG;AACxG,MAAM,UAAU,UAAU,CAAC,GAAsB;IAC/C,MAAM,OAAO,GAAG,GAAG,CAAC,IAAI,CAAC,CAAC,EAAE,EAAE,EAAE,CAAC,CAAC,QAAQ,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC;IAEzD,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;QAC1B,OAAO,GAAG,CAAC;IACb,CAAC;IAED,MAAM,SAAS,GAAG,eAAe,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,OAAO,CAAC,CAAC;IAEtE,IAAI,SAAS,KAAK,SAAS,EAAE,CAAC;QAC5B,MAAM,IAAI,QAAQ,CAChB,aAAa,OAAO,QAAQ,SAAS,CAAC,SAAS,wBAAwB,EACvE,SAAS,SAAS,CAAC,MAAM,sGAAsG,CAChI,CAAC;IACJ,CAAC;IAED,MAAM,IAAI,QAAQ,CAAC,iBAAiB,OAAO,IAAI,EAAE,eAAe,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC;AAC1F,CAAC"}

package/dist/check/commands/rules-command.d.ts

@@ -0,0 +1,3 @@
+import { type Command } from '../../commands/command.js';
+export declare const rulesCommand: Command;
+//# sourceMappingURL=rules-command.d.ts.map

package/dist/check/commands/rules-command.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules-command.d.ts","sourceRoot":"","sources":["../../../src/check/commands/rules-command.ts"],"names":[],"mappings":"AAGA,OAAO,EAAE,KAAK,OAAO,EAAE,MAAM,2BAA2B,CAAC;AAezD,eAAO,MAAM,YAAY,EAAE,OAS1B,CAAC"}

package/dist/check/commands/rules-command.js

@@ -0,0 +1,38 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { Arguments } from '../../commands/arguments.js';
+import {} from '../../commands/command.js';
+import { CONFIG_FILE, isOneOf, readConfig, SEVERITIES } from '../../config/index.js';
+import { DEFAULT_SEVERITIES } from '../catalogue/default-severities.js';
+import { DELEGATED_RULES } from '../catalogue/delegated-rules.js';
+import { RULES } from '../catalogue/rules.js';
+import { SUPPRESSION_RULE } from '../catalogue/suppression-rule.js';
+export const rulesCommand = (argv, io) => {
+    const args = Arguments.parse(argv, {});
+    const rules = listedRules(args.projectRoot);
+    const width = Math.max(...rules.map((rule) => rule.id.length));
+    const lines = rules.map((rule) => `${rule.id.padEnd(width)}  ${rule.severity.padEnd(5)}  ${rule.description}`);
+    io.out(args.json ? JSON.stringify(rules, null, 2) : lines.join('\n'));
+    return 0;
+};
+function listedRules(root) {
+    const configured = fs.existsSync(path.join(root, CONFIG_FILE)) ? readConfig(root).config.rules : {};
+    const severityOf = (id) => {
+        const severity = configured[id];
+        return isOneOf(SEVERITIES, severity) ? severity : (DEFAULT_SEVERITIES[id] ?? 'error');
+    };
+    const own = [...RULES, SUPPRESSION_RULE].map((rule) => ({
+        id: rule.id,
+        severity: severityOf(rule.id),
+        description: rule.description,
+        checkedBy: 'ddd-ts-kit check',
+    }));
+    const delegated = DELEGATED_RULES.map((rule) => ({
+        id: rule.id,
+        severity: severityOf(rule.id),
+        description: `${rule.description} (${rule.authority})`,
+        checkedBy: rule.checkedBy,
+    }));
+    return [...own, ...delegated];
+}
+//# sourceMappingURL=rules-command.js.map

package/dist/check/commands/rules-command.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"rules-command.js","sourceRoot":"","sources":["../../../src/check/commands/rules-command.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AACxD,OAAO,EAAgB,MAAM,2BAA2B,CAAC;AACzD,OAAO,EAAE,WAAW,EAAE,OAAO,EAAE,UAAU,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACrF,OAAO,EAAE,kBAAkB,EAAE,MAAM,oCAAoC,CAAC;AACxE,OAAO,EAAE,eAAe,EAAE,MAAM,iCAAiC,CAAC;AAClE,OAAO,EAAE,KAAK,EAAE,MAAM,uBAAuB,CAAC;AAC9C,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAUpE,MAAM,CAAC,MAAM,YAAY,GAAY,CAAC,IAAI,EAAE,EAAE,EAAE,EAAE;IAChD,MAAM,IAAI,GAAG,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;IACvC,MAAM,KAAK,GAAG,WAAW,CAAC,IAAI,CAAC,WAAW,CAAC,CAAC;IAC5C,MAAM,KAAK,GAAG,IAAI,CAAC,GAAG,CAAC,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,CAAC,CAAC;IAC/D,MAAM,KAAK,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,GAAG,IAAI,CAAC,EAAE,CAAC,MAAM,CAAC,KAAK,CAAC,KAAK,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC,CAAC,CAAC,KAAK,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAE/G,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC,KAAK,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;IAEtE,OAAO,CAAC,CAAC;AACX,CAAC,CAAC;AAEF,SAAS,WAAW,CAAC,IAAY;IAC/B,MAAM,UAAU,GAAG,EAAE,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,UAAU,CAAC,IAAI,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC,CAAC,EAAE,CAAC;IAEpG,MAAM,UAAU,GAAG,CAAC,EAAU,EAAU,EAAE;QACxC,MAAM,QAAQ,GAAG,UAAU,CAAC,EAAE,CAAC,CAAC;QAEhC,OAAO,OAAO,CAAC,UAAU,EAAE,QAAQ,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,CAAC,CAAC,CAAC,kBAAkB,CAAC,EAAE,CAAC,IAAI,OAAO,CAAC,CAAC;IACxF,CAAC,CAAC;IAEF,MAAM,GAAG,GAAG,CAAC,GAAG,KAAK,EAAE,gBAAgB,CAAC,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QACtD,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,WAAW,EAAE,IAAI,CAAC,WAAW;QAC7B,SAAS,EAAE,kBAAkB;KAC9B,CAAC,CAAC,CAAC;IAEJ,MAAM,SAAS,GAAG,eAAe,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC;QAC/C,EAAE,EAAE,IAAI,CAAC,EAAE;QACX,QAAQ,EAAE,UAAU,CAAC,IAAI,CAAC,EAAE,CAAC;QAC7B,WAAW,EAAE,GAAG,IAAI,CAAC,WAAW,KAAK,IAAI,CAAC,SAAS,GAAG;QACtD,SAAS,EAAE,IAAI,CAAC,SAAS;KAC1B,CAAC,CAAC,CAAC;IAEJ,OAAO,CAAC,GAAG,GAAG,EAAE,GAAG,SAAS,CAAC,CAAC;AAChC,CAAC"}

package/dist/check/commands/self-check.d.ts

@@ -0,0 +1,5 @@
+import type { Arguments } from '../../commands/arguments.js';
+import type { Io } from '../../commands/io.js';
+/** `check --self`: replays the rule fixtures shipped with the CLI and exits 0 when every rule behaves as expected. */
+export declare function selfCheck(args: Arguments, io: Io): number;
+//# sourceMappingURL=self-check.d.ts.map

package/dist/check/commands/self-check.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-check.d.ts","sourceRoot":"","sources":["../../../src/check/commands/self-check.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,6BAA6B,CAAC;AAC7D,OAAO,KAAK,EAAE,EAAE,EAAE,MAAM,sBAAsB,CAAC;AAG/C,sHAAsH;AACtH,wBAAgB,SAAS,CAAC,IAAI,EAAE,SAAS,EAAE,EAAE,EAAE,EAAE,GAAG,MAAM,CAsBzD"}

package/dist/check/commands/self-check.js

@@ -0,0 +1,23 @@
+import { runSelfCheck } from '../fixtures/run-self-check.js';
+/** `check --self`: replays the rule fixtures shipped with the CLI and exits 0 when every rule behaves as expected. */
+export function selfCheck(args, io) {
+    const outcomes = runSelfCheck();
+    const failed = outcomes.filter((outcome) => !outcome.ok);
+    if (args.json) {
+        const fixtures = outcomes.map(({ fixture, ok, detail }) => ({
+            ruleId: fixture.ruleId,
+            name: fixture.name,
+            ok,
+            detail,
+        }));
+        io.out(JSON.stringify({ ok: failed.length === 0, fixtures }, null, 2));
+    }
+    else {
+        for (const { fixture, ok, detail } of outcomes) {
+            io.out(`${ok ? 'ok  ' : 'FAIL'}  ${fixture.ruleId}: ${fixture.name}${ok ? '' : `\n      ${detail}`}`);
+        }
+        io.out(`\n${outcomes.length - failed.length}/${outcomes.length} rule fixtures behave as expected.`);
+    }
+    return failed.length === 0 ? 0 : 1;
+}
+//# sourceMappingURL=self-check.js.map

package/dist/check/commands/self-check.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"self-check.js","sourceRoot":"","sources":["../../../src/check/commands/self-check.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,+BAA+B,CAAC;AAE7D,sHAAsH;AACtH,MAAM,UAAU,SAAS,CAAC,IAAe,EAAE,EAAM;IAC/C,MAAM,QAAQ,GAAG,YAAY,EAAE,CAAC;IAChC,MAAM,MAAM,GAAG,QAAQ,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC,OAAO,CAAC,EAAE,CAAC,CAAC;IAEzD,IAAI,IAAI,CAAC,IAAI,EAAE,CAAC;QACd,MAAM,QAAQ,GAAG,QAAQ,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,EAAE,EAAE,CAAC,CAAC;YAC1D,MAAM,EAAE,OAAO,CAAC,MAAM;YACtB,IAAI,EAAE,OAAO,CAAC,IAAI;YAClB,EAAE;YACF,MAAM;SACP,CAAC,CAAC,CAAC;QAEJ,EAAE,CAAC,GAAG,CAAC,IAAI,CAAC,SAAS,CAAC,EAAE,EAAE,EAAE,MAAM,CAAC,MAAM,KAAK,CAAC,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC;IACzE,CAAC;SAAM,CAAC;QACN,KAAK,MAAM,EAAE,OAAO,EAAE,EAAE,EAAE,MAAM,EAAE,IAAI,QAAQ,EAAE,CAAC;YAC/C,EAAE,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,MAAM,KAAK,OAAO,CAAC,MAAM,KAAK,OAAO,CAAC,IAAI,GAAG,EAAE,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,WAAW,MAAM,EAAE,EAAE,CAAC,CAAC;QACxG,CAAC;QAED,EAAE,CAAC,GAAG,CAAC,KAAK,QAAQ,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,QAAQ,CAAC,MAAM,oCAAoC,CAAC,CAAC;IACtG,CAAC;IAED,OAAO,MAAM,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC;AACrC,CAAC"}

package/dist/check/comments/comment-lines.d.ts

@@ -0,0 +1,14 @@
+import type { SourceFile } from '../model/source-file.js';
+/** One line of comment text, whatever the comment syntax, with what the comment rules need to know. */
+export interface CommentLine {
+    readonly line: number;
+    readonly text: string;
+    readonly block: boolean;
+    readonly jsdoc: boolean;
+    /** True when code precedes the comment on its line. */
+    readonly trailing: boolean;
+    /** Inside a JSDoc `@example` or a fenced block: code is expected there. */
+    readonly sample: boolean;
+}
+export declare function commentLines(file: SourceFile): CommentLine[];
+//# sourceMappingURL=comment-lines.d.ts.map

package/dist/check/comments/comment-lines.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-lines.d.ts","sourceRoot":"","sources":["../../../src/check/comments/comment-lines.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,yBAAyB,CAAC;AAG1D,uGAAuG;AACvG,MAAM,WAAW,WAAW;IAC1B,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,IAAI,EAAE,MAAM,CAAC;IACtB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,QAAQ,CAAC,KAAK,EAAE,OAAO,CAAC;IACxB,uDAAuD;IACvD,QAAQ,CAAC,QAAQ,EAAE,OAAO,CAAC;IAC3B,2EAA2E;IAC3E,QAAQ,CAAC,MAAM,EAAE,OAAO,CAAC;CAC1B;AAED,wBAAgB,YAAY,CAAC,IAAI,EAAE,UAAU,GAAG,WAAW,EAAE,CAW5D"}

package/dist/check/comments/comment-lines.js

@@ -0,0 +1,34 @@
+export function commentLines(file) {
+    const lines = file.scan.comments.map((comment) => ({
+        line: comment.line,
+        text: comment.text,
+        block: false,
+        jsdoc: false,
+        trailing: !comment.ownLine,
+        sample: false,
+    }));
+    return [...lines, ...file.scan.blockComments.flatMap(linesOfBlock)].sort((a, b) => a.line - b.line);
+}
+function linesOfBlock(comment) {
+    let sample = false;
+    let fenced = false;
+    return comment.text.split('\n').map((raw, index) => {
+        const text = raw.replace(/^\s*\*+ ?/, '').trim();
+        const fence = text.startsWith('```');
+        if (fence) {
+            fenced = !fenced;
+        }
+        else if (text.startsWith('@')) {
+            sample = text.startsWith('@example');
+        }
+        return {
+            line: comment.line + index,
+            text,
+            block: true,
+            jsdoc: comment.jsdoc,
+            trailing: false,
+            sample: sample || fenced || fence,
+        };
+    });
+}
+//# sourceMappingURL=comment-lines.js.map

package/dist/check/comments/comment-lines.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"comment-lines.js","sourceRoot":"","sources":["../../../src/check/comments/comment-lines.ts"],"names":[],"mappings":"AAeA,MAAM,UAAU,YAAY,CAAC,IAAgB;IAC3C,MAAM,KAAK,GAAkB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAChE,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,IAAI,EAAE,OAAO,CAAC,IAAI;QAClB,KAAK,EAAE,KAAK;QACZ,KAAK,EAAE,KAAK;QACZ,QAAQ,EAAE,CAAC,OAAO,CAAC,OAAO;QAC1B,MAAM,EAAE,KAAK;KACd,CAAC,CAAC,CAAC;IAEJ,OAAO,CAAC,GAAG,KAAK,EAAE,GAAG,IAAI,CAAC,IAAI,CAAC,aAAa,CAAC,OAAO,CAAC,YAAY,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,CAAC,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,GAAG,CAAC,CAAC,IAAI,CAAC,CAAC;AACtG,CAAC;AAED,SAAS,YAAY,CAAC,OAA2B;IAC/C,IAAI,MAAM,GAAG,KAAK,CAAC;IACnB,IAAI,MAAM,GAAG,KAAK,CAAC;IAEnB,OAAO,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,KAAK,EAAE,EAAE;QACjD,MAAM,IAAI,GAAG,GAAG,CAAC,OAAO,CAAC,WAAW,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;QACjD,MAAM,KAAK,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC;QAErC,IAAI,KAAK,EAAE,CAAC;YACV,MAAM,GAAG,CAAC,MAAM,CAAC;QACnB,CAAC;aAAM,IAAI,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,EAAE,CAAC;YAChC,MAAM,GAAG,IAAI,CAAC,UAAU,CAAC,UAAU,CAAC,CAAC;QACvC,CAAC;QAED,OAAO;YACL,IAAI,EAAE,OAAO,CAAC,IAAI,GAAG,KAAK;YAC1B,IAAI;YACJ,KAAK,EAAE,IAAI;YACX,KAAK,EAAE,OAAO,CAAC,KAAK;YACpB,QAAQ,EAAE,KAAK;YACf,MAAM,EAAE,MAAM,IAAI,MAAM,IAAI,KAAK;SAClC,CAAC;IACJ,CAAC,CAAC,CAAC;AACL,CAAC"}

package/dist/check/comments/is-directive.d.ts

@@ -0,0 +1,3 @@
+/** Comments that are instructions to a tool, not prose: never judged as code or noise. */
+export declare function isDirective(text: string): boolean;
+//# sourceMappingURL=is-directive.d.ts.map

package/dist/check/comments/is-directive.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-directive.d.ts","sourceRoot":"","sources":["../../../src/check/comments/is-directive.ts"],"names":[],"mappings":"AAGA,0FAA0F;AAC1F,wBAAgB,WAAW,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAEjD"}

package/dist/check/comments/is-directive.js

@@ -0,0 +1,6 @@
+const DIRECTIVE = /^(?:\/?ddd-ts-kit[-:]|eslint-|@ts-|prettier-|biome-|istanbul |c8 |v8 |#region|#endregion|@vitest-|@jest-|\/ <reference)/;
+/** Comments that are instructions to a tool, not prose: never judged as code or noise. */
+export function isDirective(text) {
+    return DIRECTIVE.test(text);
+}
+//# sourceMappingURL=is-directive.js.map

package/dist/check/comments/is-directive.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"is-directive.js","sourceRoot":"","sources":["../../../src/check/comments/is-directive.ts"],"names":[],"mappings":"AAAA,MAAM,SAAS,GACb,yHAAyH,CAAC;AAE5H,0FAA0F;AAC1F,MAAM,UAAU,WAAW,CAAC,IAAY;IACtC,OAAO,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC9B,CAAC"}

package/dist/check/comments/looks-like-code.d.ts

@@ -0,0 +1,2 @@
+export declare function looksLikeCode(text: string): boolean;
+//# sourceMappingURL=looks-like-code.d.ts.map

package/dist/check/comments/looks-like-code.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"looks-like-code.d.ts","sourceRoot":"","sources":["../../../src/check/comments/looks-like-code.ts"],"names":[],"mappings":"AAwBA,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,OAAO,CAiBnD"}

package/dist/check/comments/looks-like-code.js

@@ -0,0 +1,42 @@
+import { isDirective } from './is-directive.js';
+const CODE_SHAPES = [
+    /;\s*$/,
+    /^[)}\]]+[;,]?$/,
+    /[^\s]\s*\{$/,
+    /^(?:const|let|var)\s+[\w${[][^=]*=/,
+    /^import\s.*\bfrom\s+['"]/,
+    /^import\s+['"]/,
+    /^export\s+(?:const|let|function|class|default|type|interface|\{|\*)/,
+    /^return\s+[^.]*[;)\]}]$/,
+    /^(?:if|for|while|switch)\s*\(.*\)\s*\{?$/,
+    /^(?:else|try|finally)\s*\{$/,
+    /^await\s+[\w$.]+\(/,
+    /^[\w$.]+\s*(?:=|\+=|-=)\s*[^=].*[;)\]}'"\w]$/,
+    /=>\s*[{(]/,
+    /\([^)]*\)\s*=>/,
+    /^[\w$.#]+\([^)]*\)[;,]?$/,
+    /^(?:public|private|protected|static|readonly|async)\s+[\w$#]+\s*[(:=]/,
+];
+/** Prose sometimes ends like code; these openings are never statements. */
+const PROSE = /^(?:TODO|FIXME|NOTE|See |see |e\.g\.|i\.e\.|https?:)/;
+export function looksLikeCode(text) {
+    // Code quoted in backticks inside a sentence is documentation, not a leftover.
+    const trimmed = text.replace(/`[^`]*`/g, '').trim();
+    if (PROSE.test(trimmed) || isDirective(trimmed)) {
+        return false;
+    }
+    if (trimmed.length < 3) {
+        return /^[)}\]]+;?$/.test(trimmed);
+    }
+    if (readsAsProse(trimmed)) {
+        return false;
+    }
+    return CODE_SHAPES.some((shape) => shape.test(trimmed));
+}
+/** A sentence is mostly plain words; a statement is mostly identifiers glued to punctuation. */
+function readsAsProse(text) {
+    const tokens = text.split(/\s+/);
+    const words = tokens.filter((token) => /^[A-Za-z'`-]+[,.:;!?]?$/.test(token));
+    return tokens.length >= 5 && words.length / tokens.length >= 0.8;
+}
+//# sourceMappingURL=looks-like-code.js.map

package/dist/check/comments/looks-like-code.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"looks-like-code.js","sourceRoot":"","sources":["../../../src/check/comments/looks-like-code.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,mBAAmB,CAAC;AAEhD,MAAM,WAAW,GAAsB;IACrC,OAAO;IACP,gBAAgB;IAChB,aAAa;IACb,oCAAoC;IACpC,0BAA0B;IAC1B,gBAAgB;IAChB,qEAAqE;IACrE,yBAAyB;IACzB,0CAA0C;IAC1C,6BAA6B;IAC7B,oBAAoB;IACpB,8CAA8C;IAC9C,WAAW;IACX,gBAAgB;IAChB,0BAA0B;IAC1B,uEAAuE;CACxE,CAAC;AAEF,2EAA2E;AAC3E,MAAM,KAAK,GAAG,sDAAsD,CAAC;AAErE,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,+EAA+E;IAC/E,MAAM,OAAO,GAAG,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;IAEpD,IAAI,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,IAAI,WAAW,CAAC,OAAO,CAAC,EAAE,CAAC;QAChD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,IAAI,OAAO,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACvB,OAAO,aAAa,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC;IACrC,CAAC;IAED,IAAI,YAAY,CAAC,OAAO,CAAC,EAAE,CAAC;QAC1B,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,WAAW,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;AAC1D,CAAC;AAED,gGAAgG;AAChG,SAAS,YAAY,CAAC,IAAY;IAChC,MAAM,MAAM,GAAG,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC;IACjC,MAAM,KAAK,GAAG,MAAM,CAAC,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,yBAAyB,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC;IAE9E,OAAO,MAAM,CAAC,MAAM,IAAI,CAAC,IAAI,KAAK,CAAC,MAAM,GAAG,MAAM,CAAC,MAAM,IAAI,GAAG,CAAC;AACnE,CAAC"}

package/dist/check/comments/restates-name.d.ts

@@ -0,0 +1,3 @@
+/** True when the description says nothing the name does not already say. */
+export declare function restatesName(description: string, name: string): boolean;
+//# sourceMappingURL=restates-name.d.ts.map

package/dist/check/comments/restates-name.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"restates-name.d.ts","sourceRoot":"","sources":["../../../src/check/comments/restates-name.ts"],"names":[],"mappings":"AAuCA,4EAA4E;AAC5E,wBAAgB,YAAY,CAAC,WAAW,EAAE,MAAM,EAAE,IAAI,EAAE,MAAM,GAAG,OAAO,CAevE"}

package/dist/check/comments/restates-name.js

@@ -0,0 +1,49 @@
+import { splitWords } from '../../naming/index.js';
+import { sameWord } from '../language/same-word.js';
+/** Words that add nothing to the name they sit next to. */
+const FILLER = new Set([
+    'the',
+    'a',
+    'an',
+    'of',
+    'this',
+    'that',
+    'for',
+    'to',
+    'is',
+    'it',
+    'its',
+    'new',
+    'given',
+    'current',
+    'class',
+    'function',
+    'method',
+    'property',
+    'field',
+    'constructor',
+    'instance',
+    'object',
+    'value',
+    'get',
+    'set',
+    'return',
+    'create',
+    'represent',
+    'define',
+    'implementation',
+    'interface',
+    'type',
+]);
+/** True when the description says nothing the name does not already say. */
+export function restatesName(description, name) {
+    const said = splitWords(description.replace(/[.`'"]/g, ' '));
+    if (said.length === 0 || said.length > 8) {
+        return false;
+    }
+    const named = splitWords(name);
+    return said.every((word) => FILLER.has(word) ||
+        [...FILLER].some((filler) => sameWord(filler, word)) ||
+        named.some((part) => sameWord(part, word)));
+}
+//# sourceMappingURL=restates-name.js.map

package/dist/check/comments/restates-name.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"restates-name.js","sourceRoot":"","sources":["../../../src/check/comments/restates-name.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,uBAAuB,CAAC;AACnD,OAAO,EAAE,QAAQ,EAAE,MAAM,0BAA0B,CAAC;AAEpD,2DAA2D;AAC3D,MAAM,MAAM,GAAG,IAAI,GAAG,CAAC;IACrB,KAAK;IACL,GAAG;IACH,IAAI;IACJ,IAAI;IACJ,MAAM;IACN,MAAM;IACN,KAAK;IACL,IAAI;IACJ,IAAI;IACJ,IAAI;IACJ,KAAK;IACL,KAAK;IACL,OAAO;IACP,SAAS;IACT,OAAO;IACP,UAAU;IACV,QAAQ;IACR,UAAU;IACV,OAAO;IACP,aAAa;IACb,UAAU;IACV,QAAQ;IACR,OAAO;IACP,KAAK;IACL,KAAK;IACL,QAAQ;IACR,QAAQ;IACR,WAAW;IACX,QAAQ;IACR,gBAAgB;IAChB,WAAW;IACX,MAAM;CACP,CAAC,CAAC;AAEH,4EAA4E;AAC5E,MAAM,UAAU,YAAY,CAAC,WAAmB,EAAE,IAAY;IAC5D,MAAM,IAAI,GAAG,UAAU,CAAC,WAAW,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC,CAAC;IAE7D,IAAI,IAAI,CAAC,MAAM,KAAK,CAAC,IAAI,IAAI,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QACzC,OAAO,KAAK,CAAC;IACf,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,IAAI,CAAC,CAAC;IAE/B,OAAO,IAAI,CAAC,KAAK,CACf,CAAC,IAAI,EAAE,EAAE,CACP,MAAM,CAAC,GAAG,CAAC,IAAI,CAAC;QAChB,CAAC,GAAG,MAAM,CAAC,CAAC,IAAI,CAAC,CAAC,MAAM,EAAE,EAAE,CAAC,QAAQ,CAAC,MAAM,EAAE,IAAI,CAAC,CAAC;QACpD,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,QAAQ,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,CAC7C,CAAC;AACJ,CAAC"}

package/dist/check/configuration/config-inspection.d.ts

@@ -0,0 +1,28 @@
+import { type ContextConfig } from '../../config/index.js';
+import type { Project } from '../model/project.js';
+import type { Report } from '../model/report.js';
+import type { Violation } from '../model/violation.js';
+/** What `config/valid` looks at in one project, each finding placed on a line of the config file. */
+export declare class ConfigInspection {
+    private readonly project;
+    private readonly report;
+    constructor(project: Project, report: Report);
+    declaredContext(name: string, context: ContextConfig): Violation[];
+    undeclaredDirectories(): Violation[];
+    ruleSettings(known: readonly string[]): Violation[];
+    guardMode(): Violation[];
+    /** A limit above the ceiling is read as the ceiling: the config says something the checker does not do. */
+    functionLinesLimit(): Violation[];
+    /** A commit limit that is not a positive integer is read as its default: the config says something nothing does. */
+    commitLimits(): Violation[];
+    /** A threshold that is not a percentage is read as the reference: the config says something no run enforces. */
+    coverageThresholds(): Violation[];
+    /** An entry without a file or without a reason allows nothing: it is ignored, and has to be said. */
+    onePerFileAllowances(): Violation[];
+    private classification;
+    private upstream;
+    private presence;
+    /** A violation located on the line of the config file that first quotes `needle`. */
+    private inConfig;
+}
+//# sourceMappingURL=config-inspection.d.ts.map

package/dist/check/configuration/config-inspection.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"config-inspection.d.ts","sourceRoot":"","sources":["../../../src/check/configuration/config-inspection.ts"],"names":[],"mappings":"AAAA,OAAO,EAUL,KAAK,aAAa,EAEnB,MAAM,uBAAuB,CAAC;AAC/B,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,qBAAqB,CAAC;AACnD,OAAO,KAAK,EAAE,MAAM,EAAE,MAAM,oBAAoB,CAAC;AACjD,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,uBAAuB,CAAC;AAMvD,qGAAqG;AACrG,qBAAa,gBAAgB;IAEzB,OAAO,CAAC,QAAQ,CAAC,OAAO;IACxB,OAAO,CAAC,QAAQ,CAAC,MAAM;IAFzB,YACmB,OAAO,EAAE,OAAO,EAChB,MAAM,EAAE,MAAM,EAC7B;IAEJ,eAAe,CAAC,IAAI,EAAE,MAAM,EAAE,OAAO,EAAE,aAAa,GAAG,SAAS,EAAE,CAMjE;IAED,qBAAqB,IAAI,SAAS,EAAE,CAanC;IAED,YAAY,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,GAAG,SAAS,EAAE,CAoBlD;IAED,SAAS,IAAI,SAAS,EAAE,CAcvB;IAED,2GAA2G;IAC3G,kBAAkB,IAAI,SAAS,EAAE,CAiBhC;IAED,oHAAoH;IACpH,YAAY,IAAI,SAAS,EAAE,CAI1B;IAED,gHAAgH;IAChH,kBAAkB,IAAI,SAAS,EAAE,CAIhC;IAED,qGAAqG;IACrG,oBAAoB,IAAI,SAAS,EAAE,CA4BlC;IAED,OAAO,CAAC,cAAc;IActB,OAAO,CAAC,QAAQ;IAgChB,OAAO,CAAC,QAAQ;IAiBhB,qFAAqF;IACrF,OAAO,CAAC,QAAQ;CAGjB"}