@ddd-ts-kit/eslint-plugin 0.0.0-stage → 0.1.0

package/dist/rules/clean-no-noise-comment.js

@@ -0,0 +1,187 @@
+import { AST_TOKEN_TYPES } from '@typescript-eslint/utils';
+import { commentLines } from '../support/comments/comment-lines.js';
+import { isDirective } from '../support/comments/is-directive.js';
+import { isJsdoc } from '../support/comments/is-jsdoc.js';
+import { defineRule } from '../support/rule/define-rule.js';
+import { sameWord } from '../support/words/same-word.js';
+import { splitWords } from '../support/words/split-words.js';
+const BANNER = /^(?:[-=*#~_+/\\]\s?){4,}|^[-=*#~]{2,}.*[-=*#~]{3,}$/;
+const CLOSING = /^(?:end\b|close\b|\/\s*\w+|(?:if|for|while|function|class|switch|try|catch|else|namespace|module|describe|it)\b)/i;
+const JOURNAL = /@(?:author|created|modified|date|changelog)\b|^(?:\d{4}[-/.]\d{1,2}[-/.]\d{1,2}|\d{1,2}[-/.]\d{1,2}[-/.]\d{4})\b|\b(?:added|changed|modified|fixed|created|updated|written)\s+by\s+[A-Z@]/;
+const EMPTY_TAG = /^@(?:param|arg|argument)\s+(?:\{[^}]*\}\s*)?[[\]\w$.=]+\s*-?\s*$|^@(?:returns?|throws)\s*(?:\{[^}]*\})?\s*$/;
+const OWNERLESS_TODO = /\b(?:TODO|FIXME)\b(?!\s*\()/;
+const REFERENCE = /#\d+|\b[A-Z][A-Z0-9]+-\d+\b|https?:\/\//;
+/** Words that add nothing to the name they sit next to. */
+const FILLER = [
+    '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',
+];
+const MODIFIERS = new Set([
+    'export',
+    'default',
+    'public',
+    'private',
+    'protected',
+    'static',
+    'readonly',
+    'abstract',
+    'async',
+    'override',
+    'declare',
+    'get',
+    'set',
+    'const',
+    'let',
+    'var',
+    'function',
+    'class',
+    'interface',
+    'type',
+    'enum',
+    '*',
+]);
+const NAME_TOKENS = new Set([AST_TOKEN_TYPES.Identifier, AST_TOKEN_TYPES.PrivateIdentifier]);
+const INSTEAD = 'Delete it, or replace it by what the name cannot say: why, a constraint, a consequence.';
+export const cleanNoNoiseComment = defineRule({
+    id: 'clean/no-noise-comment',
+    type: 'suggestion',
+    recommended: 'warn',
+    description: 'No comment that restates the code, no banner, no journal, no closing-brace comment, no @param without description.',
+    messages: {
+        banner: 'The comment is a banner: "{{excerpt}}". Delete it; if the file needs sections, it holds several concepts that deserve their own files.',
+        closingBrace: 'The comment labels a closing brace: "{{excerpt}}". Delete it and shorten the block: a brace that needs a label closes a function that is too long.',
+        journal: 'The comment keeps a journal or an author: "{{excerpt}}". Delete it: version control records who changed what and when.',
+        emptyTag: 'The comment is a tag without a description: "{{excerpt}}". Describe what the type cannot say (unit, range, meaning of an absent value) or delete the tag.',
+        ownerlessTodo: 'The comment is a TODO without an owner or a reference: "{{excerpt}}". Write it as TODO(<owner or ticket>): ..., or do it now, or delete it.',
+        restatesName: `The comment only repeats the name {{name}}: "{{excerpt}}". ${INSTEAD}`,
+    },
+    create({ sourceCode, report }) {
+        return {
+            Program() {
+                const lines = commentLines(sourceCode).filter((line) => !line.sample && line.text !== '' && !isDirective(line.text));
+                for (const line of lines) {
+                    const noise = noiseOf(line, sourceCode);
+                    if (noise !== undefined) {
+                        report({ loc: line.loc, messageId: noise, data: { excerpt: line.text.slice(0, 60) } });
+                    }
+                }
+                for (const description of descriptions(lines)) {
+                    const name = declaredAfter(sourceCode, description.last);
+                    if (name === undefined || !restatesName(description.text, name)) {
+                        continue;
+                    }
+                    report({
+                        loc: description.first.loc,
+                        messageId: 'restatesName',
+                        data: { name, excerpt: description.text.slice(0, 60) },
+                    });
+                }
+            },
+        };
+    },
+});
+function noiseOf(line, sourceCode) {
+    const { text } = line;
+    if (BANNER.test(text)) {
+        return 'banner';
+    }
+    if (labelsClosingBrace(line, sourceCode)) {
+        return 'closingBrace';
+    }
+    if (JOURNAL.test(text)) {
+        return 'journal';
+    }
+    if (line.block && EMPTY_TAG.test(text)) {
+        return 'emptyTag';
+    }
+    return OWNERLESS_TODO.test(text) && !REFERENCE.test(text) ? 'ownerlessTodo' : undefined;
+}
+function labelsClosingBrace(line, sourceCode) {
+    if (!line.trailing || !CLOSING.test(line.text) || line.text.split(' ').length > 3) {
+        return false;
+    }
+    return sourceCode.getTokenBefore(line.comment)?.value === '}';
+}
+/** What is said just above a declaration: a JSDoc block without its tags, or a run of `//` lines. */
+function descriptions(lines) {
+    const found = [];
+    let run = [];
+    const close = () => {
+        const [first] = run;
+        const last = run.at(-1);
+        if (first !== undefined && last !== undefined) {
+            found.push({ text: run.map((line) => line.text).join(' '), first, last: last.comment });
+        }
+        run = [];
+    };
+    for (const line of lines.filter((candidate) => !candidate.trailing && (!candidate.block || (isJsdoc(candidate.comment) && !candidate.text.startsWith('@'))))) {
+        const previous = run.at(-1);
+        if (previous !== undefined && !belongsTogether(previous, line)) {
+            close();
+        }
+        run.push(line);
+    }
+    close();
+    return found;
+}
+function belongsTogether(previous, line) {
+    if (previous.block || line.block) {
+        return previous.comment === line.comment;
+    }
+    return line.loc.start.line === previous.loc.start.line + 1;
+}
+/** The name declared on the line that follows the comment, read from its tokens. */
+function declaredAfter(sourceCode, comment) {
+    const tokens = sourceCode.getTokensAfter(comment, { count: 8 });
+    const [first] = tokens;
+    if (first === undefined || first.loc.start.line > comment.loc.end.line + 1) {
+        return undefined;
+    }
+    const named = tokens.findIndex((token) => !MODIFIERS.has(token.value));
+    // `get()` and `static()` are methods named like a modifier: the name is the word before the parenthesis.
+    const name = tokens[named]?.value === '(' ? tokens[named - 1] : tokens[named];
+    if (name === undefined || (!NAME_TOKENS.has(name.type) && !MODIFIERS.has(name.value))) {
+        return undefined;
+    }
+    return name.type === AST_TOKEN_TYPES.PrivateIdentifier ? `#${name.value}` : name.value;
+}
+/** True when the description says nothing the name does not already say. */
+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, ...named].some((known) => sameWord(known, word)));
+}
+//# sourceMappingURL=clean-no-noise-comment.js.map

