ddd-ts-kit 0.0.0-stage → 0.1.0

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

@@ -0,0 +1,73 @@
+import { CONTEXT_DOC_HEADINGS } from '../canonical/context-doc-headings.js';
+import { aggregate } from './aggregate.js';
+import { contextDoc } from './context-doc.js';
+import { PATHS } from './paths.js';
+import { project } from './project.js';
+import { SAMPLES } from './samples.js';
+const { AGGREGATE, BILLING, EVENT } = PATHS;
+const { SPEC } = SAMPLES;
+export const LANGUAGE_FIXTURES = [
+    {
+        ruleId: 'language/glossary-term',
+        name: 'names made of glossary terms, inflected, with structural and link words',
+        expect: 'pass',
+        files: project({
+            ...aggregate('export class Invoice {}\n'),
+            [EVENT]: "export class InvoiceIssued {\n  readonly name = 'billing.invoice.issued';\n}\n",
+            [`${BILLING}/application/commands/issue-invoice/issue-invoice.command.ts`]: 'export class IssueInvoiceCommand {}\n',
+            [`${BILLING}/application/queries/invoices-issued-for-money/invoices-issued-for-money.query.ts`]: 'export class InvoicesIssuedForMoneyQuery {}\n',
+        }),
+    },
+    {
+        ruleId: 'language/glossary-term',
+        name: 'a class named with a word the glossary does not define',
+        expect: { file: `${BILLING}/domain/aggregates/invoice-ledger.aggregate.ts` },
+        files: project({
+            [`${BILLING}/domain/aggregates/invoice-ledger.aggregate.ts`]: 'export class InvoiceLedger {}\n',
+            [`${BILLING}/test/unit/invoice-ledger.aggregate.spec.ts`]: SPEC,
+            [`${BILLING}/test/builders/invoice-ledger.builder.ts`]: 'export const anInvoiceLedger = 1;\n',
+        }),
+    },
+    {
+        ruleId: 'language/glossary-term',
+        name: 'a use case whose verb is not in the glossary',
+        expect: { file: `${BILLING}/application/commands/dispatch-invoice/dispatch-invoice.command.ts` },
+        files: project({
+            [`${BILLING}/application/commands/dispatch-invoice/dispatch-invoice.command.ts`]: 'export class DispatchInvoiceCommand {}\n',
+        }),
+    },
+    {
+        ruleId: 'language/glossary-term',
+        name: 'domain classes in a context whose glossary is empty',
+        expect: { file: `${BILLING}/CONTEXT.md` },
+        files: project(aggregate('export class Invoice {}\n'), {
+            [`${BILLING}/CONTEXT.md`]: contextDoc('core', CONTEXT_DOC_HEADINGS, '| Term | Meaning |\n|---|---|'),
+        }),
+    },
+    {
+        ruleId: 'language/no-technical-name',
+        name: 'names of the business',
+        expect: 'pass',
+        files: project({
+            ...aggregate('export interface InvoiceState {\n  readonly issued: boolean;\n}\n\nexport class Invoice {\n  constructor(readonly state: InvoiceState) {}\n}\n'),
+            [`${BILLING}/infrastructure/persistence/invoice-data.mapper.ts`]: 'export class InvoiceDataMapper {}\n',
+        }),
+    },
+    {
+        ruleId: 'language/no-technical-name',
+        name: 'a manager in the domain',
+        expect: { file: `${BILLING}/domain/services/invoice-manager.service.ts` },
+        also: ['language/glossary-term'],
+        files: project({
+            [`${BILLING}/domain/services/invoice-manager.service.ts`]: 'export class InvoiceManager {}\n',
+            [`${BILLING}/test/unit/invoice-manager.service.spec.ts`]: SPEC,
+        }),
+    },
+    {
+        ruleId: 'language/no-technical-name',
+        name: 'a technical word in a use case and in a domain type',
+        expect: { file: AGGREGATE },
+        files: project(aggregate('export type InvoiceData = { readonly total: number };\nexport class Invoice {}\n')),
+    },
+];
+//# sourceMappingURL=language-fixtures.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"language-fixtures.js","sourceRoot":"","sources":["../../../src/check/fixtures/language-fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,oBAAoB,EAAE,MAAM,sCAAsC,CAAC;AAC5E,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,UAAU,EAAE,MAAM,kBAAkB,CAAC;AAE9C,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,OAAO,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;AAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,OAAO,CAAC;AAEzB,MAAM,CAAC,MAAM,iBAAiB,GAAuB;IACnD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,yEAAyE;QAC/E,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,GAAG,SAAS,CAAC,2BAA2B,CAAC;YACzC,CAAC,KAAK,CAAC,EAAE,gFAAgF;YACzF,CAAC,GAAG,OAAO,8DAA8D,CAAC,EACxE,uCAAuC;YACzC,CAAC,GAAG,OAAO,mFAAmF,CAAC,EAC7F,+CAA+C;SAClD,CAAC;KACH;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,wDAAwD;QAC9D,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,gDAAgD,EAAE;QAC5E,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,gDAAgD,CAAC,EAAE,iCAAiC;YAC/F,CAAC,GAAG,OAAO,6CAA6C,CAAC,EAAE,IAAI;YAC/D,CAAC,GAAG,OAAO,0CAA0C,CAAC,EAAE,qCAAqC;SAC9F,CAAC;KACH;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,8CAA8C;QACpD,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,oEAAoE,EAAE;QAChG,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,oEAAoE,CAAC,EAC9E,0CAA0C;SAC7C,CAAC;KACH;IACD;QACE,MAAM,EAAE,wBAAwB;QAChC,IAAI,EAAE,qDAAqD;QAC3D,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,aAAa,EAAE;QACzC,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,2BAA2B,CAAC,EAAE;YACrD,CAAC,GAAG,OAAO,aAAa,CAAC,EAAE,UAAU,CAAC,MAAM,EAAE,oBAAoB,EAAE,+BAA+B,CAAC;SACrG,CAAC;KACH;IACD;QACE,MAAM,EAAE,4BAA4B;QACpC,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,GAAG,SAAS,CACV,gJAAgJ,CACjJ;YACD,CAAC,GAAG,OAAO,oDAAoD,CAAC,EAAE,qCAAqC;SACxG,CAAC;KACH;IACD;QACE,MAAM,EAAE,4BAA4B;QACpC,IAAI,EAAE,yBAAyB;QAC/B,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,6CAA6C,EAAE;QACzE,IAAI,EAAE,CAAC,wBAAwB,CAAC;QAChC,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,GAAG,OAAO,6CAA6C,CAAC,EAAE,kCAAkC;YAC7F,CAAC,GAAG,OAAO,4CAA4C,CAAC,EAAE,IAAI;SAC/D,CAAC;KACH;IACD;QACE,MAAM,EAAE,4BAA4B;QACpC,IAAI,EAAE,qDAAqD;QAC3D,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,kFAAkF,CAAC,CAAC;KAC9G;CACF,CAAC"}

