ddd-ts-kit 0.0.0-stage → 0.1.0

package/dist/check/fixtures/tree-fixtures.js

@@ -0,0 +1,194 @@
+import { CONFIG_FILE } from '../../config/index.js';
+import { CONTEXT_DOC_HEADINGS } from '../canonical/context-doc-headings.js';
+import { aggregate } from './aggregate.js';
+import { config } from './config.js';
+import { contextDoc } from './context-doc.js';
+import { DECLARED } from './declared.js';
+import { declaredProject } from './declared-project.js';
+import { handler } from './handler.js';
+import { PATHS } from './paths.js';
+import { project } from './project.js';
+import { SAMPLES } from './samples.js';
+const { AGGREGATE, BARREL, BILLING, JOB, JOB_SPEC, MODULE, POLICY, ROUTES } = PATHS;
+const { SPEC } = SAMPLES;
+export const TREE_FIXTURES = [
+    {
+        ruleId: 'tree/closed',
+        name: 'canonical directories, an open use-case level and a declared extra directory',
+        expect: 'pass',
+        files: project({
+            ...handler('export class IssueInvoiceHandler {}\n'),
+            [`${BILLING}/infrastructure/messaging/outbox.ts`]: 'export const outbox = 1;\n',
+            [`${BILLING}/test/unit/domain/deep/anything.spec.ts`]: SPEC,
+            [`${BILLING}/billing.module.ts`]: 'export const billingModule = {};\n',
+        }, {
+            [CONFIG_FILE]: config({
+                contexts: {
+                    billing: {
+                        classification: 'core',
+                        upstreams: ['catalog'],
+                        extraDirectories: [{ path: 'infrastructure/messaging', reason: 'outbox relay' }],
+                    },
+                    catalog: { classification: 'supporting', upstreams: [] },
+                },
+            }),
+        }),
+    },
+    {
+        ruleId: 'tree/closed',
+        name: 'an ad hoc directory',
+        expect: { file: `${BILLING}/domain/utils` },
+        files: project({ [`${BILLING}/domain/utils/rounding.ts`]: 'export const rounding = 1;\n' }),
+    },
+    {
+        ruleId: 'tree/closed',
+        name: 'a source file outside a role directory',
+        expect: { file: `${BILLING}/domain/rounding.ts` },
+        files: project({ [`${BILLING}/domain/rounding.ts`]: 'export const rounding = 1;\n' }),
+    },
+    {
+        ruleId: 'tree/context-doc',
+        name: 'a complete CONTEXT.md',
+        expect: 'pass',
+        files: project({}),
+    },
+    {
+        ruleId: 'tree/context-doc',
+        name: 'no CONTEXT.md',
+        expect: { file: `${BILLING}/CONTEXT.md` },
+        files: (() => {
+            const { [`${BILLING}/CONTEXT.md`]: _removed, ...rest } = project({
+                [`${BILLING}/published-language/index.ts`]: 'export {};\n',
+            });
+            return rest;
+        })(),
+    },
+    {
+        ruleId: 'tree/context-doc',
+        name: 'a missing section',
+        expect: { file: `${BILLING}/CONTEXT.md` },
+        files: project({}, {
+            [`${BILLING}/CONTEXT.md`]: contextDoc('core', CONTEXT_DOC_HEADINGS.filter((heading) => heading !== '## Relationships')),
+        }),
+    },
+    {
+        ruleId: 'tree/context-doc',
+        name: 'a classification that contradicts the config',
+        expect: { file: `${BILLING}/CONTEXT.md` },
+        files: project({}, { [`${BILLING}/CONTEXT.md`]: contextDoc('generic') }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'role suffixes in kebab-case',
+        expect: 'pass',
+        files: project({
+            ...aggregate('export class Invoice {}\n'),
+            [`${BILLING}/domain/errors/invoice-already-issued.error.ts`]: 'export class InvoiceAlreadyIssuedError extends Error {}\n',
+            [`${BILLING}/domain/errors/index.ts`]: "export * from '@/contexts/billing/domain/errors/invoice-already-issued.error.js';\n",
+            [`${BILLING}/presentation/http/invoice.dto.ts`]: 'export interface InvoiceDto { readonly id: string }\n',
+        }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'a file without the suffix of its role',
+        expect: { file: `${BILLING}/domain/errors/invoice-already-issued.ts` },
+        files: project({
+            [`${BILLING}/domain/errors/invoice-already-issued.ts`]: 'export class InvoiceAlreadyIssued extends Error {}\n',
+        }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'a file name that is not kebab-case',
+        expect: { file: `${BILLING}/domain/errors/InvoiceAlreadyIssued.error.ts` },
+        also: ['clean/one-export-per-file'],
+        files: project({
+            [`${BILLING}/domain/errors/InvoiceAlreadyIssued.error.ts`]: 'export class InvoiceAlreadyIssuedError extends Error {}\n',
+        }),
+    },
+    {
+        ruleId: 'naming/one-concept-per-file',
+        name: 'one exported class, with private helpers and types',
+        expect: 'pass',
+        files: project(aggregate('class Money {}\n\nexport interface InvoiceState {\n  readonly total: Money;\n}\n\nexport class Invoice {\n  constructor(readonly state: InvoiceState) {}\n}\n// export class Ghost {}\n'), { [CONFIG_FILE]: config({ rules: { 'clean/no-commented-out-code': 'off' } }) }),
+    },
+    {
+        ruleId: 'naming/one-concept-per-file',
+        name: 'two exported classes in an aggregate file',
+        expect: { file: AGGREGATE },
+        also: ['clean/one-export-per-file'],
+        files: project(aggregate('export class Invoice {}\nexport class IssuedInvoice {}\n')),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'a builder without its suffix',
+        expect: { file: `${BILLING}/test/builders/invoice.ts` },
+        files: project({ [`${BILLING}/test/builders/invoice.ts`]: 'export const anInvoice = 1;\n' }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'declared style: the routes file named after the context, a result next to its command, a job',
+        expect: 'pass',
+        files: declaredProject({
+            [ROUTES]: 'export const billingRoutes = (): unknown[] => [];\n',
+            [`${BILLING}/application/commands/issue-invoice/issue-invoice.result.ts`]: 'export interface IssueInvoiceResult {\n  readonly invoiceId: string;\n}\n',
+            [JOB]: DECLARED.job,
+            [JOB_SPEC]: SPEC,
+        }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'explicit style: a routes file named after the context',
+        expect: 'pass',
+        files: project({ [ROUTES]: 'export const billingRoutes = (): unknown[] => [];\n' }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'a routes file named after another context',
+        expect: { file: `${BILLING}/presentation/http/shipping.routes.ts` },
+        files: project({
+            [`${BILLING}/presentation/http/shipping.routes.ts`]: 'export const shippingRoutes = (): unknown[] => [];\n',
+        }),
+    },
+    {
+        ruleId: 'naming/suffix',
+        name: 'a job without its suffix',
+        expect: { file: `${BILLING}/application/scheduling/send-reminders.ts` },
+        files: project({ [`${BILLING}/application/scheduling/send-reminders.ts`]: 'export class SendReminders {}\n' }),
+    },
+    {
+        ruleId: 'test/spec-required',
+        name: 'a job without a spec',
+        expect: { file: JOB },
+        files: declaredProject({ [JOB]: DECLARED.job }),
+    },
+    {
+        ruleId: 'tree/closed',
+        name: 'declared style: the generated barrel at the root of a context, next to a module file kept on purpose',
+        expect: 'pass',
+        files: declaredProject({ [MODULE]: 'export const billingModule = {};\n' }),
+    },
+    {
+        ruleId: 'tree/closed',
+        name: 'explicit style: a barrel of declarations at the root of a context',
+        expect: { file: BARREL },
+        files: project({ [BARREL]: 'export {};\n' }),
+    },
+    {
+        ruleId: 'naming/one-concept-per-file',
+        name: 'declared style: two declared classes in one role file',
+        expect: { file: POLICY },
+        also: ['clean/one-export-per-file'],
+        files: declaredProject({
+            [POLICY]: `${DECLARED.policy}\n@Policy(billingPermissions['invoice.issue'], { name: 'billing.only-accountant-issues' })\nexport class OnlyAccountantIssuesPolicy {}\n`,
+        }),
+    },
+    {
+        ruleId: 'naming/one-concept-per-file',
+        name: 'explicit style: a second declared class in a policy file is not counted',
+        expect: 'pass',
+        files: project({
+            [POLICY]: `${DECLARED.policy}\n@Policy(billingPermissions['invoice.issue'], { name: 'billing.only-accountant-issues' })\nclass OnlyAccountantIssuesPolicy {}\n`,
+        }),
+    },
+];
+//# sourceMappingURL=tree-fixtures.js.map

package/dist/check/fixtures/tree-fixtures.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"tree-fixtures.js","sourceRoot":"","sources":["../../../src/check/fixtures/tree-fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAC9C,OAAO,EAAE,QAAQ,EAAE,MAAM,eAAe,CAAC;AACzC,OAAO,EAAE,eAAe,EAAE,MAAM,uBAAuB,CAAC;AAExD,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,EAAE,SAAS,EAAE,MAAM,EAAE,OAAO,EAAE,GAAG,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,EAAE,MAAM,EAAE,GAAG,KAAK,CAAC;AACpF,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;AAEzB,MAAM,CAAC,MAAM,aAAa,GAAuB;IAC/C;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,8EAA8E;QACpF,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CACZ;YACE,GAAG,OAAO,CAAC,uCAAuC,CAAC;YACnD,CAAC,GAAG,OAAO,qCAAqC,CAAC,EAAE,4BAA4B;YAC/E,CAAC,GAAG,OAAO,yCAAyC,CAAC,EAAE,IAAI;YAC3D,CAAC,GAAG,OAAO,oBAAoB,CAAC,EAAE,oCAAoC;SACvE,EACD;YACE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;gBACpB,QAAQ,EAAE;oBACR,OAAO,EAAE;wBACP,cAAc,EAAE,MAAM;wBACtB,SAAS,EAAE,CAAC,SAAS,CAAC;wBACtB,gBAAgB,EAAE,CAAC,EAAE,IAAI,EAAE,0BAA0B,EAAE,MAAM,EAAE,cAAc,EAAE,CAAC;qBACjF;oBACD,OAAO,EAAE,EAAE,cAAc,EAAE,YAAY,EAAE,SAAS,EAAE,EAAE,EAAE;iBACzD;aACF,CAAC;SACH,CACF;KACF;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,eAAe,EAAE;QAC3C,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,2BAA2B,CAAC,EAAE,8BAA8B,EAAE,CAAC;KAC5F;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,wCAAwC;QAC9C,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,qBAAqB,EAAE;QACjD,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,qBAAqB,CAAC,EAAE,8BAA8B,EAAE,CAAC;KACtF;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC;KACnB;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,eAAe;QACrB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,aAAa,EAAE;QACzC,KAAK,EAAE,CAAC,GAAG,EAAE;YACX,MAAM,EAAE,CAAC,GAAG,OAAO,aAAa,CAAC,EAAE,QAAQ,EAAE,GAAG,IAAI,EAAE,GAAG,OAAO,CAAC;gBAC/D,CAAC,GAAG,OAAO,8BAA8B,CAAC,EAAE,cAAc;aAC3D,CAAC,CAAC;YAEH,OAAO,IAAI,CAAC;QACd,CAAC,CAAC,EAAE;KACL;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,mBAAmB;QACzB,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,aAAa,EAAE;QACzC,KAAK,EAAE,OAAO,CACZ,EAAE,EACF;YACE,CAAC,GAAG,OAAO,aAAa,CAAC,EAAE,UAAU,CACnC,MAAM,EACN,oBAAoB,CAAC,MAAM,CAAC,CAAC,OAAO,EAAE,EAAE,CAAC,OAAO,KAAK,kBAAkB,CAAC,CACzE;SACF,CACF;KACF;IACD;QACE,MAAM,EAAE,kBAAkB;QAC1B,IAAI,EAAE,8CAA8C;QACpD,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,aAAa,EAAE;QACzC,KAAK,EAAE,OAAO,CAAC,EAAE,EAAE,EAAE,CAAC,GAAG,OAAO,aAAa,CAAC,EAAE,UAAU,CAAC,SAAS,CAAC,EAAE,CAAC;KACzE;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,6BAA6B;QACnC,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,GAAG,SAAS,CAAC,2BAA2B,CAAC;YACzC,CAAC,GAAG,OAAO,gDAAgD,CAAC,EAC1D,2DAA2D;YAC7D,CAAC,GAAG,OAAO,yBAAyB,CAAC,EACnC,qFAAqF;YACvF,CAAC,GAAG,OAAO,mCAAmC,CAAC,EAAE,uDAAuD;SACzG,CAAC;KACH;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,uCAAuC;QAC7C,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,0CAA0C,EAAE;QACtE,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,0CAA0C,CAAC,EAAE,sDAAsD;SAC/G,CAAC;KACH;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,8CAA8C,EAAE;QAC1E,IAAI,EAAE,CAAC,2BAA2B,CAAC;QACnC,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,8CAA8C,CAAC,EACxD,2DAA2D;SAC9D,CAAC;KACH;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,IAAI,EAAE,oDAAoD;QAC1D,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CACZ,SAAS,CACP,yLAAyL,CAC1L,EACD,EAAE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC,EAAE,KAAK,EAAE,EAAE,6BAA6B,EAAE,KAAK,EAAE,EAAE,CAAC,EAAE,CAC/E;KACF;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,IAAI,EAAE,2CAA2C;QACjD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,IAAI,EAAE,CAAC,2BAA2B,CAAC;QACnC,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,0DAA0D,CAAC,CAAC;KACtF;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,8BAA8B;QACpC,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,2BAA2B,EAAE;QACvD,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,2BAA2B,CAAC,EAAE,+BAA+B,EAAE,CAAC;KAC7F;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,8FAA8F;QACpG,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,eAAe,CAAC;YACrB,CAAC,MAAM,CAAC,EAAE,qDAAqD;YAC/D,CAAC,GAAG,OAAO,6DAA6D,CAAC,EACvE,2EAA2E;YAC7E,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG;YACnB,CAAC,QAAQ,CAAC,EAAE,IAAI;SACjB,CAAC;KACH;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,uDAAuD;QAC7D,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,qDAAqD,EAAE,CAAC;KACpF;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,2CAA2C;QACjD,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,uCAAuC,EAAE;QACnE,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,uCAAuC,CAAC,EAAE,sDAAsD;SAC5G,CAAC;KACH;IACD;QACE,MAAM,EAAE,eAAe;QACvB,IAAI,EAAE,0BAA0B;QAChC,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,2CAA2C,EAAE;QACvE,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,GAAG,OAAO,2CAA2C,CAAC,EAAE,iCAAiC,EAAE,CAAC;KAC/G;IACD;QACE,MAAM,EAAE,oBAAoB;QAC5B,IAAI,EAAE,sBAAsB;QAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,EAAE;QACrB,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC,GAAG,CAAC,EAAE,QAAQ,CAAC,GAAG,EAAE,CAAC;KAChD;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,sGAAsG;QAC5G,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,oCAAoC,EAAE,CAAC;KAC3E;IACD;QACE,MAAM,EAAE,aAAa;QACrB,IAAI,EAAE,mEAAmE;QACzE,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACxB,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,cAAc,EAAE,CAAC;KAC7C;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,IAAI,EAAE,uDAAuD;QAC7D,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACxB,IAAI,EAAE,CAAC,2BAA2B,CAAC;QACnC,KAAK,EAAE,eAAe,CAAC;YACrB,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,0IAA0I;SACvK,CAAC;KACH;IACD;QACE,MAAM,EAAE,6BAA6B;QACrC,IAAI,EAAE,yEAAyE;QAC/E,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,MAAM,CAAC,EAAE,GAAG,QAAQ,CAAC,MAAM,mIAAmI;SAChK,CAAC;KACH;CACF,CAAC"}

package/dist/check/fixtures/without-file.d.ts

@@ -0,0 +1,3 @@
+import type { FixtureFiles } from './fixture-files.js';
+export declare function withoutFile(files: FixtureFiles, removed: string): FixtureFiles;
+//# sourceMappingURL=without-file.d.ts.map

package/dist/check/fixtures/without-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"without-file.d.ts","sourceRoot":"","sources":["../../../src/check/fixtures/without-file.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAEvD,wBAAgB,WAAW,CAAC,KAAK,EAAE,YAAY,EAAE,OAAO,EAAE,MAAM,GAAG,YAAY,CAE9E"}

package/dist/check/fixtures/without-file.js

@@ -0,0 +1,4 @@
+export function withoutFile(files, removed) {
+    return Object.fromEntries(Object.entries(files).filter(([file]) => file !== removed));
+}
+//# sourceMappingURL=without-file.js.map

package/dist/check/fixtures/without-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"without-file.js","sourceRoot":"","sources":["../../../src/check/fixtures/without-file.ts"],"names":[],"mappings":"AAEA,MAAM,UAAU,WAAW,CAAC,KAAmB,EAAE,OAAe;IAC9D,OAAO,MAAM,CAAC,WAAW,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,CAAC,MAAM,CAAC,CAAC,CAAC,IAAI,CAAC,EAAE,EAAE,CAAC,IAAI,KAAK,OAAO,CAAC,CAAC,CAAC;AACxF,CAAC"}

package/dist/check/governance/adr-directory.d.ts

@@ -0,0 +1,2 @@
+export declare const ADR_DIRECTORY = "docs/adr";
+//# sourceMappingURL=adr-directory.d.ts.map

package/dist/check/governance/adr-directory.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"adr-directory.d.ts","sourceRoot":"","sources":["../../../src/check/governance/adr-directory.ts"],"names":[],"mappings":"AAAA,eAAO,MAAM,aAAa,aAAa,CAAC"}

package/dist/check/governance/adr-directory.js

@@ -0,0 +1,2 @@
+export const ADR_DIRECTORY = 'docs/adr';
+//# sourceMappingURL=adr-directory.js.map

package/dist/check/governance/adr-directory.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"adr-directory.js","sourceRoot":"","sources":["../../../src/check/governance/adr-directory.ts"],"names":[],"mappings":"AAAA,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAC"}

package/dist/check/governance/decision-records.d.ts

@@ -0,0 +1,9 @@
+/** The decision records of a project, `docs/adr/<number>-<slug>.md`, listed once and only when asked. */
+export declare class DecisionRecords {
+    private readonly root;
+    private numbers;
+    constructor(root: string);
+    has(number: number): boolean;
+    private list;
+}
+//# sourceMappingURL=decision-records.d.ts.map

package/dist/check/governance/decision-records.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"decision-records.d.ts","sourceRoot":"","sources":["../../../src/check/governance/decision-records.ts"],"names":[],"mappings":"AAOA,yGAAyG;AACzG,qBAAa,eAAe;IAGd,OAAO,CAAC,QAAQ,CAAC,IAAI;IAFjC,OAAO,CAAC,OAAO,CAAkC;IAEjD,YAA6B,IAAI,EAAE,MAAM,EAAI;IAE7C,GAAG,CAAC,MAAM,EAAE,MAAM,GAAG,OAAO,CAI3B;IAED,OAAO,CAAC,IAAI;CASb"}

package/dist/check/governance/decision-records.js

@@ -0,0 +1,27 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { ADR_DIRECTORY } from './adr-directory.js';
+import { recordNumber } from './record-number.js';
+const RECORD_FILE = /^(\d+)-.+\.md$/;
+/** The decision records of a project, `docs/adr/<number>-<slug>.md`, listed once and only when asked. */
+export class DecisionRecords {
+    root;
+    numbers;
+    constructor(root) {
+        this.root = root;
+    }
+    has(number) {
+        this.numbers ??= this.list();
+        return this.numbers.has(number);
+    }
+    list() {
+        try {
+            const entries = fs.readdirSync(path.join(this.root, ADR_DIRECTORY));
+            return new Set(entries.flatMap((entry) => recordNumber(RECORD_FILE.exec(entry)?.[1] ?? '') ?? []));
+        }
+        catch {
+            return new Set();
+        }
+    }
+}
+//# sourceMappingURL=decision-records.js.map

package/dist/check/governance/decision-records.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"decision-records.js","sourceRoot":"","sources":["../../../src/check/governance/decision-records.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAE,MAAM,oBAAoB,CAAC;AACnD,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAElD,MAAM,WAAW,GAAG,gBAAgB,CAAC;AAErC,yGAAyG;AACzG,MAAM,OAAO,eAAe;IAGG,IAAI;IAFzB,OAAO,CAAkC;IAEjD,YAA6B,IAAY;oBAAZ,IAAI;IAAW,CAAC;IAE7C,GAAG,CAAC,MAAc;QAChB,IAAI,CAAC,OAAO,KAAK,IAAI,CAAC,IAAI,EAAE,CAAC;QAE7B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC;IAClC,CAAC;IAEO,IAAI;QACV,IAAI,CAAC;YACH,MAAM,OAAO,GAAG,EAAE,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,aAAa,CAAC,CAAC,CAAC;YAEpE,OAAO,IAAI,GAAG,CAAC,OAAO,CAAC,OAAO,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,IAAI,EAAE,CAAC,CAAC,CAAC;QACrG,CAAC;QAAC,MAAM,CAAC;YACP,OAAO,IAAI,GAAG,EAAE,CAAC;QACnB,CAAC;IACH,CAAC;CACF"}

package/dist/check/governance/record-number.d.ts

@@ -0,0 +1,3 @@
+/** The number held by the `adr` field of a deviation: its first run of digits (`7`, `0007`, `ADR-0007`, `docs/adr/0007-slug.md`). */
+export declare function recordNumber(field: string): number | undefined;
+//# sourceMappingURL=record-number.d.ts.map

package/dist/check/governance/record-number.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-number.d.ts","sourceRoot":"","sources":["../../../src/check/governance/record-number.ts"],"names":[],"mappings":"AAAA,qIAAqI;AACrI,wBAAgB,YAAY,CAAC,KAAK,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAI9D"}

package/dist/check/governance/record-number.js

@@ -0,0 +1,6 @@
+/** The number held by the `adr` field of a deviation: its first run of digits (`7`, `0007`, `ADR-0007`, `docs/adr/0007-slug.md`). */
+export function recordNumber(field) {
+    const digits = /\d+/.exec(field)?.[0];
+    return digits === undefined ? undefined : Number.parseInt(digits, 10);
+}
+//# sourceMappingURL=record-number.js.map

package/dist/check/governance/record-number.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"record-number.js","sourceRoot":"","sources":["../../../src/check/governance/record-number.ts"],"names":[],"mappings":"AAAA,qIAAqI;AACrI,MAAM,UAAU,YAAY,CAAC,KAAa;IACxC,MAAM,MAAM,GAAG,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEtC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACxE,CAAC"}

package/dist/check/governance/referenced-record.d.ts

@@ -0,0 +1,3 @@
+/** The number of the first decision record a free text refers to: `ADR-0007`, `ADR-7`, `ADR 7`, `adr7`, `docs/adr/0007-slug.md`. */
+export declare function referencedRecord(text: string): number | undefined;
+//# sourceMappingURL=referenced-record.d.ts.map

package/dist/check/governance/referenced-record.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenced-record.d.ts","sourceRoot":"","sources":["../../../src/check/governance/referenced-record.ts"],"names":[],"mappings":"AAEA,oIAAoI;AACpI,wBAAgB,gBAAgB,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,GAAG,SAAS,CAIjE"}

package/dist/check/governance/referenced-record.js

@@ -0,0 +1,7 @@
+const REFERENCE = /\badr[-/ ]?(\d+)/i;
+/** The number of the first decision record a free text refers to: `ADR-0007`, `ADR-7`, `ADR 7`, `adr7`, `docs/adr/0007-slug.md`. */
+export function referencedRecord(text) {
+    const digits = REFERENCE.exec(text)?.[1];
+    return digits === undefined ? undefined : Number.parseInt(digits, 10);
+}
+//# sourceMappingURL=referenced-record.js.map

package/dist/check/governance/referenced-record.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"referenced-record.js","sourceRoot":"","sources":["../../../src/check/governance/referenced-record.ts"],"names":[],"mappings":"AAAA,MAAM,SAAS,GAAG,mBAAmB,CAAC;AAEtC,oIAAoI;AACpI,MAAM,UAAU,gBAAgB,CAAC,IAAY;IAC3C,MAAM,MAAM,GAAG,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC;IAEzC,OAAO,MAAM,KAAK,SAAS,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,CAAC,MAAM,CAAC,QAAQ,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;AACxE,CAAC"}