package/dist/rules/clean-no-noise-comment.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-no-noise-comment.js","sourceRoot":"","sources":["../../src/rules/clean-no-noise-comment.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAgC,MAAM,0BAA0B,CAAC;AACzF,OAAO,EAAE,YAAY,EAAoB,MAAM,sCAAsC,CAAC;AACtF,OAAO,EAAE,WAAW,EAAE,MAAM,qCAAqC,CAAC;AAClE,OAAO,EAAE,OAAO,EAAE,MAAM,iCAAiC,CAAC;AAC1D,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,QAAQ,EAAE,MAAM,+BAA+B,CAAC;AACzD,OAAO,EAAE,UAAU,EAAE,MAAM,iCAAiC,CAAC;AAI7D,MAAM,MAAM,GAAG,qDAAqD,CAAC;AAErE,MAAM,OAAO,GACX,mHAAmH,CAAC;AAEtH,MAAM,OAAO,GACX,2LAA2L,CAAC;AAE9L,MAAM,SAAS,GACb,6GAA6G,CAAC;AAEhH,MAAM,cAAc,GAAG,6BAA6B,CAAC;AACrD,MAAM,SAAS,GAAG,yCAAyC,CAAC;AAE5D,2DAA2D;AAC3D,MAAM,MAAM,GAAG;IACb,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;AAEF,MAAM,SAAS,GAAG,IAAI,GAAG,CAAC;IACxB,QAAQ;IACR,SAAS;IACT,QAAQ;IACR,SAAS;IACT,WAAW;IACX,QAAQ;IACR,UAAU;IACV,UAAU;IACV,OAAO;IACP,UAAU;IACV,SAAS;IACT,KAAK;IACL,KAAK;IACL,OAAO;IACP,KAAK;IACL,KAAK;IACL,UAAU;IACV,OAAO;IACP,WAAW;IACX,MAAM;IACN,MAAM;IACN,GAAG;CACJ,CAAC,CAAC;AAEH,MAAM,WAAW,GAAG,IAAI,GAAG,CAAS,CAAC,eAAe,CAAC,UAAU,EAAE,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC;AAErG,MAAM,OAAO,GAAG,yFAAyF,CAAC;AAE1G,MAAM,CAAC,MAAM,mBAAmB,GAAG,UAAU,CAAyB;IACpE,EAAE,EAAE,wBAAwB;IAC5B,IAAI,EAAE,YAAY;IAClB,WAAW,EAAE,MAAM;IACnB,WAAW,EACT,oHAAoH;IACtH,QAAQ,EAAE;QACR,MAAM,EACJ,wIAAwI;QAC1I,YAAY,EACV,oJAAoJ;QACtJ,OAAO,EACL,wHAAwH;QAC1H,QAAQ,EACN,2JAA2J;QAC7J,aAAa,EACX,6IAA6I;QAC/I,YAAY,EAAE,8DAA8D,OAAO,EAAE;KACtF;IACD,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE;QAC3B,OAAO;YACL,OAAO;gBACL,MAAM,KAAK,GAAG,YAAY,CAAC,UAAU,CAAC,CAAC,MAAM,CAC3C,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,IAAI,CAAC,MAAM,IAAI,IAAI,CAAC,IAAI,KAAK,EAAE,IAAI,CAAC,WAAW,CAAC,IAAI,CAAC,IAAI,CAAC,CACtE,CAAC;gBAEF,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;oBACzB,MAAM,KAAK,GAAG,OAAO,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;oBAExC,IAAI,KAAK,KAAK,SAAS,EAAE,CAAC;wBACxB,MAAM,CAAC,EAAE,GAAG,EAAE,IAAI,CAAC,GAAG,EAAE,SAAS,EAAE,KAAK,EAAE,IAAI,EAAE,EAAE,OAAO,EAAE,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE,EAAE,CAAC,CAAC;oBACzF,CAAC;gBACH,CAAC;gBAED,KAAK,MAAM,WAAW,IAAI,YAAY,CAAC,KAAK,CAAC,EAAE,CAAC;oBAC9C,MAAM,IAAI,GAAG,aAAa,CAAC,UAAU,EAAE,WAAW,CAAC,IAAI,CAAC,CAAC;oBAEzD,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,YAAY,CAAC,WAAW,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC;wBAChE,SAAS;oBACX,CAAC;oBAED,MAAM,CAAC;wBACL,GAAG,EAAE,WAAW,CAAC,KAAK,CAAC,GAAG;wBAC1B,SAAS,EAAE,cAAc;wBACzB,IAAI,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,WAAW,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,EAAE,CAAC,EAAE;qBACvD,CAAC,CAAC;gBACL,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,OAAO,CAAC,IAAiB,EAAE,UAAyC;IAC3E,MAAM,EAAE,IAAI,EAAE,GAAG,IAAI,CAAC;IAEtB,IAAI,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACtB,OAAO,QAAQ,CAAC;IAClB,CAAC;IAED,IAAI,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;QACzC,OAAO,cAAc,CAAC;IACxB,CAAC;IAED,IAAI,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACvB,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,IAAI,IAAI,CAAC,KAAK,IAAI,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,CAAC;QACvC,OAAO,UAAU,CAAC;IACpB,CAAC;IAED,OAAO,cAAc,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC,CAAC,eAAe,CAAC,CAAC,CAAC,SAAS,CAAC;AAC1F,CAAC;AAED,SAAS,kBAAkB,CAAC,IAAiB,EAAE,UAAyC;IACtF,IAAI,CAAC,IAAI,CAAC,QAAQ,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,MAAM,GAAG,CAAC,EAAE,CAAC;QAClF,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,UAAU,CAAC,cAAc,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,KAAK,KAAK,GAAG,CAAC;AAChE,CAAC;AAQD,qGAAqG;AACrG,SAAS,YAAY,CAAC,KAA6B;IACjD,MAAM,KAAK,GAAkB,EAAE,CAAC;IAChC,IAAI,GAAG,GAAkB,EAAE,CAAC;IAE5B,MAAM,KAAK,GAAG,GAAS,EAAE;QACvB,MAAM,CAAC,KAAK,CAAC,GAAG,GAAG,CAAC;QACpB,MAAM,IAAI,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAExB,IAAI,KAAK,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YAC9C,KAAK,CAAC,IAAI,CAAC,EAAE,IAAI,EAAE,GAAG,CAAC,GAAG,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,IAAI,CAAC,GAAG,CAAC,EAAE,KAAK,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,CAAC,CAAC;QAC1F,CAAC;QAED,GAAG,GAAG,EAAE,CAAC;IACX,CAAC,CAAC;IAEF,KAAK,MAAM,IAAI,IAAI,KAAK,CAAC,MAAM,CAC7B,CAAC,SAAS,EAAE,EAAE,CACZ,CAAC,SAAS,CAAC,QAAQ,IAAI,CAAC,CAAC,SAAS,CAAC,KAAK,IAAI,CAAC,OAAO,CAAC,SAAS,CAAC,OAAO,CAAC,IAAI,CAAC,SAAS,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,CAAC,CAAC,CAAC,CAC/G,EAAE,CAAC;QACF,MAAM,QAAQ,GAAG,GAAG,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;QAE5B,IAAI,QAAQ,KAAK,SAAS,IAAI,CAAC,eAAe,CAAC,QAAQ,EAAE,IAAI,CAAC,EAAE,CAAC;YAC/D,KAAK,EAAE,CAAC;QACV,CAAC;QAED,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IACjB,CAAC;IAED,KAAK,EAAE,CAAC;IAER,OAAO,KAAK,CAAC;AACf,CAAC;AAED,SAAS,eAAe,CAAC,QAAqB,EAAE,IAAiB;IAC/D,IAAI,QAAQ,CAAC,KAAK,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC;QACjC,OAAO,QAAQ,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,CAAC;IAC3C,CAAC;IAED,OAAO,IAAI,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,KAAK,QAAQ,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,CAAC,CAAC;AAC7D,CAAC;AAED,oFAAoF;AACpF,SAAS,aAAa,CAAC,UAAyC,EAAE,OAAyB;IACzF,MAAM,MAAM,GAAG,UAAU,CAAC,cAAc,CAAC,OAAO,EAAE,EAAE,KAAK,EAAE,CAAC,EAAE,CAAC,CAAC;IAChE,MAAM,CAAC,KAAK,CAAC,GAAG,MAAM,CAAC;IAEvB,IAAI,KAAK,KAAK,SAAS,IAAI,KAAK,CAAC,GAAG,CAAC,KAAK,CAAC,IAAI,GAAG,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,IAAI,GAAG,CAAC,EAAE,CAAC;QAC3E,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,MAAM,KAAK,GAAG,MAAM,CAAC,SAAS,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,CAAC,SAAS,CAAC,GAAG,CAAC,KAAK,CAAC,KAAK,CAAC,CAAC,CAAC;IACvE,yGAAyG;IACzG,MAAM,IAAI,GAAG,MAAM,CAAC,KAAK,CAAC,EAAE,KAAK,KAAK,GAAG,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,GAAG,CAAC,CAAC,CAAC,CAAC,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;IAE9E,IAAI,IAAI,KAAK,SAAS,IAAI,CAAC,CAAC,WAAW,CAAC,GAAG,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,SAAS,CAAC,GAAG,CAAC,IAAI,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC;QACtF,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,KAAK,eAAe,CAAC,iBAAiB,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC,KAAK,CAAC;AACzF,CAAC;AAED,4EAA4E;AAC5E,SAAS,YAAY,CAAC,WAAmB,EAAE,IAAY;IACrD,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,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,CAAC,GAAG,MAAM,EAAE,GAAG,KAAK,CAAC,CAAC,IAAI,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,QAAQ,CAAC,KAAK,EAAE,IAAI,CAAC,CAAC,CAAC,CAAC;AAC5F,CAAC"}

