@pjts/eslint-style-rules 0.0.0-stage → 0.0.3

package/dist/rules/trackable-repository.js

@@ -0,0 +1,97 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const tslib_1 = require("tslib");
+const fs_1 = tslib_1.__importDefault(require("fs"));
+const path_1 = tslib_1.__importDefault(require("path"));
+const rule_1 = require("../lib/rule");
+const ast_1 = require("../lib/ast");
+/** Resolved file → does it declare `class <name> … extends <base>` (per lint run). */
+const eventSourcedCache = new Map();
+const resolveSource = (fromFile, source) => {
+    if (!source.startsWith('.'))
+        return null;
+    const base = path_1.default.resolve(path_1.default.dirname(fromFile), source);
+    for (const candidate of [`${base}.ts`, path_1.default.join(base, 'index.ts')])
+        if (fs_1.default.existsSync(candidate))
+            return candidate;
+    return null;
+};
+/** Follows one level of `export … from './X'` re-exports (module barrels). */
+const declaresEventSourced = (file, name, base, depth = 0) => {
+    const key = `${file}#${name}`;
+    if (eventSourcedCache.has(key))
+        return eventSourcedCache.get(key);
+    const source = fs_1.default.readFileSync(file, 'utf8');
+    let result = new RegExp(`class\\s+${name}\\b[^{]*\\bextends\\s+${base}\\b`).test(source);
+    if (!result && depth < 2) {
+        for (const match of source.matchAll(/export\s+(?:\{[^}]*\}|\*)\s+from\s+'([^']+)'/g)) {
+            const target = resolveSource(file, match[1]);
+            if (target && declaresEventSourced(target, name, base, depth + 1)) {
+                result = true;
+                break;
+            }
+        }
+    }
+    eventSourcedCache.set(key, result);
+    return result;
+};
+/**
+ * Repositories built on the pjx persistence bases (`RepositoryBase`, `OutboxRepository`):
+ *
+ * - every `deserialize…` method carries `@reconstitute` — it marks the entity as restored and copies
+ *   its version, so `save()` updates (with the optimistic-lock check) instead of inserting a duplicate;
+ * - an event-sourced aggregate (`extends EventSourceable`) is persisted by an `…OutboxRepository`, so
+ *   its emitted events reach the outbox in the same transaction as its state.
+ */
+exports.default = (0, rule_1.defineRule)({
+    meta: {
+        type: 'problem',
+        docs: { description: 'Persist trackable and event-sourced aggregates correctly' },
+        messages: {
+            reconstitute: '`{{method}}` rebuilds a persisted entity — decorate it with @{{decorator}} so save() updates instead of inserting.',
+            outbox: '"{{entity}}" is event-sourced — "{{name}}" must extend an …OutboxRepository so its events reach the outbox with its state.',
+        },
+        schema: [{
+                type: 'object',
+                properties: {
+                    bases: { type: 'array', items: { type: 'string' } },
+                    decorator: { type: 'string' },
+                    outboxPattern: { type: 'string' },
+                    eventSourcedBase: { type: 'string' },
+                },
+                additionalProperties: false,
+            }],
+    },
+    create(context) {
+        const { bases = ['RepositoryBase', 'OutboxRepository'], decorator = 'reconstitute', outboxPattern = 'OutboxRepository$', eventSourcedBase = 'EventSourceable', } = context.options[0] ?? {};
+        const imports = new Map();
+        const isPersistenceBase = (name) => !!name && (bases.includes(name) || new RegExp(outboxPattern).test(name));
+        return {
+            ImportDeclaration(node) {
+                for (const specifier of node.specifiers)
+                    imports.set(specifier.local.name, node.source.value);
+            },
+            ClassDeclaration(node) {
+                const superName = node.superClass?.name;
+                if (!isPersistenceBase(superName))
+                    return;
+                for (const member of node.body.body) {
+                    if (member.type !== 'MethodDefinition' || !/^deserialize/.test((0, ast_1.memberName)(member) ?? ''))
+                        continue;
+                    if (!(0, ast_1.decoratorNames)(member).includes(decorator)) {
+                        context.report({ node: member.key, messageId: 'reconstitute', data: { method: (0, ast_1.memberName)(member), decorator } });
+                    }
+                }
+                if (new RegExp(outboxPattern).test(superName))
+                    return;
+                const entityType = (node.superTypeArguments ?? node.superTypeParameters)?.params?.[0];
+                const entity = entityType?.type === 'TSTypeReference' && entityType.typeName.type === 'Identifier' ? entityType.typeName.name : null;
+                const file = entity && imports.has(entity) ? resolveSource(context.filename, imports.get(entity)) : null;
+                if (entity && file && declaresEventSourced(file, entity, eventSourcedBase)) {
+                    context.report({ node: node.superClass, messageId: 'outbox', data: { entity, name: node.id?.name ?? '(anonymous)' } });
+                }
+            },
+        };
+    },
+});
+//# sourceMappingURL=trackable-repository.js.map