package/dist/check/fixtures/layer-fixtures.d.ts

@@ -0,0 +1,3 @@
+import type { Fixture } from './fixture.js';
+export declare const LAYER_FIXTURES: readonly Fixture[];
+//# sourceMappingURL=layer-fixtures.d.ts.map

package/dist/check/fixtures/layer-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layer-fixtures.d.ts","sourceRoot":"","sources":["../../../src/check/fixtures/layer-fixtures.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAQ5C,eAAO,MAAM,cAAc,EAAE,SAAS,OAAO,EAuP5C,CAAC"}

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

@@ -0,0 +1,199 @@
+import { CONFIG_FILE } from '../../config/index.js';
+import { aggregate } from './aggregate.js';
+import { config } from './config.js';
+import { DECLARED } from './declared.js';
+import { declaredProject } from './declared-project.js';
+import { handler } from './handler.js';
+import { outsidePackageDeviation } from './outside-package-deviation.js';
+import { PATHS } from './paths.js';
+import { project } from './project.js';
+const { ADAPTER, AGGREGATE, COMMAND, HANDLER, REPOSITORY_PORT, ROUTE } = PATHS;
+export const LAYER_FIXTURES = [
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'kernel, own domain and shared kernel are allowed; comments and strings are not imports',
+        expect: 'pass',
+        files: project(aggregate([
+            "import { AggregateRoot } from '@ddd-ts-kit/kernel';",
+            "import { Money } from '@/contexts/billing/domain/value-objects/money.vo.js';",
+            "import type { Currency } from '@/shared-kernel/currency.js';",
+            "// import { z } from 'zod';",
+            "/* import fs from 'node:fs'; */",
+            'const note = "import x from \'zod\'";',
+            "const template = `require('pg') ${note} import('express')`;",
+            'const pattern = /import "zod"/;',
+            'export class Invoice extends AggregateRoot {}',
+            'export type { Money, Currency };',
+            'export { note, template, pattern };',
+        ].join('\n')), { [CONFIG_FILE]: config({ rules: { 'clean/no-commented-out-code': 'off' } }) }),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'a validation library in the domain',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import { IsEmail } from 'class-validator';\nexport class Invoice {}\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'a Node built-in in the domain, even node:crypto',
+        expect: { file: AGGREGATE },
+        also: ['purity/no-ambient-randomness'],
+        files: project(aggregate("import { randomUUID } from 'node:crypto';\nexport class Invoice { id = randomUUID(); }\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'a type-only import of a package in the domain',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import type { ZodType } from 'zod';\nexport class Invoice {}\nexport type S = ZodType;\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'a dynamic import in the domain',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("export class Invoice { load() { return import('pg'); } }\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'the domain reaching the application layer',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import type { Mailer } from '@/contexts/billing/application/ports/mailer.port.js';\nexport class Invoice {}\nexport type M = Mailer;\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'an aspect decorator on an aggregate',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import { Logged } from '@ddd-ts-kit/aspects/decorators';\nexport class Invoice {\n  @Logged()\n  async issue(): Promise<void> {}\n}\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'tracing in the domain, even listed in domainAllowedPackages',
+        expect: { file: AGGREGATE },
+        also: ['tracing/platform-only'],
+        files: project(aggregate("import { withSpan } from '@ddd-ts-kit/tracing';\nexport class Invoice {}\nexport { withSpan };\n"), {
+            [CONFIG_FILE]: config({
+                domainAllowedPackages: ['@ddd-ts-kit/kernel', '@ddd-ts-kit/tracing'],
+                deviations: [outsidePackageDeviation('domainAllowedPackages', '@ddd-ts-kit/tracing')],
+            }),
+        }),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'domain, kernel and a declared published language are allowed',
+        expect: 'pass',
+        files: project(handler([
+            "import type { UseCase } from '@ddd-ts-kit/kernel';",
+            "import type { InvoiceRepository } from '@/contexts/billing/domain/repositories/invoice.repository.js';",
+            "import type { ProductListedV1 } from '@/contexts/catalog/published-language/index.js';",
+            'export class IssueInvoiceHandler {}',
+            'export type T = UseCase<ProductListedV1, InvoiceRepository>;',
+        ].join('\n'))),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler wrapping its own call in an aspect',
+        expect: { file: HANDLER },
+        files: project(handler("import { retry } from '@ddd-ts-kit/aspects';\nexport class IssueInvoiceHandler {}\nexport { retry };\n")),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler writing to the audit trail',
+        expect: { file: HANDLER },
+        files: project(handler("import type { AuditTrail } from '@ddd-ts-kit/audit';\nexport class IssueInvoiceHandler {}\nexport type T = AuditTrail;\n")),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'the Redis adapter in a handler, even listed in applicationAllowedPackages',
+        expect: { file: HANDLER },
+        files: project(handler("import { RedisCache } from '@ddd-ts-kit/redis';\nexport class IssueInvoiceHandler {}\nexport { RedisCache };\n"), {
+            [CONFIG_FILE]: config({
+                applicationAllowedPackages: ['@ddd-ts-kit/kernel', '@ddd-ts-kit/auth', '@ddd-ts-kit/redis'],
+                deviations: [outsidePackageDeviation('applicationAllowedPackages', '@ddd-ts-kit/redis')],
+            }),
+        }),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler importing an adapter',
+        expect: { file: HANDLER },
+        files: project(handler("import type { PgInvoiceRepository } from '@/contexts/billing/infrastructure/persistence/pg-invoice.repository.js';\nexport class IssueInvoiceHandler {}\nexport type R = PgInvoiceRepository;\n")),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler importing a framework',
+        expect: { file: HANDLER },
+        files: project(handler("import type { Request } from 'express';\nexport class IssueInvoiceHandler {}\nexport type R = Request;\n")),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler requiring a driver',
+        expect: { file: HANDLER },
+        files: project(handler("const pg = require('pg');\nexport class IssueInvoiceHandler { driver = pg; }\n")),
+    },
+    {
+        ruleId: 'layer/presentation-no-infrastructure',
+        name: 'a route calling a handler',
+        expect: 'pass',
+        files: project({
+            ...handler('export class IssueInvoiceHandler {}\n'),
+            [ROUTE]: "import type { IssueInvoiceHandler } from '@/contexts/billing/application/commands/issue-invoice/issue-invoice.handler.js';\n\nexport type IssueInvoiceRoute = IssueInvoiceHandler;\n",
+        }),
+    },
+    {
+        ruleId: 'layer/presentation-no-infrastructure',
+        name: 'a route importing an adapter',
+        expect: { file: ROUTE },
+        files: project({
+            [ROUTE]: "import type { InMemoryInvoiceRepository } from '@/contexts/billing/infrastructure/persistence/in-memory-invoice.repository.js';\n\nexport type IssueInvoiceRoute = InMemoryInvoiceRepository;\n",
+        }),
+    },
+    {
+        ruleId: 'layer/infrastructure-no-presentation',
+        name: 'an adapter implementing a domain interface',
+        expect: 'pass',
+        files: project({
+            [ADAPTER]: "import type { InvoiceRepository } from '@/contexts/billing/domain/repositories/invoice.repository.js';\nexport class InMemoryInvoiceRepository {}\nexport type R = InvoiceRepository;\n",
+        }),
+    },
+    {
+        ruleId: 'layer/infrastructure-no-presentation',
+        name: 'an adapter importing a DTO',
+        expect: { file: ADAPTER },
+        files: project({
+            [ADAPTER]: "import type { InvoiceDto } from '@/contexts/billing/presentation/http/invoice.dto.js';\n\nexport type InMemoryInvoiceRepository = InvoiceDto;\n",
+        }),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'declared style: a handler importing the kernel declarations and the ports of its context',
+        expect: 'pass',
+        files: declaredProject({
+            [COMMAND]: DECLARED.command,
+            ...handler(DECLARED.handler),
+            [REPOSITORY_PORT]: DECLARED.repositoryPort,
+        }),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'the kernel declarations in the domain, although the kernel is allowed',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import { Repository } from '@ddd-ts-kit/kernel/declarations';\n\nexport class Invoice {}\n\nexport const adapterOf = Repository;\n")),
+    },
+    {
+        ruleId: 'layer/domain-purity',
+        name: 'the scheduler in the domain, even listed in domainAllowedPackages',
+        expect: { file: AGGREGATE },
+        files: project(aggregate("import { InProcessJobScheduler } from '@ddd-ts-kit/scheduling';\n\nexport class Invoice {}\n\nexport const scheduler = InProcessJobScheduler;\n"), {
+            [CONFIG_FILE]: config({
+                domainAllowedPackages: ['@ddd-ts-kit/kernel', '@ddd-ts-kit/scheduling'],
+                deviations: [outsidePackageDeviation('domainAllowedPackages', '@ddd-ts-kit/scheduling')],
+            }),
+        }),
+    },
+    {
+        ruleId: 'layer/application-inward',
+        name: 'a handler reporting an error to Sentry itself',
+        expect: { file: HANDLER },
+        files: project(handler("import { SentryErrorReporter } from '@ddd-ts-kit/sentry';\n\nexport class IssueInvoiceHandler {}\n\nexport const reporter = SentryErrorReporter;\n")),
+    },
+];
+//# sourceMappingURL=layer-fixtures.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"layer-fixtures.js","sourceRoot":"","sources":["../../../src/check/fixtures/layer-fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAC3C,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AACrC,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,uBAAuB,EAAE,MAAM,gCAAgC,CAAC;AACzE,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAEvC,MAAM,EAAE,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,OAAO,EAAE,eAAe,EAAE,KAAK,EAAE,GAAG,KAAK,CAAC;AAE/E,MAAM,CAAC,MAAM,cAAc,GAAuB;IAChD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,wFAAwF;QAC9F,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CACZ,SAAS,CACP;YACE,qDAAqD;YACrD,8EAA8E;YAC9E,8DAA8D;YAC9D,6BAA6B;YAC7B,iCAAiC;YACjC,uCAAuC;YACvC,6DAA6D;YAC7D,iCAAiC;YACjC,+CAA+C;YAC/C,kCAAkC;YAClC,qCAAqC;SACtC,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,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,qBAAqB;QAC7B,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,uEAAuE,CAAC,CAAC;KACnG;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,iDAAiD;QACvD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,IAAI,EAAE,CAAC,8BAA8B,CAAC;QACtC,KAAK,EAAE,OAAO,CACZ,SAAS,CAAC,0FAA0F,CAAC,CACtG;KACF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,+CAA+C;QACrD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CACZ,SAAS,CAAC,0FAA0F,CAAC,CACtG;KACF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,gCAAgC;QACtC,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CAAC,SAAS,CAAC,4DAA4D,CAAC,CAAC;KACxF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,2CAA2C;QACjD,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CACZ,SAAS,CACP,wIAAwI,CACzI,CACF;KACF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,qCAAqC;QAC3C,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CACZ,SAAS,CACP,uIAAuI,CACxI,CACF;KACF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,6DAA6D;QACnE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,IAAI,EAAE,CAAC,uBAAuB,CAAC;QAC/B,KAAK,EAAE,OAAO,CACZ,SAAS,CAAC,kGAAkG,CAAC,EAC7G;YACE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;gBACpB,qBAAqB,EAAE,CAAC,oBAAoB,EAAE,qBAAqB,CAAC;gBACpE,UAAU,EAAE,CAAC,uBAAuB,CAAC,uBAAuB,EAAE,qBAAqB,CAAC,CAAC;aACtF,CAAC;SACH,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,8DAA8D;QACpE,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CACZ,OAAO,CACL;YACE,oDAAoD;YACpD,wGAAwG;YACxG,wFAAwF;YACxF,qCAAqC;YACrC,8DAA8D;SAC/D,CAAC,IAAI,CAAC,IAAI,CAAC,CACb,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,8CAA8C;QACpD,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CAAC,wGAAwG,CAAC,CAClH;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,sCAAsC;QAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CACL,0HAA0H,CAC3H,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,2EAA2E;QACjF,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CACL,gHAAgH,CACjH,EACD;YACE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;gBACpB,0BAA0B,EAAE,CAAC,oBAAoB,EAAE,kBAAkB,EAAE,mBAAmB,CAAC;gBAC3F,UAAU,EAAE,CAAC,uBAAuB,CAAC,4BAA4B,EAAE,mBAAmB,CAAC,CAAC;aACzF,CAAC;SACH,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,gCAAgC;QACtC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CACL,iMAAiM,CAClM,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,iCAAiC;QACvC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CACL,0GAA0G,CAC3G,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,8BAA8B;QACpC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CAAC,OAAO,CAAC,gFAAgF,CAAC,CAAC;KAC1G;IACD;QACE,MAAM,EAAE,sCAAsC;QAC9C,IAAI,EAAE,2BAA2B;QACjC,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,GAAG,OAAO,CAAC,uCAAuC,CAAC;YACnD,CAAC,KAAK,CAAC,EACL,sLAAsL;SACzL,CAAC;KACH;IACD;QACE,MAAM,EAAE,sCAAsC;QAC9C,IAAI,EAAE,8BAA8B;QACpC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EACL,iMAAiM;SACpM,CAAC;KACH;IACD;QACE,MAAM,EAAE,sCAAsC;QAC9C,IAAI,EAAE,4CAA4C;QAClD,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,OAAO,CAAC,EACP,yLAAyL;SAC5L,CAAC;KACH;IACD;QACE,MAAM,EAAE,sCAAsC;QAC9C,IAAI,EAAE,4BAA4B;QAClC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,OAAO,CAAC,EACP,iJAAiJ;SACpJ,CAAC;KACH;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,0FAA0F;QAChG,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,eAAe,CAAC;YACrB,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,OAAO;YAC3B,GAAG,OAAO,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC5B,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc;SAC3C,CAAC;KACH;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,uEAAuE;QAC7E,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CACZ,SAAS,CACP,oIAAoI,CACrI,CACF;KACF;IACD;QACE,MAAM,EAAE,qBAAqB;QAC7B,IAAI,EAAE,mEAAmE;QACzE,MAAM,EAAE,EAAE,IAAI,EAAE,SAAS,EAAE;QAC3B,KAAK,EAAE,OAAO,CACZ,SAAS,CACP,iJAAiJ,CAClJ,EACD;YACE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;gBACpB,qBAAqB,EAAE,CAAC,oBAAoB,EAAE,wBAAwB,CAAC;gBACvE,UAAU,EAAE,CAAC,uBAAuB,CAAC,uBAAuB,EAAE,wBAAwB,CAAC,CAAC;aACzF,CAAC;SACH,CACF;KACF;IACD;QACE,MAAM,EAAE,0BAA0B;QAClC,IAAI,EAAE,+CAA+C;QACrD,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CACZ,OAAO,CACL,oJAAoJ,CACrJ,CACF;KACF;CACF,CAAC"}

package/dist/check/fixtures/layout-fixtures.d.ts

@@ -0,0 +1,3 @@
+import type { Fixture } from './fixture.js';
+export declare const LAYOUT_FIXTURES: readonly Fixture[];
+//# sourceMappingURL=layout-fixtures.d.ts.map

package/dist/check/fixtures/layout-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"layout-fixtures.d.ts","sourceRoot":"","sources":["../../../src/check/fixtures/layout-fixtures.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAqT5C,eAAO,MAAM,eAAe,EAAE,SAAS,OAAO,EAM7C,CAAC"}

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

@@ -0,0 +1,165 @@
+import { CONFIG_FILE } from '../../config/index.js';
+import { config } from './config.js';
+import { PATHS } from './paths.js';
+import { project } from './project.js';
+import { source } from './source.js';
+const { ADAPTER, BILLING, PORT } = PATHS;
+const RESULT = `${BILLING}/application/commands/issue-invoice/issue-invoice.result.ts`;
+const LINES = 'src/platform/lines.ts';
+const TOTAL = 'src/platform/total.ts';
+const GATEWAYS = `${BILLING}/application/ports/gateways.port.ts`;
+const HASH_PRIVATE = [
+    {
+        ruleId: 'clean/no-hash-private',
+        name: 'private members, a hash in a string and in a comment',
+        expect: 'pass',
+        files: project({
+            [ADAPTER]: source('export class InMemoryInvoiceRepository {', '  // The #rows of the first version are gone.', '  private readonly rows = new Map<string, string>();', '', '  find(id: string): string {', "    return this.rows.get(id) ?? '#none';", '  }', '}'),
+        }),
+    },
+    {
+        ruleId: 'clean/no-hash-private',
+        name: 'a hash field and a hash method',
+        expect: { file: ADAPTER },
+        files: project({
+            [ADAPTER]: source('export class InMemoryInvoiceRepository {', '  readonly #rows = new Map<string, string>();', '', '  find(id: string): string | undefined {', '    return this.#read(id);', '  }', '', '  #read(id: string): string | undefined {', '    return this.#rows.get(id);', '  }', '}'),
+        }),
+    },
+];
+const BLANK_LINES = [
+    {
+        ruleId: 'clean/blank-lines',
+        name: 'a return set apart, alone in its block, under a label or under its comment',
+        expect: 'pass',
+        files: project({
+            'src/platform/label.ts': source('export function label(status: string, issued: boolean): string {', '  if (!issued) {', '    return status;', '  }', '', '  switch (status) {', "    case 'paid':", "      return 'Paid';", '    default: {', '      // Anything else is still due.', "      return 'Due';", '    }', '  }', '}'),
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '  const sum = amounts.reduce((left, right) => left + right, 0);', '', '  // Rounded to cents: amounts are stored as integers.', '  return Math.round(sum);', '}'),
+        }),
+    },
+    {
+        ruleId: 'clean/blank-lines',
+        name: 'a return right after a statement',
+        expect: { file: TOTAL },
+        files: project({
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '  const sum = amounts.reduce((left, right) => left + right, 0);', '  return Math.round(sum);', '}'),
+        }),
+    },
+    {
+        ruleId: 'clean/blank-lines',
+        name: 'a block padded with blank lines',
+        expect: { file: TOTAL },
+        files: project({
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '', '  return amounts.length;', '', '}'),
+        }),
+    },
+];
+const BRACES = [
+    {
+        ruleId: 'clean/braces',
+        name: 'braces around every branch and loop, an empty body, a ternary, an arrow returning an expression, a method named do',
+        expect: 'pass',
+        files: project({
+            [TOTAL]: source('export async function total(amounts: readonly number[], steps: readonly (() => Promise<void>)[]): Promise<number> {', '  if (amounts.length === 0) {', '    return 0;', '  } else if (amounts.length === 1) {', '    return amounts[0] ?? 0;', '  }', '', '  for (const step of steps) {', '    await step();', '  }', '', '  for (;;) {}', '', '  do {', '    amounts.keys();', '  } while (amounts.length < 0);', '', '  return amounts.map((amount) => (amount > 0 ? amount : 0)).reduce((left, right) => left + right, 0);', '}', '', 'export const task = { do(): void {}, else: 1 };'),
+        }),
+    },
+    {
+        ruleId: 'clean/braces',
+        name: 'an if without braces',
+        expect: { file: TOTAL },
+        files: project({
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '  if (amounts.length === 0) return 0;', '', '  return amounts.length;', '}'),
+        }),
+    },
+    {
+        ruleId: 'clean/braces',
+        name: 'a loop whose body shares the line of its braces',
+        expect: { file: TOTAL },
+        files: project({
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '  let sum = 0;', '', '  for (const amount of amounts) { sum += amount; }', '', '  return sum;', '}'),
+        }),
+    },
+    {
+        ruleId: 'clean/braces',
+        name: 'an else on a line of its own',
+        expect: { file: TOTAL },
+        files: project({
+            [TOTAL]: source('export function total(amounts: readonly number[]): number {', '  if (amounts.length === 0) {', '    return 0;', '  }', '  else {', '    return amounts.length;', '  }', '}'),
+        }),
+    },
+];
+const ONE_EXPORT = [
+    {
+        ruleId: 'clean/one-export-per-file',
+        name: 'one class with the types of its signature, a result, a union with its constructors, accessors of one state, an index that re-exports',
+        expect: 'pass',
+        files: project({
+            [ADAPTER]: source('export interface FindOptions {', '  readonly limit: number;', '}', '', 'export const DEFAULT_LIMIT = 50;', '', 'export class InMemoryInvoiceRepository {', '  find(options: FindOptions): number {', '    return options.limit;', '  }', '}'),
+            [RESULT]: source('export interface IssueInvoiceResult {', '  readonly invoiceId: string;', '}'),
+            'src/shared-kernel/outcome.ts': source('export interface Success {', '  readonly ok: true;', '}', '', 'export interface Failure {', '  readonly ok: false;', '}', '', 'export type Outcome = Success | Failure;', '', 'export function success(): Success {', '  return { ok: true };', '}', '', 'export function failure(): Failure {', '  return { ok: false };', '}'),
+            'src/platform/counters.ts': source('const counters = new Map<string, number>();', '', 'export function increment(name: string): void {', '  counters.set(name, countOf(name) + 1);', '}', '', 'export function countOf(name: string): number {', '  return counters.get(name) ?? 0;', '}'),
+            'src/platform/index.ts': source("export { countOf, increment } from '@/platform/counters.js';", "export type { Outcome } from '@/shared-kernel/outcome.js';"),
+        }),
+    },
+    {
+        ruleId: 'clean/one-export-per-file',
+        name: 'several exports that are one thing, allowed in the config with their reason',
+        expect: 'pass',
+        files: project({
+            'src/platform/http-server.ts': source('export class HttpServer {}', '', 'export class HttpServerError extends Error {}'),
+        }, {
+            [CONFIG_FILE]: config({
+                onePerFile: {
+                    allow: [{ file: 'src/platform/http-*.ts', reason: 'The server and the error it raises are one boundary.' }],
+                },
+            }),
+        }),
+    },
+    {
+        ruleId: 'clean/one-export-per-file',
+        name: 'two ports in one file',
+        expect: { file: GATEWAYS },
+        files: project({
+            [GATEWAYS]: source('export abstract class PaymentGateway {}', '', 'export abstract class TaxGateway {}'),
+        }),
+    },
+    {
+        ruleId: 'clean/one-export-per-file',
+        name: 'a file that is not named after what it exports',
+        expect: { file: PORT },
+        files: project({ [PORT]: 'export abstract class TaxRates {}\n' }),
+    },
+    {
+        ruleId: 'clean/one-export-per-file',
+        name: 'an index file that declares something',
+        expect: { file: 'src/platform/index.ts' },
+        files: project({
+            'src/platform/index.ts': source("export * from '@/platform/counters.js';", '', 'export const platformName = 1;'),
+        }),
+    },
+];
+const FILE_SIZE = [
+    {
+        ruleId: 'clean/file-size',
+        name: 'a file of exactly 350 lines',
+        expect: 'pass',
+        files: project({ [LINES]: listOfLines(350) }),
+    },
+    {
+        ruleId: 'clean/file-size',
+        name: 'a file of 351 lines',
+        expect: { file: LINES },
+        files: project({ [LINES]: listOfLines(351) }),
+    },
+];
+export const LAYOUT_FIXTURES = [
+    ...HASH_PRIVATE,
+    ...BLANK_LINES,
+    ...BRACES,
+    ...ONE_EXPORT,
+    ...FILE_SIZE,
+];
+/** A source of exactly `count` lines: a list written one entry per line. */
+function listOfLines(count) {
+    return source('export const lines = [', ...Array.from({ length: count - 2 }, (_, index) => `  ${index},`), '];');
+}
+//# sourceMappingURL=layout-fixtures.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"layout-fixtures.js","sourceRoot":"","sources":["../../../src/check/fixtures/layout-fixtures.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,uBAAuB,CAAC;AACpD,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,OAAO,EAAE,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,GAAG,KAAK,CAAC;AAEzC,MAAM,MAAM,GAAG,GAAG,OAAO,6DAA6D,CAAC;AACvF,MAAM,KAAK,GAAG,uBAAuB,CAAC;AACtC,MAAM,KAAK,GAAG,uBAAuB,CAAC;AACtC,MAAM,QAAQ,GAAG,GAAG,OAAO,qCAAqC,CAAC;AAEjE,MAAM,YAAY,GAAuB;IACvC;QACE,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,sDAAsD;QAC5D,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,OAAO,CAAC,EAAE,MAAM,CACf,0CAA0C,EAC1C,+CAA+C,EAC/C,sDAAsD,EACtD,EAAE,EACF,8BAA8B,EAC9B,0CAA0C,EAC1C,KAAK,EACL,GAAG,CACJ;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,uBAAuB;QAC/B,IAAI,EAAE,gCAAgC;QACtC,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,OAAO,CAAC,EAAE,MAAM,CACf,0CAA0C,EAC1C,+CAA+C,EAC/C,EAAE,EACF,0CAA0C,EAC1C,4BAA4B,EAC5B,KAAK,EACL,EAAE,EACF,2CAA2C,EAC3C,gCAAgC,EAChC,KAAK,EACL,GAAG,CACJ;SACF,CAAC;KACH;CACF,CAAC;AAEF,MAAM,WAAW,GAAuB;IACtC;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,4EAA4E;QAClF,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,uBAAuB,EAAE,MAAM,CAC7B,kEAAkE,EAClE,kBAAkB,EAClB,oBAAoB,EACpB,KAAK,EACL,EAAE,EACF,qBAAqB,EACrB,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EAChB,sCAAsC,EACtC,qBAAqB,EACrB,OAAO,EACP,KAAK,EACL,GAAG,CACJ;YACD,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,iEAAiE,EACjE,EAAE,EACF,wDAAwD,EACxD,2BAA2B,EAC3B,GAAG,CACJ;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,kCAAkC;QACxC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,iEAAiE,EACjE,2BAA2B,EAC3B,GAAG,CACJ;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,mBAAmB;QAC3B,IAAI,EAAE,iCAAiC;QACvC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,EAAE,EACF,0BAA0B,EAC1B,EAAE,EACF,GAAG,CACJ;SACF,CAAC;KACH;CACF,CAAC;AAEF,MAAM,MAAM,GAAuB;IACjC;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,oHAAoH;QAC1H,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,qHAAqH,EACrH,+BAA+B,EAC/B,eAAe,EACf,sCAAsC,EACtC,6BAA6B,EAC7B,KAAK,EACL,EAAE,EACF,+BAA+B,EAC/B,mBAAmB,EACnB,KAAK,EACL,EAAE,EACF,eAAe,EACf,EAAE,EACF,QAAQ,EACR,qBAAqB,EACrB,iCAAiC,EACjC,EAAE,EACF,uGAAuG,EACvG,GAAG,EACH,EAAE,EACF,iDAAiD,CAClD;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,sBAAsB;QAC5B,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,uCAAuC,EACvC,EAAE,EACF,0BAA0B,EAC1B,GAAG,CACJ;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,iDAAiD;QACvD,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,gBAAgB,EAChB,EAAE,EACF,oDAAoD,EACpD,EAAE,EACF,eAAe,EACf,GAAG,CACJ;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,cAAc;QACtB,IAAI,EAAE,8BAA8B;QACpC,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,KAAK,CAAC,EAAE,MAAM,CACb,6DAA6D,EAC7D,+BAA+B,EAC/B,eAAe,EACf,KAAK,EACL,UAAU,EACV,4BAA4B,EAC5B,KAAK,EACL,GAAG,CACJ;SACF,CAAC;KACH;CACF,CAAC;AAEF,MAAM,UAAU,GAAuB;IACrC;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,sIAAsI;QAC5I,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,OAAO,CAAC,EAAE,MAAM,CACf,gCAAgC,EAChC,2BAA2B,EAC3B,GAAG,EACH,EAAE,EACF,kCAAkC,EAClC,EAAE,EACF,0CAA0C,EAC1C,wCAAwC,EACxC,2BAA2B,EAC3B,KAAK,EACL,GAAG,CACJ;YACD,CAAC,MAAM,CAAC,EAAE,MAAM,CAAC,uCAAuC,EAAE,+BAA+B,EAAE,GAAG,CAAC;YAC/F,8BAA8B,EAAE,MAAM,CACpC,4BAA4B,EAC5B,sBAAsB,EACtB,GAAG,EACH,EAAE,EACF,4BAA4B,EAC5B,uBAAuB,EACvB,GAAG,EACH,EAAE,EACF,0CAA0C,EAC1C,EAAE,EACF,sCAAsC,EACtC,wBAAwB,EACxB,GAAG,EACH,EAAE,EACF,sCAAsC,EACtC,yBAAyB,EACzB,GAAG,CACJ;YACD,0BAA0B,EAAE,MAAM,CAChC,6CAA6C,EAC7C,EAAE,EACF,iDAAiD,EACjD,0CAA0C,EAC1C,GAAG,EACH,EAAE,EACF,iDAAiD,EACjD,mCAAmC,EACnC,GAAG,CACJ;YACD,uBAAuB,EAAE,MAAM,CAC7B,8DAA8D,EAC9D,4DAA4D,CAC7D;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,6EAA6E;QACnF,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CACZ;YACE,6BAA6B,EAAE,MAAM,CACnC,4BAA4B,EAC5B,EAAE,EACF,+CAA+C,CAChD;SACF,EACD;YACE,CAAC,WAAW,CAAC,EAAE,MAAM,CAAC;gBACpB,UAAU,EAAE;oBACV,KAAK,EAAE,CAAC,EAAE,IAAI,EAAE,wBAAwB,EAAE,MAAM,EAAE,sDAAsD,EAAE,CAAC;iBAC5G;aACF,CAAC;SACH,CACF;KACF;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,uBAAuB;QAC7B,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;QAC1B,KAAK,EAAE,OAAO,CAAC;YACb,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,yCAAyC,EAAE,EAAE,EAAE,qCAAqC,CAAC;SACzG,CAAC;KACH;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,gDAAgD;QACtD,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACtB,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,qCAAqC,EAAE,CAAC;KAClE;IACD;QACE,MAAM,EAAE,2BAA2B;QACnC,IAAI,EAAE,uCAAuC;QAC7C,MAAM,EAAE,EAAE,IAAI,EAAE,uBAAuB,EAAE;QACzC,KAAK,EAAE,OAAO,CAAC;YACb,uBAAuB,EAAE,MAAM,CAAC,yCAAyC,EAAE,EAAE,EAAE,gCAAgC,CAAC;SACjH,CAAC;KACH;CACF,CAAC;AAEF,MAAM,SAAS,GAAuB;IACpC;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,6BAA6B;QACnC,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;KAC9C;IACD;QACE,MAAM,EAAE,iBAAiB;QACzB,IAAI,EAAE,qBAAqB;QAC3B,MAAM,EAAE,EAAE,IAAI,EAAE,KAAK,EAAE;QACvB,KAAK,EAAE,OAAO,CAAC,EAAE,CAAC,KAAK,CAAC,EAAE,WAAW,CAAC,GAAG,CAAC,EAAE,CAAC;KAC9C;CACF,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAuB;IACjD,GAAG,YAAY;IACf,GAAG,WAAW;IACd,GAAG,MAAM;IACT,GAAG,UAAU;IACb,GAAG,SAAS;CACb,CAAC;AAEF,4EAA4E;AAC5E,SAAS,WAAW,CAAC,KAAa;IAChC,OAAO,MAAM,CAAC,wBAAwB,EAAE,GAAG,KAAK,CAAC,IAAI,CAAC,EAAE,MAAM,EAAE,KAAK,GAAG,CAAC,EAAE,EAAE,CAAC,CAAC,EAAE,KAAK,EAAE,EAAE,CAAC,KAAK,KAAK,GAAG,CAAC,EAAE,IAAI,CAAC,CAAC;AACnH,CAAC"}