package/dist/rules/clean-one-export-per-file.d.ts

@@ -0,0 +1,10 @@
+import type { AllowedFile } from '../project/config.js';
+interface Options {
+    /** Files whose several exports are one thing, each with the sentence that says why; added to `onePerFile.allow` of the config. */
+    readonly allow?: readonly AllowedFile[];
+    /** Globs of the entry files besides every `index.ts`: the subpath entries of a package. */
+    readonly entries?: readonly string[];
+}
+export declare const cleanOneExportPerFile: import("@typescript-eslint/utils/ts-eslint").RuleModule<"entry" | "fileName" | "several", [Options], import("../index.js").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export {};
+//# sourceMappingURL=clean-one-export-per-file.d.ts.map

package/dist/rules/clean-one-export-per-file.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-one-export-per-file.d.ts","sourceRoot":"","sources":["../../src/rules/clean-one-export-per-file.ts"],"names":[],"mappings":"AAGA,OAAO,KAAK,EAAE,WAAW,EAAE,MAAM,sBAAsB,CAAC;AAWxD,UAAU,OAAO;IACf,kIAAkI;IAClI,QAAQ,CAAC,KAAK,CAAC,EAAE,SAAS,WAAW,EAAE,CAAC;IACxC,2FAA2F;IAC3F,QAAQ,CAAC,OAAO,CAAC,EAAE,SAAS,MAAM,EAAE,CAAC;CACtC;AAKD,eAAO,MAAM,qBAAqB,iMAqEhC,CAAC"}

package/dist/rules/clean-one-export-per-file.js