package/dist/rules/trackable-repository.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"trackable-repository.js","sourceRoot":"","sources":["../../src/rules/trackable-repository.ts"],"names":[],"mappings":";;;AAAA,oDAAoB;AACpB,wDAAwB;AACxB,sCAAyC;AACzC,oCAAwD;AAExD,sFAAsF;AACtF,MAAM,iBAAiB,GAAG,IAAI,GAAG,EAAmB,CAAC;AAErD,MAAM,aAAa,GAAG,CAAC,QAAgB,EAAE,MAAc,EAAiB,EAAE;IACxE,IAAI,CAAC,MAAM,CAAC,UAAU,CAAC,GAAG,CAAC;QAAE,OAAO,IAAI,CAAC;IACzC,MAAM,IAAI,GAAG,cAAI,CAAC,OAAO,CAAC,cAAI,CAAC,OAAO,CAAC,QAAQ,CAAC,EAAE,MAAM,CAAC,CAAC;IAC1D,KAAK,MAAM,SAAS,IAAI,CAAC,GAAG,IAAI,KAAK,EAAE,cAAI,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAC;QAAE,IAAI,YAAE,CAAC,UAAU,CAAC,SAAS,CAAC;YAAE,OAAO,SAAS,CAAC;IACpH,OAAO,IAAI,CAAC;AACd,CAAC,CAAC;AAEF,8EAA8E;AAC9E,MAAM,oBAAoB,GAAG,CAAC,IAAY,EAAE,IAAY,EAAE,IAAY,EAAE,KAAK,GAAG,CAAC,EAAW,EAAE;IAC5F,MAAM,GAAG,GAAG,GAAG,IAAI,IAAI,IAAI,EAAE,CAAC;IAC9B,IAAI,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAC;QAAE,OAAO,iBAAiB,CAAC,GAAG,CAAC,GAAG,CAAE,CAAC;IACnE,MAAM,MAAM,GAAG,YAAE,CAAC,YAAY,CAAC,IAAI,EAAE,MAAM,CAAC,CAAC;IAC7C,IAAI,MAAM,GAAG,IAAI,MAAM,CAAC,YAAY,IAAI,yBAAyB,IAAI,KAAK,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;IACzF,IAAI,CAAC,MAAM,IAAI,KAAK,GAAG,CAAC,EAAE,CAAC;QACzB,KAAK,MAAM,KAAK,IAAI,MAAM,CAAC,QAAQ,CAAC,+CAA+C,CAAC,EAAE,CAAC;YACrF,MAAM,MAAM,GAAG,aAAa,CAAC,IAAI,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,CAAC;YAC7C,IAAI,MAAM,IAAI,oBAAoB,CAAC,MAAM,EAAE,IAAI,EAAE,IAAI,EAAE,KAAK,GAAG,CAAC,CAAC,EAAE,CAAC;gBAClE,MAAM,GAAG,IAAI,CAAC;gBACd,MAAM;YACR,CAAC;QACH,CAAC;IACH,CAAC;IACD,iBAAiB,CAAC,GAAG,CAAC,GAAG,EAAE,MAAM,CAAC,CAAC;IACnC,OAAO,MAAM,CAAC;AAChB,CAAC,CAAC;AAEF;;;;;;;GAOG;AACH,kBAAe,IAAA,iBAAU,EAAC;IACxB,IAAI,EAAE;QACJ,IAAI,EAAE,SAAS;QACf,IAAI,EAAE,EAAE,WAAW,EAAE,0DAA0D,EAAE;QACjF,QAAQ,EAAE;YACR,YAAY,EAAE,oHAAoH;YAClI,MAAM,EAAE,4HAA4H;SACrI;QACD,MAAM,EAAE,CAAC;gBACP,IAAI,EAAE,QAAQ;gBACd,UAAU,EAAE;oBACV,KAAK,EAAE,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE,EAAE;oBACnD,SAAS,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBAC7B,aAAa,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;oBACjC,gBAAgB,EAAE,EAAE,IAAI,EAAE,QAAQ,EAAE;iBACrC;gBACD,oBAAoB,EAAE,KAAK;aAC5B,CAAC;KACH;IACD,MAAM,CAAC,OAAO;QACZ,MAAM,EACJ,KAAK,GAAG,CAAC,gBAAgB,EAAE,kBAAkB,CAAC,EAC9C,SAAS,GAAG,cAAc,EAC1B,aAAa,GAAG,mBAAmB,EACnC,gBAAgB,GAAG,iBAAiB,GACrC,GAAG,OAAO,CAAC,OAAO,CAAC,CAAC,CAAC,IAAI,EAAE,CAAC;QAC7B,MAAM,OAAO,GAAG,IAAI,GAAG,EAAkB,CAAC;QAC1C,MAAM,iBAAiB,GAAG,CAAC,IAAwB,EAAE,EAAE,CAAC,CAAC,CAAC,IAAI,IAAI,CAAC,KAAK,CAAC,QAAQ,CAAC,IAAI,CAAC,IAAI,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,IAAI,CAAC,CAAC,CAAC;QAEjI,OAAO;YACL,iBAAiB,CAAC,IAAI;gBACpB,KAAK,MAAM,SAAS,IAAI,IAAI,CAAC,UAAU;oBAAE,OAAO,CAAC,GAAG,CAAC,SAAS,CAAC,KAAK,CAAC,IAAI,EAAE,IAAI,CAAC,MAAM,CAAC,KAAK,CAAC,CAAC;YAChG,CAAC;YACD,gBAAgB,CAAC,IAAI;gBACnB,MAAM,SAAS,GAAG,IAAI,CAAC,UAAU,EAAE,IAAI,CAAC;gBACxC,IAAI,CAAC,iBAAiB,CAAC,SAAS,CAAC;oBAAE,OAAO;gBAE1C,KAAK,MAAM,MAAM,IAAI,IAAI,CAAC,IAAI,CAAC,IAAI,EAAE,CAAC;oBACpC,IAAI,MAAM,CAAC,IAAI,KAAK,kBAAkB,IAAI,CAAC,cAAc,CAAC,IAAI,CAAC,IAAA,gBAAU,EAAC,MAAM,CAAC,IAAI,EAAE,CAAC;wBAAE,SAAS;oBACnG,IAAI,CAAC,IAAA,oBAAc,EAAC,MAAa,CAAC,CAAC,QAAQ,CAAC,SAAS,CAAC,EAAE,CAAC;wBACvD,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,MAAM,CAAC,GAAG,EAAE,SAAS,EAAE,cAAc,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAA,gBAAU,EAAC,MAAM,CAAC,EAAE,SAAS,EAAE,EAAE,CAAC,CAAC;oBACnH,CAAC;gBACH,CAAC;gBAED,IAAI,IAAI,MAAM,CAAC,aAAa,CAAC,CAAC,IAAI,CAAC,SAAS,CAAC;oBAAE,OAAO;gBACtD,MAAM,UAAU,GAAG,CAAC,IAAI,CAAC,kBAAkB,IAAI,IAAI,CAAC,mBAAmB,CAAC,EAAE,MAAM,EAAE,CAAC,CAAC,CAAC,CAAC;gBACtF,MAAM,MAAM,GAAG,UAAU,EAAE,IAAI,KAAK,iBAAiB,IAAI,UAAU,CAAC,QAAQ,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,UAAU,CAAC,QAAQ,CAAC,IAAI,CAAC,CAAC,CAAC,IAAI,CAAC;gBACrI,MAAM,IAAI,GAAG,MAAM,IAAI,OAAO,CAAC,GAAG,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,aAAa,CAAC,OAAO,CAAC,QAAQ,EAAE,OAAO,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC,CAAC,CAAC,CAAC,IAAI,CAAC;gBAC1G,IAAI,MAAM,IAAI,IAAI,IAAI,oBAAoB,CAAC,IAAI,EAAE,MAAM,EAAE,gBAAgB,CAAC,EAAE,CAAC;oBAC3E,OAAO,CAAC,MAAM,CAAC,EAAE,IAAI,EAAE,IAAI,CAAC,UAAU,EAAE,SAAS,EAAE,QAAQ,EAAE,IAAI,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,IAAI,CAAC,EAAE,EAAE,IAAI,IAAI,aAAa,EAAE,EAAE,CAAC,CAAC;gBACzH,CAAC;YACH,CAAC;SACF,CAAC;IACJ,CAAC;CACF,CAAC,CAAC"}