package/dist/check/language/add-glossary-rows.d.ts

@@ -0,0 +1,6 @@
+/** Appends rows to the glossary table. Returns undefined when the document has no table to extend. */
+export declare function addGlossaryRows(contextDoc: string, rows: readonly {
+    term: string;
+    meaning: string;
+}[]): string | undefined;
+//# sourceMappingURL=add-glossary-rows.d.ts.map

package/dist/check/language/add-glossary-rows.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-glossary-rows.d.ts","sourceRoot":"","sources":["../../../src/check/language/add-glossary-rows.ts"],"names":[],"mappings":"AAGA,sGAAsG;AACtG,wBAAgB,eAAe,CAC7B,UAAU,EAAE,MAAM,EAClB,IAAI,EAAE,SAAS;IAAE,IAAI,EAAE,MAAM,CAAC;IAAC,OAAO,EAAE,MAAM,CAAA;CAAE,EAAE,GACjD,MAAM,GAAG,SAAS,CAmBpB"}

package/dist/check/language/add-glossary-rows.js

@@ -0,0 +1,19 @@
+import { glossaryCells } from './glossary-cells.js';
+import { parseGlossary } from './parse-glossary.js';
+/** Appends rows to the glossary table. Returns undefined when the document has no table to extend. */
+export function addGlossaryRows(contextDoc, rows) {
+    const glossary = parseGlossary(contextDoc);
+    if (glossary.lastRowLine === undefined) {
+        return undefined;
+    }
+    const lines = contextDoc.split('\n');
+    const columns = glossaryCells(lines[glossary.lastRowLine - 1] ?? '').length;
+    const known = glossary.terms.map((term) => term.toLowerCase());
+    const padding = Array.from({ length: Math.max(0, columns - 2) }, () => '');
+    const additions = rows
+        .filter((row) => !known.includes(row.term.toLowerCase()))
+        .map((row) => `| ${[row.term, row.meaning, ...padding].join(' | ')} |`);
+    lines.splice(glossary.lastRowLine, 0, ...additions);
+    return lines.join('\n');
+}
+//# sourceMappingURL=add-glossary-rows.js.map