@@ -0,0 +1,124 @@
+import path from 'node:path';
+import { AST_NODE_TYPES } from '@typescript-eslint/utils';
+import { parseAllowedFile } from '../project/parse-allowed-file.js';
+import { defineRule } from '../support/rule/define-rule.js';
+import { explainExports } from '../support/exports/explain-exports.js';
+import { isNamedAfter } from '../support/exports/is-named-after.js';
+import { moduleShapeOf } from '../support/exports/module-shape-of.js';
+import { globMatcher } from '../support/glob-matcher.js';
+import { kebabCase } from '../support/kebab-case.js';
+const SOURCE = /\.(?:ts|mts|cts)$/;
+const TEST = /\.(?:spec|test)\.[cm]?ts$/;
+export const cleanOneExportPerFile = defineRule({
+    id: 'clean/one-export-per-file',
+    type: 'suggestion',
+    recommended: 'error',
+    description: 'A source file exports one class, interface or function, with the types of its own signature, and is named after it; an entry file only re-exports.',
+    messages: {
+        several: 'This file exports {{count}} classes, interfaces or functions ({{names}}) that are not one thing. Keep one per file, named after it in kebab-case, with the types of its own signature; move each other one to its own file. Exports that really are one thing (a closed family) are declared in `onePerFile.allow` of ddd-ts-kit.config.json with the reason.',
+        fileName: 'This file exports {{exported}} but is named {{file}}. Name it {{expected}}: a file is named after its export in kebab-case (in a role file `<name>.<role>.ts`, after the name before the role).',
+        entry: 'An entry file only re-exports: this statement declares or exports something of its own. Move it to a file named after what it declares and write `export { .. } from` here.',
+    },
+    schema: [
+        {
+            type: 'object',
+            additionalProperties: false,
+            properties: {
+                allow: {
+                    type: 'array',
+                    items: {
+                        type: 'object',
+                        additionalProperties: false,
+                        required: ['file', 'reason'],
+                        properties: { file: { type: 'string' }, reason: { type: 'string' } },
+                    },
+                },
+                entries: { type: 'array', items: { type: 'string' }, uniqueItems: true },
+            },
+        },
+    ],
+    defaultOptions: [{}],
+    create({ file, sourceCode, options: [options], report }) {
+        if (!isJudged(file)) {
+            return {};
+        }
+        const isEntry = isEntryFile(file, options);
+        const allowed = isAllowed(file, options);
+        const judgeEntry = (program) => {
+            for (const statement of program.body.filter((candidate) => !isReExport(candidate))) {
+                report({ node: statement, messageId: 'entry' });
+            }
+        };
+        const judgeSource = (program) => {
+            const shape = moduleShapeOf(program);
+            const explanation = explainExports(shape, sourceCode);
+            const finding = explanation !== undefined || allowed ? misnamed(file, explanation?.mains ?? shape.counted) : undefined;
+            if (explanation === undefined && !allowed) {
+                report({
+                    node: nodeOf(shape, shape.counted[1]),
+                    messageId: 'several',
+                    data: { count: shape.counted.length, names: shape.counted.join(', ') },
+                });
+            }
+            if (finding !== undefined) {
+                report({ node: nodeOf(shape, finding.main), messageId: 'fileName', data: finding.data });
+            }
+        };
+        return { Program: isEntry ? judgeEntry : judgeSource };
+    },
+});
+function isEntryFile(file, options) {
+    return (isIndex(file) ||
+        globMatcher([`${file.config.contextsDir}/*/*.declarations.ts`, ...(options.entries ?? [])])(file.path));
+}
+function isIndex(file) {
+    return /^index\.[cm]?ts$/.test(path.posix.basename(file.path));
+}
+function isAllowed(file, options) {
+    return globMatcher([...file.config.onePerFile.allow, ...(options.allow ?? []).flatMap(parseAllowedFile)].map((entry) => entry.file))(file.path);
+}
+/** The file carries the name of none of the exports it may be named after. A family that no export names is named freely. */
+function misnamed(file, mains) {
+    const base = path.posix.basename(file.path);
+    const stem = base.replace(SOURCE, '');
+    const [main] = mains === 'free' ? [] : mains;
+    if (mains === 'free' || main === undefined || main === 'default' || mains.some((name) => isNamedAfter(stem, name))) {
+        return undefined;
+    }
+    return { main, data: { exported: mains.join(' or '), file: base, expected: `${expectedStem(stem, main)}.ts` } };
+}
+/** A source under the source root; in a workspace, under the directory of that name of a package. Never a test, never a declaration file. */
+function isJudged(file) {
+    const segments = file.path.split('/');
+    const sourceDirectory = file.config.sourceRoot.split('/').at(-1) ?? 'src';
+    if (!SOURCE.test(file.path) ||
+        /\.d\.[cm]?ts$/.test(file.path) ||
+        file.isTest ||
+        TEST.test(file.path) ||
+        segments.includes('test')) {
+        return false;
+    }
+    return file.path.startsWith(`${file.config.sourceRoot}/`) || segments.slice(0, -1).includes(sourceDirectory);
+}
+/** `export .. from`, `export * from`, and what declares nothing: an import for its effect, the empty `export {}` of a module without export yet. */
+function isReExport(statement) {
+    if (statement.type === AST_NODE_TYPES.ImportDeclaration) {
+        return statement.specifiers.length === 0;
+    }
+    if (statement.type !== AST_NODE_TYPES.ExportNamedDeclaration) {
+        return statement.type === AST_NODE_TYPES.ExportAllDeclaration;
+    }
+    return statement.source !== null || (statement.declaration === null && statement.specifiers.length === 0);
+}
+function nodeOf(shape, name) {
+    const declared = shape.exports.find((declaration) => declaration.name === name)?.node ?? shape.program;
+    return 'id' in declared && declared.id !== null ? declared.id : declared;
+}
+/** The name to give the file: the role suffix of a role file is kept. */
+function expectedStem(stem, main) {
+    const [, ...roles] = stem.split('.');
+    const role = roles.at(-1);
+    const name = kebabCase(main);
+    return role !== undefined && !name.endsWith(`-${role}`) ? `${name}.${role}` : name;
+}
+//# sourceMappingURL=clean-one-export-per-file.js.map

