@living-architecture/riviere-extract-conventions 0.1.0 → 0.3.0

package/dist/default-config-fixtures.d.ts

@@ -0,0 +1,4 @@
+import { type ExtractionConfig } from '@living-architecture/riviere-extract-config';
+export declare function loadDefaultConfig(): unknown;
+export declare function getFirstModule(config: unknown): ExtractionConfig['modules'][number];
+//# sourceMappingURL=default-config-fixtures.d.ts.map

package/dist/default-config-fixtures.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"default-config-fixtures.d.ts","sourceRoot":"","sources":["../src/default-config-fixtures.ts"],"names":[],"mappings":"AAKA,OAAO,EAEL,KAAK,gBAAgB,EACtB,MAAM,6CAA6C,CAAA;AAIpD,wBAAgB,iBAAiB,IAAI,OAAO,CAI3C;AAED,wBAAgB,cAAc,CAAC,MAAM,EAAE,OAAO,GAAG,gBAAgB,CAAC,SAAS,CAAC,CAAC,MAAM,CAAC,CAanF"}

package/dist/default-config-fixtures.js

@@ -0,0 +1,20 @@
+import { readFileSync } from 'node:fs';
+import { join, dirname } from 'node:path';
+import { fileURLToPath } from 'node:url';
+import { isValidExtractionConfig, } from '@living-architecture/riviere-extract-config';
+const CURRENT_DIR = dirname(fileURLToPath(import.meta.url));
+export function loadDefaultConfig() {
+    const configPath = join(CURRENT_DIR, 'default-extraction.config.json');
+    const configContent = readFileSync(configPath, 'utf-8');
+    return JSON.parse(configContent);
+}
+export function getFirstModule(config) {
+    if (!isValidExtractionConfig(config)) {
+        throw new Error(`Expected valid ExtractionConfig. Got invalid config. Validation needed.`);
+    }
+    const [module] = config.modules;
+    if (!module) {
+        throw new Error(`Expected modules[0] after schema validation. Got undefined. Schema enforces minItems: 1.`);
+    }
+    return module;
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@living-architecture/riviere-extract-conventions",
-  "version": "0.1.0",
+  "version": "0.3.0",
   "type": "module",
   "publishConfig": {
     "access": "public"
@@ -15,10 +15,23 @@
       "types": "./dist/index.d.ts",
       "import": "./dist/index.js",
       "default": "./dist/index.js"
+    },
+    "./default-config": "./src/default-extraction.config.json",
+    "./eslint-plugin": {
+      "types": "./src/eslint/index.d.ts",
+      "require": "./src/eslint/index.cjs",
+      "default": "./src/eslint/index.cjs"
     }
   },
   "files": [
     "dist",
+    "src/default-extraction.config.json",
+    "src/eslint/*.cjs",
+    "src/eslint/*.d.ts",
+    "src/eslint/*.d.cts",
     "!**/*.tsbuildinfo"
-  ]
+  ],
+  "dependencies": {
+    "@living-architecture/riviere-extract-config": "0.1.4"
+  }
 }

package/src/default-extraction.config.json

@@ -0,0 +1,68 @@
+{
+  "$schema": "https://living-architecture.dev/schemas/extraction-config.schema.json",
+  "modules": [
+    {
+      "path": "**/*.ts",
+      "api": {
+        "find": "methods",
+        "where": {
+          "inClassWith": {
+            "hasDecorator": {
+              "name": "APIContainer",
+              "from": "@living-architecture/riviere-extract-conventions"
+            }
+          }
+        }
+      },
+      "useCase": {
+        "find": "classes",
+        "where": {
+          "hasDecorator": {
+            "name": "UseCase",
+            "from": "@living-architecture/riviere-extract-conventions"
+          }
+        }
+      },
+      "domainOp": {
+        "find": "methods",
+        "where": {
+          "inClassWith": {
+            "hasDecorator": {
+              "name": "DomainOpContainer",
+              "from": "@living-architecture/riviere-extract-conventions"
+            }
+          }
+        }
+      },
+      "event": {
+        "find": "classes",
+        "where": {
+          "hasDecorator": {
+            "name": "Event",
+            "from": "@living-architecture/riviere-extract-conventions"
+          }
+        }
+      },
+      "eventHandler": {
+        "find": "methods",
+        "where": {
+          "inClassWith": {
+            "hasDecorator": {
+              "name": "EventHandlerContainer",
+              "from": "@living-architecture/riviere-extract-conventions"
+            }
+          }
+        }
+      },
+      "ui": {
+        "find": "classes",
+        "where": {
+          "hasDecorator": {
+            "name": "UI",
+            "from": "@living-architecture/riviere-extract-conventions"
+          }
+        }
+      }
+    }
+  ]
+}

package/src/eslint/index.cjs

@@ -0,0 +1,3 @@
+const requireComponentDecorator = require('./require-component-decorator.cjs')
+
+module.exports = { rules: { 'require-component-decorator': requireComponentDecorator } }

package/src/eslint/index.d.ts

@@ -0,0 +1,10 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+
+interface Plugin {
+  rules: {
+    'require-component-decorator': TSESLint.RuleModule<'missingDecorator'>
+  }
+}
+
+declare const plugin: Plugin
+export default plugin

package/src/eslint/require-component-decorator.cjs

@@ -0,0 +1,55 @@
+const COMPONENT_DECORATORS = [
+  'DomainOpContainer',
+  'APIContainer',
+  'EventHandlerContainer',
+  'UseCase',
+  'Event',
+  'UI',
+  'Ignore',
+]
+
+const CALL_EXPRESSION_DECORATORS = ['Custom']
+
+function getDecoratorName(expression) {
+  if (expression.type === 'Identifier') {
+    return expression.name
+  }
+  if (expression.type === 'CallExpression' && expression.callee.type === 'Identifier') {
+    return expression.callee.name
+  }
+  return null
+}
+
+function hasComponentDecorator(decorators) {
+  return decorators.some((decorator) => {
+    const name = getDecoratorName(decorator.expression)
+    if (name === null) return false
+    return COMPONENT_DECORATORS.includes(name) || CALL_EXPRESSION_DECORATORS.includes(name)
+  })
+}
+
+module.exports = {
+  meta: {
+    type: 'problem',
+    docs: { description: 'Require classes to have a component decorator' },
+    schema: [],
+    messages: {
+      missingDecorator:
+        "Class '{{className}}' requires a component decorator. Add one of: @UseCase, @Event, @UI, @DomainOpContainer, @APIContainer, @EventHandlerContainer, @Custom('type'), or @Ignore",
+    },
+  },
+  create(context) {
+    return {
+      ClassDeclaration(node) {
+        if (!node.id) return
+        if (hasComponentDecorator(node.decorators)) return
+
+        context.report({
+          node: node.id,
+          messageId: 'missingDecorator',
+          data: { className: node.id.name },
+        })
+      },
+    }
+  },
+}

package/src/eslint/require-component-decorator.d.cts

@@ -0,0 +1,4 @@
+import type { TSESLint } from '@typescript-eslint/utils'
+
+declare const rule: TSESLint.RuleModule<'missingDecorator'>
+export default rule