package/dist/check/language/add-glossary-rows.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"add-glossary-rows.js","sourceRoot":"","sources":["../../../src/check/language/add-glossary-rows.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AACpD,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,sGAAsG;AACtG,MAAM,UAAU,eAAe,CAC7B,UAAkB,EAClB,IAAkD;IAElD,MAAM,QAAQ,GAAG,aAAa,CAAC,UAAU,CAAC,CAAC;IAE3C,IAAI,QAAQ,CAAC,WAAW,KAAK,SAAS,EAAE,CAAC;QACvC,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,aAAa,CAAC,KAAK,CAAC,QAAQ,CAAC,WAAW,GAAG,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,MAAM,CAAC;IAC5E,MAAM,KAAK,GAAG,QAAQ,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;IAC/D,MAAM,OAAO,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,IAAI,CAAC,GAAG,CAAC,CAAC,EAAE,OAAO,GAAG,CAAC,CAAC,EAAE,EAAE,GAAG,EAAE,CAAC,EAAE,CAAC,CAAC;IAE3E,MAAM,SAAS,GAAG,IAAI;SACnB,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,WAAW,EAAE,CAAC,CAAC;SACxD,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,EAAE,GAAG,CAAC,OAAO,EAAE,GAAG,OAAO,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IAE1E,KAAK,CAAC,MAAM,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC,EAAE,GAAG,SAAS,CAAC,CAAC;IAEpD,OAAO,KAAK,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC1B,CAAC"}