package/package.json

@@ -1,6 +1,48 @@
 {
   "name": "@pjts/eslint-style-rules",
-  "version": "0.0.0-stage",
-  "stub": true,
-  "description": "Temporary package placeholder for staged publishing"
-}
+  "version": "0.0.3",
+  "description": "Piotr Józefów DDD utility package — ESLint rules and flat-config preset enforcing the pjts DDD layout and conventions",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "author": "Piotr Józefów",
+  "license": "MIT",
+  "keywords": [
+    "eslint",
+    "eslintplugin",
+    "eslint-plugin",
+    "ddd",
+    "pjts"
+  ],
+  "scripts": {
+    "lint": "eslint src/",
+    "test": "NODE_ENV=test jest --coverage=false --verbose",
+    "test:watch": "NODE_ENV=test jest --coverage=false --watchAll --testNamePattern=",
+    "build": "rm -rf ./dist && tsc",
+    "package": "npm run build && npm publish --access=public",
+    "prepare": "npm version patch"
+  },
+  "peerDependencies": {
+    "eslint": ">=9.24.0",
+    "typescript-eslint": ">=8.0.0"
+  },
+  "peerDependenciesMeta": {
+    "typescript-eslint": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "@types/jest": "29.5.14",
+    "@types/node": "18.13.0",
+    "eslint": "9.32.0",
+    "jest": "29.7.0",
+    "ts-jest": "29.2.5",
+    "typescript": "5.8.3",
+    "typescript-eslint": "8.38.0"
+  },
+  "publishConfig": {
+    "registry": "https://registry.npmjs.org"
+  },
+  "dependencies": {
+    "tslib": "2.8.1"
+  }
+}