package/dist/check/fixtures/naming-fixtures.d.ts

@@ -0,0 +1,3 @@
+import type { Fixture } from './fixture.js';
+export declare const NAMING_FIXTURES: readonly Fixture[];
+//# sourceMappingURL=naming-fixtures.d.ts.map

package/dist/check/fixtures/naming-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"naming-fixtures.d.ts","sourceRoot":"","sources":["../../../src/check/fixtures/naming-fixtures.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAmD5C,eAAO,MAAM,eAAe,EAAE,SAAS,OAAO,EA4D7C,CAAC"}

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

@@ -0,0 +1,83 @@
+import { contextDoc } from './context-doc.js';
+import { DECLARED } from './declared.js';
+import { declaredProject } from './declared-project.js';
+import { PATHS } from './paths.js';
+import { SAMPLES } from './samples.js';
+import { source } from './source.js';
+const { ADAPTER, BILLING, PORT, REPOSITORY_PORT } = PATHS;
+const RULE = 'naming/search-not-list';
+const QUERIES = `${BILLING}/application/queries`;
+const READER = `${BILLING}/application/ports/invoice-reader.port.ts`;
+const FAKE = `${BILLING}/test/fakes/invoice-reader.fake.ts`;
+const AUTHORIZER = `${BILLING}/infrastructure/external/billing-authorizer.adapter.ts`;
+const GLOSSARY = { [`${BILLING}/CONTEXT.md`]: contextDoc('core', undefined, glossaryWith('Search', 'List')) };
+const SEARCHING = source('export abstract class InvoiceReader {', '  abstract search(scope: AccessScope, page: PageRequest<InvoiceSort>): Promise<Page<InvoiceLine>>;', '', '  abstract searchByCustomer(customerId: string): Promise<readonly InvoiceLine[]>;', '', '  abstract findById(id: string): Promise<InvoiceLine | undefined>;', '}');
+const LISTING = SEARCHING.replace('abstract search(', 'abstract list(');
+const FAKED = source("import { InvoiceReader } from '@/contexts/billing/application/ports/invoice-reader.port.js';", '', 'export class FakeInvoiceReader implements InvoiceReader {', '  readonly listings: string[] = [];', '', '  async search(): Promise<Page<InvoiceLine>> {', '    return { items: [] };', '  }', '}');
+const AUTHORIZING = source(`import { Adapter } from '@ddd-ts-kit/kernel/declarations';`, "import { Authorizer } from '@ddd-ts-kit/kernel';", '', "@Adapter(Authorizer, { kind: 'external' })", 'export class BillingAuthorizer implements Authorizer {', '  async listAccessible(): Promise<AccessScope> {', "    return { kind: 'all' };", '  }', '}');
+export const NAMING_FIXTURES = [
+    {
+        ruleId: RULE,
+        name: 'a port, a fake and a query that search, a property named after its listings, the listAccessible of the kit',
+        expect: 'pass',
+        files: declaredProject({
+            ...GLOSSARY,
+            [READER]: SEARCHING,
+            [FAKE]: FAKED,
+            [AUTHORIZER]: AUTHORIZING,
+            ...query('search-invoices', 'SearchInvoices'),
+        }),
+    },
+    {
+        ruleId: RULE,
+        name: 'a read port with a method named list',
+        expect: { file: READER },
+        files: declaredProject({ [READER]: LISTING }),
+    },
+    {
+        ruleId: RULE,
+        name: 'a repository port with a method named listByCustomer',
+        expect: { file: REPOSITORY_PORT },
+        files: declaredProject({
+            [REPOSITORY_PORT]: DECLARED.repositoryPort.replace('{}', '{\n  abstract listByCustomer(customerId: string): Promise<readonly Invoice[]>;\n}'),
+        }),
+    },
+    {
+        ruleId: RULE,
+        name: 'an adapter with a method named list',
+        expect: { file: ADAPTER },
+        files: declaredProject({
+            [REPOSITORY_PORT]: DECLARED.repositoryPort,
+            [ADAPTER]: DECLARED.repository.replace('{}', '{\n  async list(): Promise<readonly Invoice[]> {\n    return [];\n  }\n}'),
+        }),
+    },
+    {
+        ruleId: RULE,
+        name: 'a fake with a method named listAll',
+        expect: { file: FAKE },
+        files: declaredProject({ [READER]: SEARCHING, [FAKE]: FAKED.replace('async search(', 'async listAll(') }),
+    },
+    {
+        ruleId: RULE,
+        name: 'a query named ListInvoices in a folder named list-invoices',
+        expect: { file: `${QUERIES}/list-invoices/list-invoices.query.ts` },
+        files: declaredProject({ ...GLOSSARY, ...query('list-invoices', 'ListInvoices') }),
+    },
+    {
+        ruleId: RULE,
+        name: 'a port outside a context is not judged, nor a payment gateway that lists nothing',
+        expect: 'pass',
+        files: declaredProject({ [PORT]: DECLARED.port, 'src/platform/audit/invoice-reader.ts': LISTING }),
+    },
+];
+function glossaryWith(...terms) {
+    return [SAMPLES.GLOSSARY, ...terms.map((term) => `| ${term} | To read invoices page by page. |`)].join('\n');
+}
+function query(folder, name) {
+    return {
+        [`${QUERIES}/${folder}/${folder}.query.ts`]: DECLARED.query.replace('InvoicesIssued', name),
+        [`${QUERIES}/${folder}/${folder}.handler.ts`]: DECLARED.queryHandler.replaceAll('InvoicesIssued', name),
+        [`${BILLING}/test/unit/${folder}.handler.spec.ts`]: SAMPLES.SPEC,
+    };
+}
+//# sourceMappingURL=naming-fixtures.js.map

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