package/dist/check/language/base-forms.d.ts

@@ -0,0 +1,3 @@
+/** Crude English inflection: every base form a word may come from, the word itself included. */
+export declare function baseForms(word: string): Set<string>;
+//# sourceMappingURL=base-forms.d.ts.map

package/dist/check/language/base-forms.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-forms.d.ts","sourceRoot":"","sources":["../../../src/check/language/base-forms.ts"],"names":[],"mappings":"AAgCA,gGAAgG;AAChG,wBAAgB,SAAS,CAAC,IAAI,EAAE,MAAM,GAAG,GAAG,CAAC,MAAM,CAAC,CAKnD"}

package/dist/check/language/base-forms.js

@@ -0,0 +1,71 @@
+const IRREGULAR = {
+    paid: 'pay',
+    sent: 'send',
+    sold: 'sell',
+    bought: 'buy',
+    made: 'make',
+    lost: 'lose',
+    written: 'write',
+    given: 'give',
+    taken: 'take',
+    withdrawn: 'withdraw',
+    held: 'hold',
+    kept: 'keep',
+    left: 'leave',
+    found: 'find',
+    built: 'build',
+    spent: 'spend',
+    chosen: 'choose',
+    begun: 'begin',
+    done: 'do',
+    gone: 'go',
+    known: 'know',
+    shown: 'show',
+    frozen: 'freeze',
+    broken: 'break',
+    met: 'meet',
+    told: 'tell',
+    brought: 'bring',
+    children: 'child',
+    people: 'person',
+};
+/** Crude English inflection: every base form a word may come from, the word itself included. */
+export function baseForms(word) {
+    const lower = word.toLowerCase();
+    const irregular = IRREGULAR[lower];
+    return new Set([lower, ...(irregular === undefined ? [] : [irregular]), ...singulars(lower), ...infinitives(lower)]);
+}
+function singulars(lower) {
+    const forms = [];
+    if (lower.endsWith('ies')) {
+        forms.push(`${lower.slice(0, -3)}y`);
+    }
+    if (lower.endsWith('es')) {
+        forms.push(lower.slice(0, -2));
+    }
+    if (lower.endsWith('s') && !lower.endsWith('ss')) {
+        forms.push(lower.slice(0, -1));
+    }
+    return forms;
+}
+function infinitives(lower) {
+    const forms = [];
+    if (lower.endsWith('ied')) {
+        forms.push(`${lower.slice(0, -3)}y`);
+    }
+    for (const suffix of ['ed', 'ing']) {
+        if (!lower.endsWith(suffix) || lower.length <= suffix.length + 2) {
+            continue;
+        }
+        const stem = lower.slice(0, -suffix.length);
+        forms.push(stem, `${stem}e`, undouble(stem));
+    }
+    if (lower.endsWith('d')) {
+        forms.push(lower.slice(0, -1));
+    }
+    return forms;
+}
+function undouble(stem) {
+    return /([b-df-hj-np-tv-z])\1$/.test(stem) ? stem.slice(0, -1) : stem;
+}
+//# sourceMappingURL=base-forms.js.map