package/dist/rules/clean-one-export-per-file.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-one-export-per-file.js","sourceRoot":"","sources":["../../src/rules/clean-one-export-per-file.ts"],"names":[],"mappings":"AAAA,OAAO,IAAI,MAAM,WAAW,CAAC;AAC7B,OAAO,EAAE,cAAc,EAAiB,MAAM,0BAA0B,CAAC;AACzE,OAAO,EAAE,gBAAgB,EAAE,MAAM,kCAAkC,CAAC;AAGpE,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AAEvE,OAAO,EAAE,YAAY,EAAE,MAAM,sCAAsC,CAAC;AACpE,OAAO,EAAE,aAAa,EAAE,MAAM,uCAAuC,CAAC;AAEtE,OAAO,EAAE,WAAW,EAAE,MAAM,4BAA4B,CAAC;AACzD,OAAO,EAAE,SAAS,EAAE,MAAM,0BAA0B,CAAC;AASrD,MAAM,MAAM,GAAG,mBAAmB,CAAC;AACnC,MAAM,IAAI,GAAG,2BAA2B,CAAC;AAEzC,MAAM,CAAC,MAAM,qBAAqB,GAAG,UAAU,CAA8C;IAC3F,EAAE,EAAE,2BAA2B;IAC/B,IAAI,EAAE,YAAY;IAClB,WAAW,EAAE,OAAO;IACpB,WAAW,EACT,oJAAoJ;IACtJ,QAAQ,EAAE;QACR,OAAO,EACL,+VAA+V;QACjW,QAAQ,EACN,iMAAiM;QACnM,KAAK,EACH,6KAA6K;KAChL;IACD,MAAM,EAAE;QACN;YACE,IAAI,EAAE,QAAQ;YACd,oBAAoB,EAAE,KAAK;YAC3B,UAAU,EAAE;gBACV,KAAK,EAAE;oBACL,IAAI,EAAE,OAAO;oBACb,KAAK,EAAE;wBACL,IAAI,EAAE,QAAQ;wBACd,oBAAoB,EAAE,KAAK;wBAC3B,QAAQ,EAAE,CAAC,MAAM,EAAE,QAAQ,CAAC;wBAC5B,UAAU,EAAE,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,MAAM,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;qBACrE;iBACF;gBACD,OAAO,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE,WAAW,EAAE,IAAI,EAAE;aACzE;SACF;KACF;IACD,cAAc,EAAE,CAAC,EAAE,CAAC;IACpB,MAAM,CAAC,EAAE,IAAI,EAAE,UAAU,EAAE,OAAO,EAAE,CAAC,OAAO,CAAC,EAAE,MAAM,EAAE;QACrD,IAAI,CAAC,QAAQ,CAAC,IAAI,CAAC,EAAE,CAAC;YACpB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAG,WAAW,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAC3C,MAAM,OAAO,GAAG,SAAS,CAAC,IAAI,EAAE,OAAO,CAAC,CAAC;QAEzC,MAAM,UAAU,GAAG,CAAC,OAAyB,EAAQ,EAAE;YACrD,KAAK,MAAM,SAAS,IAAI,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC,SAAS,EAAE,EAAE,CAAC,CAAC,UAAU,CAAC,SAAS,CAAC,CAAC,EAAE,CAAC;gBACnF,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,SAAS,EAAE,OAAO,EAAE,CAAC,CAAC;YAClD,CAAC;QACH,CAAC,CAAC;QAEF,MAAM,WAAW,GAAG,CAAC,OAAyB,EAAQ,EAAE;YACtD,MAAM,KAAK,GAAG,aAAa,CAAC,OAAO,CAAC,CAAC;YACrC,MAAM,WAAW,GAAG,cAAc,CAAC,KAAK,EAAE,UAAU,CAAC,CAAC;YAEtD,MAAM,OAAO,GACX,WAAW,KAAK,SAAS,IAAI,OAAO,CAAC,CAAC,CAAC,QAAQ,CAAC,IAAI,EAAE,WAAW,EAAE,KAAK,IAAI,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC,SAAS,CAAC;YAEzG,IAAI,WAAW,KAAK,SAAS,IAAI,CAAC,OAAO,EAAE,CAAC;gBAC1C,MAAM,CAAC;oBACL,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,CAAC,CAAC,CAAC;oBACrC,SAAS,EAAE,SAAS;oBACpB,IAAI,EAAE,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,MAAM,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE;iBACvE,CAAC,CAAC;YACL,CAAC;YAED,IAAI,OAAO,KAAK,SAAS,EAAE,CAAC;gBAC1B,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,KAAK,EAAE,OAAO,CAAC,IAAI,CAAC,EAAE,SAAS,EAAE,UAAU,EAAE,IAAI,EAAE,OAAO,CAAC,IAAI,EAAE,CAAC,CAAC;YAC3F,CAAC;QACH,CAAC,CAAC;QAEF,OAAO,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC,CAAC,UAAU,CAAC,CAAC,CAAC,WAAW,EAAE,CAAC;IACzD,CAAC;CACF,CAAC,CAAC;AAEH,SAAS,WAAW,CAAC,IAAgB,EAAE,OAAgB;IACrD,OAAO,CACL,OAAO,CAAC,IAAI,CAAC;QACb,WAAW,CAAC,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,WAAW,sBAAsB,EAAE,GAAG,CAAC,OAAO,CAAC,OAAO,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CACvG,CAAC;AACJ,CAAC;AAED,SAAS,OAAO,CAAC,IAAgB;IAC/B,OAAO,kBAAkB,CAAC,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;AACjE,CAAC;AAED,SAAS,SAAS,CAAC,IAAgB,EAAE,OAAgB;IACnD,OAAO,WAAW,CAChB,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,EAAE,GAAG,CAAC,OAAO,CAAC,KAAK,IAAI,EAAE,CAAC,CAAC,OAAO,CAAC,gBAAgB,CAAC,CAAC,CAAC,GAAG,CAAC,CAAC,KAAK,EAAE,EAAE,CAAC,KAAK,CAAC,IAAI,CAAC,CACjH,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;AACf,CAAC;AAOD,6HAA6H;AAC7H,SAAS,QAAQ,CAAC,IAAgB,EAAE,KAAiC;IACnE,MAAM,IAAI,GAAG,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC;IAC5C,MAAM,IAAI,GAAG,IAAI,CAAC,OAAO,CAAC,MAAM,EAAE,EAAE,CAAC,CAAC;IACtC,MAAM,CAAC,IAAI,CAAC,GAAG,KAAK,KAAK,MAAM,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,KAAK,CAAC;IAE7C,IAAI,KAAK,KAAK,MAAM,IAAI,IAAI,KAAK,SAAS,IAAI,IAAI,KAAK,SAAS,IAAI,KAAK,CAAC,IAAI,CAAC,CAAC,IAAI,EAAE,EAAE,CAAC,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,CAAC,EAAE,CAAC;QACnH,OAAO,SAAS,CAAC;IACnB,CAAC;IAED,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,EAAE,QAAQ,EAAE,KAAK,CAAC,IAAI,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,EAAE,QAAQ,EAAE,GAAG,YAAY,CAAC,IAAI,EAAE,IAAI,CAAC,KAAK,EAAE,EAAE,CAAC;AAClH,CAAC;AAED,6IAA6I;AAC7I,SAAS,QAAQ,CAAC,IAAgB;IAChC,MAAM,QAAQ,GAAG,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACtC,MAAM,eAAe,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,IAAI,KAAK,CAAC;IAE1E,IACE,CAAC,MAAM,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACvB,eAAe,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QAC/B,IAAI,CAAC,MAAM;QACX,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC,IAAI,CAAC;QACpB,QAAQ,CAAC,QAAQ,CAAC,MAAM,CAAC,EACzB,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAED,OAAO,IAAI,CAAC,IAAI,CAAC,UAAU,CAAC,GAAG,IAAI,CAAC,MAAM,CAAC,UAAU,GAAG,CAAC,IAAI,QAAQ,CAAC,KAAK,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,QAAQ,CAAC,eAAe,CAAC,CAAC;AAC/G,CAAC;AAED,oJAAoJ;AACpJ,SAAS,UAAU,CAAC,SAAoC;IACtD,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,iBAAiB,EAAE,CAAC;QACxD,OAAO,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC;IAC3C,CAAC;IAED,IAAI,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,sBAAsB,EAAE,CAAC;QAC7D,OAAO,SAAS,CAAC,IAAI,KAAK,cAAc,CAAC,oBAAoB,CAAC;IAChE,CAAC;IAED,OAAO,SAAS,CAAC,MAAM,KAAK,IAAI,IAAI,CAAC,SAAS,CAAC,WAAW,KAAK,IAAI,IAAI,SAAS,CAAC,UAAU,CAAC,MAAM,KAAK,CAAC,CAAC,CAAC;AAC5G,CAAC;AAED,SAAS,MAAM,CAAC,KAAkB,EAAE,IAAwB;IAC1D,MAAM,QAAQ,GAAG,KAAK,CAAC,OAAO,CAAC,IAAI,CAAC,CAAC,WAAW,EAAE,EAAE,CAAC,WAAW,CAAC,IAAI,KAAK,IAAI,CAAC,EAAE,IAAI,IAAI,KAAK,CAAC,OAAO,CAAC;IAEvG,OAAO,IAAI,IAAI,QAAQ,IAAI,QAAQ,CAAC,EAAE,KAAK,IAAI,CAAC,CAAC,CAAC,QAAQ,CAAC,EAAE,CAAC,CAAC,CAAC,QAAQ,CAAC;AAC3E,CAAC;AAED,yEAAyE;AACzE,SAAS,YAAY,CAAC,IAAY,EAAE,IAAY;IAC9C,MAAM,CAAC,EAAE,GAAG,KAAK,CAAC,GAAG,IAAI,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;IACrC,MAAM,IAAI,GAAG,KAAK,CAAC,EAAE,CAAC,CAAC,CAAC,CAAC,CAAC;IAC1B,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;IAE7B,OAAO,IAAI,KAAK,SAAS,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,CAAC,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC,CAAC,CAAC,IAAI,CAAC;AACrF,CAAC"}