@@ -0,0 +1 @@
+{"version":3,"file":"naming-fixtures.js","sourceRoot":"","sources":["../../../src/check/fixtures/naming-fixtures.ts"],"names":[],"mappings":"AAAA,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,KAAK,EAAE,MAAM,YAAY,CAAC;AACnC,OAAO,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AACvC,OAAO,EAAE,MAAM,EAAE,MAAM,aAAa,CAAC;AAErC,MAAM,EAAE,OAAO,EAAE,OAAO,EAAE,IAAI,EAAE,eAAe,EAAE,GAAG,KAAK,CAAC;AAE1D,MAAM,IAAI,GAAG,wBAAwB,CAAC;AACtC,MAAM,OAAO,GAAG,GAAG,OAAO,sBAAsB,CAAC;AACjD,MAAM,MAAM,GAAG,GAAG,OAAO,2CAA2C,CAAC;AACrE,MAAM,IAAI,GAAG,GAAG,OAAO,oCAAoC,CAAC;AAC5D,MAAM,UAAU,GAAG,GAAG,OAAO,wDAAwD,CAAC;AAEtF,MAAM,QAAQ,GAAG,EAAE,CAAC,GAAG,OAAO,aAAa,CAAC,EAAE,UAAU,CAAC,MAAM,EAAE,SAAS,EAAE,YAAY,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC,EAAE,CAAC;AAE9G,MAAM,SAAS,GAAG,MAAM,CACtB,uCAAuC,EACvC,oGAAoG,EACpG,EAAE,EACF,mFAAmF,EACnF,EAAE,EACF,oEAAoE,EACpE,GAAG,CACJ,CAAC;AAEF,MAAM,OAAO,GAAG,SAAS,CAAC,OAAO,CAAC,kBAAkB,EAAE,gBAAgB,CAAC,CAAC;AAExE,MAAM,KAAK,GAAG,MAAM,CAClB,8FAA8F,EAC9F,EAAE,EACF,2DAA2D,EAC3D,qCAAqC,EACrC,EAAE,EACF,gDAAgD,EAChD,2BAA2B,EAC3B,KAAK,EACL,GAAG,CACJ,CAAC;AAEF,MAAM,WAAW,GAAG,MAAM,CACxB,4DAA4D,EAC5D,kDAAkD,EAClD,EAAE,EACF,4CAA4C,EAC5C,wDAAwD,EACxD,kDAAkD,EAClD,6BAA6B,EAC7B,KAAK,EACL,GAAG,CACJ,CAAC;AAEF,MAAM,CAAC,MAAM,eAAe,GAAuB;IACjD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,4GAA4G;QAClH,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,eAAe,CAAC;YACrB,GAAG,QAAQ;YACX,CAAC,MAAM,CAAC,EAAE,SAAS;YACnB,CAAC,IAAI,CAAC,EAAE,KAAK;YACb,CAAC,UAAU,CAAC,EAAE,WAAW;YACzB,GAAG,KAAK,CAAC,iBAAiB,EAAE,gBAAgB,CAAC;SAC9C,CAAC;KACH;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,sCAAsC;QAC5C,MAAM,EAAE,EAAE,IAAI,EAAE,MAAM,EAAE;QACxB,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,OAAO,EAAE,CAAC;KAC9C;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,sDAAsD;QAC5D,MAAM,EAAE,EAAE,IAAI,EAAE,eAAe,EAAE;QACjC,KAAK,EAAE,eAAe,CAAC;YACrB,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc,CAAC,OAAO,CAChD,IAAI,EACJ,mFAAmF,CACpF;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,qCAAqC;QAC3C,MAAM,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE;QACzB,KAAK,EAAE,eAAe,CAAC;YACrB,CAAC,eAAe,CAAC,EAAE,QAAQ,CAAC,cAAc;YAC1C,CAAC,OAAO,CAAC,EAAE,QAAQ,CAAC,UAAU,CAAC,OAAO,CACpC,IAAI,EACJ,0EAA0E,CAC3E;SACF,CAAC;KACH;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,oCAAoC;QAC1C,MAAM,EAAE,EAAE,IAAI,EAAE,IAAI,EAAE;QACtB,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC,MAAM,CAAC,EAAE,SAAS,EAAE,CAAC,IAAI,CAAC,EAAE,KAAK,CAAC,OAAO,CAAC,eAAe,EAAE,gBAAgB,CAAC,EAAE,CAAC;KAC1G;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,4DAA4D;QAClE,MAAM,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,uCAAuC,EAAE;QACnE,KAAK,EAAE,eAAe,CAAC,EAAE,GAAG,QAAQ,EAAE,GAAG,KAAK,CAAC,eAAe,EAAE,cAAc,CAAC,EAAE,CAAC;KACnF;IACD;QACE,MAAM,EAAE,IAAI;QACZ,IAAI,EAAE,kFAAkF;QACxF,MAAM,EAAE,MAAM;QACd,KAAK,EAAE,eAAe,CAAC,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,CAAC,IAAI,EAAE,sCAAsC,EAAE,OAAO,EAAE,CAAC;KACnG;CACF,CAAC;AAEF,SAAS,YAAY,CAAC,GAAG,KAAe;IACtC,OAAO,CAAC,OAAO,CAAC,QAAQ,EAAE,GAAG,KAAK,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,KAAK,IAAI,qCAAqC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AAC/G,CAAC;AAED,SAAS,KAAK,CAAC,MAAc,EAAE,IAAY;IACzC,OAAO;QACL,CAAC,GAAG,OAAO,IAAI,MAAM,IAAI,MAAM,WAAW,CAAC,EAAE,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,gBAAgB,EAAE,IAAI,CAAC;QAC3F,CAAC,GAAG,OAAO,IAAI,MAAM,IAAI,MAAM,aAAa,CAAC,EAAE,QAAQ,CAAC,YAAY,CAAC,UAAU,CAAC,gBAAgB,EAAE,IAAI,CAAC;QACvG,CAAC,GAAG,OAAO,cAAc,MAAM,kBAAkB,CAAC,EAAE,OAAO,CAAC,IAAI;KACjE,CAAC;AACJ,CAAC"}

package/dist/check/fixtures/outbox-fixtures.d.ts

@@ -0,0 +1,3 @@
+import type { Fixture } from './fixture.js';
+export declare const OUTBOX_FIXTURES: readonly Fixture[];
+//# sourceMappingURL=outbox-fixtures.d.ts.map

package/dist/check/fixtures/outbox-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"outbox-fixtures.d.ts","sourceRoot":"","sources":["../../../src/check/fixtures/outbox-fixtures.ts"],"names":[],"mappings":"AAEA,OAAO,KAAK,EAAE,OAAO,EAAE,MAAM,cAAc,CAAC;AAO5C,eAAO,MAAM,eAAe,EAAE,SAAS,OAAO,EA6F7C,CAAC"}