package/dist/check/language/base-forms.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"base-forms.js","sourceRoot":"","sources":["../../../src/check/language/base-forms.ts"],"names":[],"mappings":"AAAA,MAAM,SAAS,GAAqC;IAClD,IAAI,EAAE,KAAK;IACX,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,MAAM,EAAE,KAAK;IACb,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,OAAO;IAChB,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,MAAM;IACb,SAAS,EAAE,UAAU;IACrB,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,MAAM;IACZ,IAAI,EAAE,OAAO;IACb,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,OAAO;IACd,KAAK,EAAE,OAAO;IACd,MAAM,EAAE,QAAQ;IAChB,KAAK,EAAE,OAAO;IACd,IAAI,EAAE,IAAI;IACV,IAAI,EAAE,IAAI;IACV,KAAK,EAAE,MAAM;IACb,KAAK,EAAE,MAAM;IACb,MAAM,EAAE,QAAQ;IAChB,MAAM,EAAE,OAAO;IACf,GAAG,EAAE,MAAM;IACX,IAAI,EAAE,MAAM;IACZ,OAAO,EAAE,OAAO;IAChB,QAAQ,EAAE,OAAO;IACjB,MAAM,EAAE,QAAQ;CACjB,CAAC;AAEF,gGAAgG;AAChG,MAAM,UAAU,SAAS,CAAC,IAAY;IACpC,MAAM,KAAK,GAAG,IAAI,CAAC,WAAW,EAAE,CAAC;IACjC,MAAM,SAAS,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC;IAEnC,OAAO,IAAI,GAAG,CAAC,CAAC,KAAK,EAAE,GAAG,CAAC,SAAS,KAAK,SAAS,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC,CAAC,EAAE,GAAG,SAAS,CAAC,KAAK,CAAC,EAAE,GAAG,WAAW,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;AACvH,CAAC;AAED,SAAS,SAAS,CAAC,KAAa;IAC9B,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACzB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;QACjD,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,WAAW,CAAC,KAAa;IAChC,MAAM,KAAK,GAAa,EAAE,CAAC;IAE3B,IAAI,KAAK,CAAC,QAAQ,CAAC,KAAK,CAAC,EAAE,CAAC;QAC1B,KAAK,CAAC,IAAI,CAAC,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC;IACvC,CAAC;IAED,KAAK,MAAM,MAAM,IAAI,CAAC,IAAI,EAAE,KAAK,CAAC,EAAE,CAAC;QACnC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,KAAK,CAAC,MAAM,IAAI,MAAM,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;YACjE,SAAS;QACX,CAAC;QAED,MAAM,IAAI,GAAG,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,MAAM,CAAC,MAAM,CAAC,CAAC;QAE5C,KAAK,CAAC,IAAI,CAAC,IAAI,EAAE,GAAG,IAAI,GAAG,EAAE,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC;IAC/C,CAAC;IAED,IAAI,KAAK,CAAC,QAAQ,CAAC,GAAG,CAAC,EAAE,CAAC;QACxB,KAAK,CAAC,IAAI,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IACjC,CAAC;IAED,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,QAAQ,CAAC,IAAY;IAC5B,OAAO,wBAAwB,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;AACxE,CAAC"}