package/dist/rules/clean-stepdown.d.ts

@@ -0,0 +1,3 @@
+import { type ClassMessageId } from '../support/stepdown/misplaced-members.js';
+export declare const cleanStepdown: import("@typescript-eslint/utils/ts-eslint").RuleModule<"functionAboveCaller" | ClassMessageId, [], import("../index.js").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=clean-stepdown.d.ts.map

package/dist/rules/clean-stepdown.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-stepdown.d.ts","sourceRoot":"","sources":["../../src/rules/clean-stepdown.ts"],"names":[],"mappings":"AAEA,OAAO,EAAoB,KAAK,cAAc,EAAE,MAAM,0CAA0C,CAAC;AAGjG,eAAO,MAAM,aAAa,gMAiCxB,CAAC"}

package/dist/rules/clean-stepdown.js

@@ -0,0 +1,33 @@
+import { defineRule } from '../support/rule/define-rule.js';
+import { MemberUses } from '../support/stepdown/member-uses.js';
+import { misplacedMembers } from '../support/stepdown/misplaced-members.js';
+import { misplacedFunctions } from '../support/stepdown/misplaced-functions.js';
+export const cleanStepdown = defineRule({
+    id: 'clean/stepdown',
+    type: 'suggestion',
+    recommended: 'error',
+    description: 'A file reads top to bottom: static factories, public members, then private ones, and a function above the functions it calls.',
+    messages: {
+        nonPublicBeforePublic: 'The {{visibility}} member {{name}} of {{className}} is declared before the public member {{publicName}}. Move {{name}} below the public members, after its first caller: a reader meets what the class does before how.',
+        staticAfterInstance: 'The static method {{name}} of {{className}} is declared after the instance method {{instanceName}}. Move the static factories to the top of the class, above the instance methods.',
+        memberAboveCaller: 'The private member {{name}} of {{className}} is declared above its first caller (line {{line}}). Move {{name}} just below the member that first calls it.',
+        functionAboveCaller: 'The function {{name}} is declared above its first caller (line {{line}}). Move {{name}} below the function that first calls it, so that the file reads from intention to detail.',
+    },
+    create({ sourceCode, report }) {
+        const uses = new MemberUses();
+        return {
+            MemberExpression: (node) => uses.record(node),
+            'ClassBody:exit'(node) {
+                for (const finding of misplacedMembers(node, uses.of(node))) {
+                    report(finding);
+                }
+            },
+            'Program:exit'(node) {
+                for (const finding of misplacedFunctions(node, sourceCode)) {
+                    report({ ...finding, messageId: 'functionAboveCaller' });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=clean-stepdown.js.map

package/dist/rules/clean-stepdown.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"clean-stepdown.js","sourceRoot":"","sources":["../../src/rules/clean-stepdown.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,UAAU,EAAE,MAAM,oCAAoC,CAAC;AAChE,OAAO,EAAE,gBAAgB,EAAuB,MAAM,0CAA0C,CAAC;AACjG,OAAO,EAAE,kBAAkB,EAAE,MAAM,4CAA4C,CAAC;AAEhF,MAAM,CAAC,MAAM,aAAa,GAAG,UAAU,CAAyC;IAC9E,EAAE,EAAE,gBAAgB;IACpB,IAAI,EAAE,YAAY;IAClB,WAAW,EAAE,OAAO;IACpB,WAAW,EACT,+HAA+H;IACjI,QAAQ,EAAE;QACR,qBAAqB,EACnB,yNAAyN;QAC3N,mBAAmB,EACjB,oLAAoL;QACtL,iBAAiB,EACf,2JAA2J;QAC7J,mBAAmB,EACjB,kLAAkL;KACrL;IACD,MAAM,CAAC,EAAE,UAAU,EAAE,MAAM,EAAE;QAC3B,MAAM,IAAI,GAAG,IAAI,UAAU,EAAE,CAAC;QAE9B,OAAO;YACL,gBAAgB,EAAE,CAAC,IAAI,EAAE,EAAE,CAAC,IAAI,CAAC,MAAM,CAAC,IAAI,CAAC;YAC7C,gBAAgB,CAAC,IAAI;gBACnB,KAAK,MAAM,OAAO,IAAI,gBAAgB,CAAC,IAAI,EAAE,IAAI,CAAC,EAAE,CAAC,IAAI,CAAC,CAAC,EAAE,CAAC;oBAC5D,MAAM,CAAC,OAAO,CAAC,CAAC;gBAClB,CAAC;YACH,CAAC;YACD,cAAc,CAAC,IAAI;gBACjB,KAAK,MAAM,OAAO,IAAI,kBAAkB,CAAC,IAAI,EAAE,UAAU,CAAC,EAAE,CAAC;oBAC3D,MAAM,CAAC,EAAE,GAAG,OAAO,EAAE,SAAS,EAAE,qBAAqB,EAAE,CAAC,CAAC;gBAC3D,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/dist/rules/context-boundaries.d.ts

@@ -0,0 +1,4 @@
+export declare const contextPublishedLanguageOnly: import("@typescript-eslint/utils/ts-eslint").RuleModule<"internals", [], import("../index.js").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export declare const contextDeclaredRelationship: import("@typescript-eslint/utils/ts-eslint").RuleModule<"undeclared", [], import("../index.js").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+export declare const contextPublishedLanguageIsAContract: import("@typescript-eslint/utils/ts-eslint").RuleModule<"leak", [], import("../index.js").RuleDocs, import("@typescript-eslint/utils/ts-eslint").RuleListener>;
+//# sourceMappingURL=context-boundaries.d.ts.map

package/dist/rules/context-boundaries.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-boundaries.d.ts","sourceRoot":"","sources":["../../src/rules/context-boundaries.ts"],"names":[],"mappings":"AAMA,eAAO,MAAM,4BAA4B,qKAkCvC,CAAC;AAEH,eAAO,MAAM,2BAA2B,sKAiCtC,CAAC;AAEH,eAAO,MAAM,mCAAmC,gKAgC9C,CAAC"}

package/dist/rules/context-boundaries.js

@@ -0,0 +1,87 @@
+import { defineRule } from '../support/rule/define-rule.js';
+import { describeTarget } from '../support/imports/describe-target.js';
+import { importListener } from '../support/imports/import-listener.js';
+import { inContext } from '../support/imports/in-context.js';
+import { inLayer } from '../support/imports/in-layer.js';
+export const contextPublishedLanguageOnly = defineRule({
+    id: 'context/published-language-only',
+    type: 'problem',
+    recommended: 'error',
+    description: "A file imports from another context only through that context's published-language/.",
+    messages: {
+        internals: '"{{here}}" imports the internals of "{{there}}" ({{path}}). Import from {{contextsDir}}/{{there}}/published-language only; if the type is missing there, publish it with `ddd-ts-kit generate integration-event {{there}} <Aggregate> <Fact>` or react to an integration event.',
+    },
+    create({ file, report }) {
+        const here = inContext(file);
+        if (here === undefined) {
+            return {};
+        }
+        return importListener(file, ({ node, target }) => {
+            if (target.kind !== 'file' || target.location.area !== 'context') {
+                return;
+            }
+            const there = target.location;
+            if (there.context === here.context || there.layer === 'published-language') {
+                return;
+            }
+            report({
+                node,
+                messageId: 'internals',
+                data: { here: here.context, there: there.context, path: target.path, contextsDir: file.config.contextsDir },
+            });
+        });
+    },
+});
+export const contextDeclaredRelationship = defineRule({
+    id: 'context/declared-relationship',
+    type: 'problem',
+    recommended: 'error',
+    description: 'Importing the published language of another context requires the relationship to be declared in the config.',
+    messages: {
+        undeclared: '"{{here}}" depends on "{{there}}" but the relationship is not declared. Add { "context": "{{there}}", "relationship": "published-language" } to contexts.{{here}}.upstreams in ddd-ts-kit.config.json, after checking that the dependency direction is intended.',
+    },
+    create({ file, report }) {
+        const here = inContext(file);
+        if (here === undefined) {
+            return {};
+        }
+        const upstreams = file.config.contexts[here.context]?.upstreams.map((upstream) => upstream.context) ?? [];
+        return importListener(file, ({ node, target }) => {
+            if (target.kind !== 'file' || target.location.area !== 'context') {
+                return;
+            }
+            const there = target.location;
+            if (there.context === here.context || there.layer !== 'published-language' || upstreams.includes(there.context)) {
+                return;
+            }
+            report({ node, messageId: 'undeclared', data: { here: here.context, there: there.context } });
+        });
+    },
+});
+export const contextPublishedLanguageIsAContract = defineRule({
+    id: 'context/published-language-is-a-contract',
+    type: 'problem',
+    recommended: 'error',
+    description: 'published-language/ imports only the kernel, the event declaration helper with the schema library of the project, and other published languages.',
+    messages: {
+        leak: 'The published language imports {{target}}. Declare the contract with plain serializable types written in this folder: copy the few fields other contexts need instead of exposing an internal model.',
+    },
+    create({ file, report }) {
+        if (inLayer(file, 'published-language') === undefined) {
+            return {};
+        }
+        const allowed = file.config.publishedLanguageAllowedPackages;
+        return importListener(file, ({ node, target }) => {
+            if (target.kind === 'package' && allowed.includes(target.name)) {
+                return;
+            }
+            if (target.kind === 'file' &&
+                target.location.area === 'context' &&
+                target.location.layer === 'published-language') {
+                return;
+            }
+            report({ node, messageId: 'leak', data: { target: describeTarget(target) } });
+        });
+    },
+});
+//# sourceMappingURL=context-boundaries.js.map

package/dist/rules/context-boundaries.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-boundaries.js","sourceRoot":"","sources":["../../src/rules/context-boundaries.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,UAAU,EAAE,MAAM,gCAAgC,CAAC;AAC5D,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,cAAc,EAAE,MAAM,uCAAuC,CAAC;AACvE,OAAO,EAAE,SAAS,EAAE,MAAM,kCAAkC,CAAC;AAC7D,OAAO,EAAE,OAAO,EAAE,MAAM,gCAAgC,CAAC;AAEzD,MAAM,CAAC,MAAM,4BAA4B,GAAG,UAAU,CAAc;IAClE,EAAE,EAAE,iCAAiC;IACrC,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,OAAO;IACpB,WAAW,EAAE,sFAAsF;IACnG,QAAQ,EAAE;QACR,SAAS,EACP,iRAAiR;KACpR;IACD,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;QACrB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACjE,OAAO;YACT,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC;YAE9B,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,KAAK,oBAAoB,EAAE,CAAC;gBAC3E,OAAO;YACT,CAAC;YAED,MAAM,CAAC;gBACL,IAAI;gBACJ,SAAS,EAAE,WAAW;gBACtB,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,IAAI,EAAE,MAAM,CAAC,IAAI,EAAE,WAAW,EAAE,IAAI,CAAC,MAAM,CAAC,WAAW,EAAE;aAC5G,CAAC,CAAC;QACL,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,2BAA2B,GAAG,UAAU,CAAe;IAClE,EAAE,EAAE,+BAA+B;IACnC,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,OAAO;IACpB,WAAW,EACT,6GAA6G;IAC/G,QAAQ,EAAE;QACR,UAAU,EACR,kQAAkQ;KACrQ;IACD,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;QACrB,MAAM,IAAI,GAAG,SAAS,CAAC,IAAI,CAAC,CAAC;QAE7B,IAAI,IAAI,KAAK,SAAS,EAAE,CAAC;YACvB,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,SAAS,GAAG,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,SAAS,CAAC,GAAG,CAAC,CAAC,QAAQ,EAAE,EAAE,CAAC,QAAQ,CAAC,OAAO,CAAC,IAAI,EAAE,CAAC;QAE1G,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,MAAM,IAAI,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS,EAAE,CAAC;gBACjE,OAAO;YACT,CAAC;YAED,MAAM,KAAK,GAAG,MAAM,CAAC,QAAQ,CAAC;YAE9B,IAAI,KAAK,CAAC,OAAO,KAAK,IAAI,CAAC,OAAO,IAAI,KAAK,CAAC,KAAK,KAAK,oBAAoB,IAAI,SAAS,CAAC,QAAQ,CAAC,KAAK,CAAC,OAAO,CAAC,EAAE,CAAC;gBAChH,OAAO;YACT,CAAC;YAED,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,YAAY,EAAE,IAAI,EAAE,EAAE,IAAI,EAAE,IAAI,CAAC,OAAO,EAAE,KAAK,EAAE,KAAK,CAAC,OAAO,EAAE,EAAE,CAAC,CAAC;QAChG,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC;AAEH,MAAM,CAAC,MAAM,mCAAmC,GAAG,UAAU,CAAS;IACpE,EAAE,EAAE,0CAA0C;IAC9C,IAAI,EAAE,SAAS;IACf,WAAW,EAAE,OAAO;IACpB,WAAW,EACT,kJAAkJ;IACpJ,QAAQ,EAAE;QACR,IAAI,EAAE,sMAAsM;KAC7M;IACD,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE;QACrB,IAAI,OAAO,CAAC,IAAI,EAAE,oBAAoB,CAAC,KAAK,SAAS,EAAE,CAAC;YACtD,OAAO,EAAE,CAAC;QACZ,CAAC;QAED,MAAM,OAAO,GAAG,IAAI,CAAC,MAAM,CAAC,gCAAgC,CAAC;QAE7D,OAAO,cAAc,CAAC,IAAI,EAAE,CAAC,EAAE,IAAI,EAAE,MAAM,EAAE,EAAE,EAAE;YAC/C,IAAI,MAAM,CAAC,IAAI,KAAK,SAAS,IAAI,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAC,IAAI,CAAC,EAAE,CAAC;gBAC/D,OAAO;YACT,CAAC;YAED,IACE,MAAM,CAAC,IAAI,KAAK,MAAM;gBACtB,MAAM,CAAC,QAAQ,CAAC,IAAI,KAAK,SAAS;gBAClC,MAAM,CAAC,QAAQ,CAAC,KAAK,KAAK,oBAAoB,EAC9C,CAAC;gBACD,OAAO;YACT,CAAC;YAED,MAAM,CAAC,EAAE,IAAI,EAAE,SAAS,EAAE,MAAM,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,cAAc,CAAC,MAAM,CAAC,EAAE,EAAE,CAAC,CAAC;QAChF,CAAC,CAAC,CAAC;IACL,CAAC;CACF,CAAC,CAAC"}

package/dist/rules/context-extractable.d.ts

@@ -0,0 +1,5 @@
+import { TSESLint } from '@typescript-eslint/utils';
+type MessageId = 'foreignSchema' | 'foreignTable' | 'mutableBinding' | 'mutableState' | 'foreignWiring' | 'foreignPort';
+export declare const contextExtractable: TSESLint.RuleModule<MessageId, [], import("../index.js").RuleDocs, TSESLint.RuleListener>;
+export {};
+//# sourceMappingURL=context-extractable.d.ts.map

package/dist/rules/context-extractable.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context-extractable.d.ts","sourceRoot":"","sources":["../../src/rules/context-extractable.ts"],"names":[],"mappings":"AAAA,OAAO,EAA4B,QAAQ,EAAiB,MAAM,0BAA0B,CAAC;AAa7F,KAAK,SAAS,GAAG,eAAe,GAAG,cAAc,GAAG,gBAAgB,GAAG,cAAc,GAAG,eAAe,GAAG,aAAa,CAAC;AAiDxH,eAAO,MAAM,kBAAkB,2FA8B7B,CAAC"}