package/dist/check/language/glossaries.d.ts

@@ -0,0 +1,15 @@
+import { type Glossary } from './parse-glossary.js';
+/** The glossary of each context, read once, and the contexts already reported as having none. */
+export declare class Glossaries {
+    private readonly root;
+    private readonly contextsDir;
+    private readonly read;
+    private readonly reportedEmpty;
+    constructor(root: string, contextsDir: string);
+    docOf(context: string): string;
+    of(context: string): Glossary;
+    /** True the first time only: an empty glossary is one finding, not one per class. */
+    reportsEmptyOnce(context: string): boolean;
+    private text;
+}
+//# sourceMappingURL=glossaries.d.ts.map

package/dist/check/language/glossaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossaries.d.ts","sourceRoot":"","sources":["../../../src/check/language/glossaries.ts"],"names":[],"mappings":"AAEA,OAAO,EAAiB,KAAK,QAAQ,EAAE,MAAM,qBAAqB,CAAC;AAEnE,iGAAiG;AACjG,qBAAa,UAAU;IAKnB,OAAO,CAAC,QAAQ,CAAC,IAAI;IACrB,OAAO,CAAC,QAAQ,CAAC,WAAW;IAL9B,OAAO,CAAC,QAAQ,CAAC,IAAI,CAA+B;IACpD,OAAO,CAAC,QAAQ,CAAC,aAAa,CAAqB;IAEnD,YACmB,IAAI,EAAE,MAAM,EACZ,WAAW,EAAE,MAAM,EAClC;IAEJ,KAAK,CAAC,OAAO,EAAE,MAAM,GAAG,MAAM,CAE7B;IAED,EAAE,CAAC,OAAO,EAAE,MAAM,GAAG,QAAQ,CAY5B;IAED,qFAAqF;IACrF,gBAAgB,CAAC,OAAO,EAAE,MAAM,GAAG,OAAO,CAQzC;IAED,OAAO,CAAC,IAAI;CAQb"}

package/dist/check/language/glossaries.js

@@ -0,0 +1,44 @@
+import fs from 'node:fs';
+import path from 'node:path';
+import { parseGlossary } from './parse-glossary.js';
+/** The glossary of each context, read once, and the contexts already reported as having none. */
+export class Glossaries {
+    root;
+    contextsDir;
+    read = new Map();
+    reportedEmpty = new Set();
+    constructor(root, contextsDir) {
+        this.root = root;
+        this.contextsDir = contextsDir;
+    }
+    docOf(context) {
+        return `${this.contextsDir}/${context}/CONTEXT.md`;
+    }
+    of(context) {
+        const known = this.read.get(context);
+        if (known !== undefined) {
+            return known;
+        }
+        const glossary = parseGlossary(this.text(context));
+        this.read.set(context, glossary);
+        return glossary;
+    }
+    /** True the first time only: an empty glossary is one finding, not one per class. */
+    reportsEmptyOnce(context) {
+        if (this.reportedEmpty.has(context)) {
+            return false;
+        }
+        this.reportedEmpty.add(context);
+        return true;
+    }
+    text(context) {
+        try {
+            return fs.readFileSync(path.join(this.root, this.docOf(context)), 'utf8');
+        }
+        catch {
+            // A missing CONTEXT.md is reported by tree/context-doc; here it is an empty glossary.
+            return '';
+        }
+    }
+}
+//# sourceMappingURL=glossaries.js.map

package/dist/check/language/glossaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossaries.js","sourceRoot":"","sources":["../../../src/check/language/glossaries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,MAAM,SAAS,CAAC;AACzB,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,aAAa,EAAiB,MAAM,qBAAqB,CAAC;AAEnE,iGAAiG;AACjG,MAAM,OAAO,UAAU;IAKF,IAAI;IACJ,WAAW;IALb,IAAI,GAAG,IAAI,GAAG,EAAoB,CAAC;IACnC,aAAa,GAAG,IAAI,GAAG,EAAU,CAAC;IAEnD,YACmB,IAAY,EACZ,WAAmB;oBADnB,IAAI;2BACJ,WAAW;IAC3B,CAAC;IAEJ,KAAK,CAAC,OAAe;QACnB,OAAO,GAAG,IAAI,CAAC,WAAW,IAAI,OAAO,aAAa,CAAC;IACrD,CAAC;IAED,EAAE,CAAC,OAAe;QAChB,MAAM,KAAK,GAAG,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAErC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;YACxB,OAAO,KAAK,CAAC;QACf,CAAC;QAED,MAAM,QAAQ,GAAG,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,CAAC,CAAC;QAEnD,IAAI,CAAC,IAAI,CAAC,GAAG,CAAC,OAAO,EAAE,QAAQ,CAAC,CAAC;QAEjC,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,qFAAqF;IACrF,gBAAgB,CAAC,OAAe;QAC9B,IAAI,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC;YACpC,OAAO,KAAK,CAAC;QACf,CAAC;QAED,IAAI,CAAC,aAAa,CAAC,GAAG,CAAC,OAAO,CAAC,CAAC;QAEhC,OAAO,IAAI,CAAC;IACd,CAAC;IAEO,IAAI,CAAC,OAAe;QAC1B,IAAI,CAAC;YACH,OAAO,EAAE,CAAC,YAAY,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,CAAC,OAAO,CAAC,CAAC,EAAE,MAAM,CAAC,CAAC;QAC5E,CAAC;QAAC,MAAM,CAAC;YACP,sFAAsF;YACtF,OAAO,EAAE,CAAC;QACZ,CAAC;IACH,CAAC;CACF"}

package/dist/check/language/glossary-cells.d.ts

@@ -0,0 +1,3 @@
+/** The cells of one row of a Markdown table. */
+export declare function glossaryCells(line: string): string[];
+//# sourceMappingURL=glossary-cells.d.ts.map

package/dist/check/language/glossary-cells.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary-cells.d.ts","sourceRoot":"","sources":["../../../src/check/language/glossary-cells.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,wBAAgB,aAAa,CAAC,IAAI,EAAE,MAAM,GAAG,MAAM,EAAE,CAOpD"}

package/dist/check/language/glossary-cells.js

@@ -0,0 +1,10 @@
+/** The cells of one row of a Markdown table. */
+export function glossaryCells(line) {
+    return line
+        .trim()
+        .replace(/^\|/, '')
+        .replace(/\|$/, '')
+        .split('|')
+        .map((cell) => cell.trim());
+}
+//# sourceMappingURL=glossary-cells.js.map

package/dist/check/language/glossary-cells.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"glossary-cells.js","sourceRoot":"","sources":["../../../src/check/language/glossary-cells.ts"],"names":[],"mappings":"AAAA,gDAAgD;AAChD,MAAM,UAAU,aAAa,CAAC,IAAY;IACxC,OAAO,IAAI;SACR,IAAI,EAAE;SACN,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;SAClB,OAAO,CAAC,KAAK,EAAE,EAAE,CAAC;SAClB,KAAK,CAAC,GAAG,CAAC;SACV,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,CAAC;AAChC,CAAC"}

package/dist/check/language/parse-glossary.d.ts

@@ -0,0 +1,10 @@
+export interface Glossary {
+    readonly terms: readonly string[];
+    /** Line of the section heading, 1-based, or undefined when the section is missing. */
+    readonly line: number | undefined;
+    /** Line after which a new row belongs. */
+    readonly lastRowLine: number | undefined;
+}
+/** Reads the `## Ubiquitous language` table of a CONTEXT.md. */
+export declare function parseGlossary(contextDoc: string): Glossary;
+//# sourceMappingURL=parse-glossary.d.ts.map

package/dist/check/language/parse-glossary.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-glossary.d.ts","sourceRoot":"","sources":["../../../src/check/language/parse-glossary.ts"],"names":[],"mappings":"AAIA,MAAM,WAAW,QAAQ;IACvB,QAAQ,CAAC,KAAK,EAAE,SAAS,MAAM,EAAE,CAAC;IAClC,sFAAsF;IACtF,QAAQ,CAAC,IAAI,EAAE,MAAM,GAAG,SAAS,CAAC;IAClC,0CAA0C;IAC1C,QAAQ,CAAC,WAAW,EAAE,MAAM,GAAG,SAAS,CAAC;CAC1C;AAED,gEAAgE;AAChE,wBAAgB,aAAa,CAAC,UAAU,EAAE,MAAM,GAAG,QAAQ,CAoB1D"}

package/dist/check/language/parse-glossary.js

@@ -0,0 +1,29 @@
+import { glossaryCells } from './glossary-cells.js';
+const GLOSSARY_HEADING = '## Ubiquitous language';
+/** Reads the `## Ubiquitous language` table of a CONTEXT.md. */
+export function parseGlossary(contextDoc) {
+    const lines = contextDoc.split('\n');
+    const heading = lines.findIndex((line) => line.trim().toLowerCase() === GLOSSARY_HEADING.toLowerCase());
+    if (heading === -1) {
+        return { terms: [], line: undefined, lastRowLine: undefined };
+    }
+    const end = lines.findIndex((line, index) => index > heading && line.startsWith('## '));
+    const rows = lines
+        .slice(heading + 1, end === -1 ? lines.length : end)
+        .map((line, offset) => ({
+        line: heading + offset + 2,
+        cells: glossaryCells(line),
+        isRow: line.trim().startsWith('|'),
+    }))
+        .filter((row) => row.isRow);
+    return { terms: termsOf(rows.map((row) => row.cells)), line: heading + 1, lastRowLine: rows.at(-1)?.line };
+}
+/** The first row of a table is its header. */
+function termsOf(rows) {
+    return rows
+        .slice(1)
+        .filter((cells) => !cells.every((cell) => /^:?-{2,}:?$/.test(cell)))
+        .map((cells) => (cells[0] ?? '').replace(/[`*_]/g, '').trim())
+        .filter((term) => term !== '');
+}
+//# sourceMappingURL=parse-glossary.js.map

package/dist/check/language/parse-glossary.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"parse-glossary.js","sourceRoot":"","sources":["../../../src/check/language/parse-glossary.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,aAAa,EAAE,MAAM,qBAAqB,CAAC;AAEpD,MAAM,gBAAgB,GAAG,wBAAwB,CAAC;AAUlD,gEAAgE;AAChE,MAAM,UAAU,aAAa,CAAC,UAAkB;IAC9C,MAAM,KAAK,GAAG,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,CAAC;IACrC,MAAM,OAAO,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC,WAAW,EAAE,KAAK,gBAAgB,CAAC,WAAW,EAAE,CAAC,CAAC;IAExG,IAAI,OAAO,KAAK,CAAC,CAAC,EAAE,CAAC;QACnB,OAAO,EAAE,KAAK,EAAE,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE,WAAW,EAAE,SAAS,EAAE,CAAC;IAChE,CAAC;IAED,MAAM,GAAG,GAAG,KAAK,CAAC,SAAS,CAAC,CAAC,IAAI,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,GAAG,OAAO,IAAI,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,CAAC,CAAC;IAExF,MAAM,IAAI,GAAG,KAAK;SACf,KAAK,CAAC,OAAO,GAAG,CAAC,EAAE,GAAG,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC,MAAM,CAAC,CAAC,CAAC,GAAG,CAAC;SACnD,GAAG,CAAC,CAAC,IAAI,EAAE,MAAM,EAAE,EAAE,CAAC,CAAC;QACtB,IAAI,EAAE,OAAO,GAAG,MAAM,GAAG,CAAC;QAC1B,KAAK,EAAE,aAAa,CAAC,IAAI,CAAC;QAC1B,KAAK,EAAE,IAAI,CAAC,IAAI,EAAE,CAAC,UAAU,CAAC,GAAG,CAAC;KACnC,CAAC,CAAC;SACF,MAAM,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC;IAE9B,OAAO,EAAE,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,GAAG,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,GAAG,CAAC,KAAK,CAAC,CAAC,EAAE,IAAI,EAAE,OAAO,GAAG,CAAC,EAAE,WAAW,EAAE,IAAI,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,EAAE,IAAI,EAAE,CAAC;AAC7G,CAAC;AAED,8CAA8C;AAC9C,SAAS,OAAO,CAAC,IAAoC;IACnD,OAAO,IAAI;SACR,KAAK,CAAC,CAAC,CAAC;SACR,MAAM,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;SACnE,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,QAAQ,EAAE,EAAE,CAAC,CAAC,IAAI,EAAE,CAAC;SAC7D,MAAM,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,KAAK,EAAE,CAAC,CAAC;AACnC,CAAC"}

package/dist/check/language/same-word.d.ts

@@ -0,0 +1,3 @@
+/** True when two words share a base form: `Issued`, `Issuing` and `Issues` say `Issue`. */
+export declare function sameWord(left: string, right: string): boolean;
+//# sourceMappingURL=same-word.d.ts.map

package/dist/check/language/same-word.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"same-word.d.ts","sourceRoot":"","sources":["../../../src/check/language/same-word.ts"],"names":[],"mappings":"AAEA,2FAA2F;AAC3F,wBAAgB,QAAQ,CAAC,IAAI,EAAE,MAAM,EAAE,KAAK,EAAE,MAAM,GAAG,OAAO,CAI7D"}

package/dist/check/language/same-word.js

@@ -0,0 +1,7 @@
+import { baseForms } from './base-forms.js';
+/** True when two words share a base form: `Issued`, `Issuing` and `Issues` say `Issue`. */
+export function sameWord(left, right) {
+    const forms = baseForms(left);
+    return [...baseForms(right)].some((form) => forms.has(form));
+}
+//# sourceMappingURL=same-word.js.map

package/dist/check/language/same-word.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"same-word.js","sourceRoot":"","sources":["../../../src/check/language/same-word.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,SAAS,EAAE,MAAM,iBAAiB,CAAC;AAE5C,2FAA2F;AAC3F,MAAM,UAAU,QAAQ,CAAC,IAAY,EAAE,KAAa;IAClD,MAAM,KAAK,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAE9B,OAAO,CAAC,GAAG,SAAS,CAAC,KAAK,CAAC,CAAC,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,CAAC,GAAG,CAAC,IAAI,CAAC,CAAC,CAAC;AAC/D,CAAC"}