@o3r/eslint-plugin 10.0.0-next.24 → 10.0.0-next.27

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/eslint-plugin",
-  "version": "10.0.0-next.24",
+  "version": "10.0.0-next.27",
   "description": "The module provides in-house eslint plugins to use in your own eslint configuration.",
   "main": "./src/public_api.js",
   "keywords": [
@@ -55,7 +55,7 @@
     "@compodoc/compodoc": "^1.1.19",
     "@nx/eslint-plugin": "~16.10.0",
     "@nx/jest": "~16.10.0",
-    "@o3r/build-helpers": "^10.0.0-next.24",
+    "@o3r/build-helpers": "^10.0.0-next.27",
     "@types/jest": "~29.5.2",
     "@types/node": "^18.0.0",
     "@types/semver": "^7.3.13",

package/src/index.js

@@ -5,19 +5,23 @@ const no_folder_import_for_module_1 = require("./rules/typescript/no-folder-impo
 const o3r_widget_tags_1 = require("./rules/typescript/o3r-widget-tags/o3r-widget-tags");
 const template_async_number_limitation_1 = require("./rules/template/template-async-number-limitation/template-async-number-limitation");
 const json_dependency_versions_harmonize_1 = require("./rules/json/json-dependency-versions-harmonize/json-dependency-versions-harmonize");
+const matching_configuration_name_1 = require("./rules/typescript/matching-configuration-name/matching-configuration-name");
 module.exports = {
     rules: {
         'no-folder-import-for-module': no_folder_import_for_module_1.default,
         'template-async-number-limitation': template_async_number_limitation_1.default,
         'o3r-widget-tags': o3r_widget_tags_1.default,
-        'json-dependency-versions-harmonize': json_dependency_versions_harmonize_1.default
+        'json-dependency-versions-harmonize': json_dependency_versions_harmonize_1.default,
+        'matching-configuration-name': matching_configuration_name_1.default
     },
     configs: {
         '@o3r/no-folder-import-for-module': 'error',
         '@o3r/json-dependency-versions-harmonize': 'error',
         '@o3r/template-async-number-limitation': 'warn',
+        '@o3r/matching-configuration-name': 'warn',
         recommended: {
             rules: {
+                '@o3r/matching-configuration-name': 'error',
                 '@o3r/no-folder-import-for-module': 'error',
                 '@o3r/template-async-number-limitation': 'off'
             }

package/src/rules/typescript/matching-configuration-name/matching-configuration-name.d.ts

@@ -0,0 +1,5 @@
+import { TSESTree } from '@typescript-eslint/experimental-utils';
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"suggestion" | "error", never[], {
+    CallExpression: (node: TSESTree.CallExpression) => void;
+}>;
+export default _default;

package/src/rules/typescript/matching-configuration-name/matching-configuration-name.js

@@ -0,0 +1,69 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
+const utils_1 = require("../../utils");
+exports.default = (0, utils_1.createRule)({
+    name: 'matching-configuration-name',
+    meta: {
+        hasSuggestions: true,
+        fixable: 'code',
+        type: 'problem',
+        docs: {
+            // eslint-disable-next-line max-len
+            description: 'Ensures that the configuration interface name matches the first parameter of `computeConfigurationName` used beside the configuration interface to expose its ID (as generated by the configuration module).',
+            recommended: 'error'
+        },
+        schema: [],
+        messages: {
+            error: '{{currentValue}} does not match: {{possibleValues}}',
+            suggestion: 'Replace {{currentValue}} by {{recommendedValue}}'
+        }
+    },
+    defaultOptions: [],
+    create: (context) => {
+        return {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            CallExpression: (node) => {
+                if (node.callee.type !== experimental_utils_1.TSESTree.AST_NODE_TYPES.Identifier
+                    || node.callee.name !== 'computeConfigurationName'
+                    || !node.arguments.length
+                    || node.arguments[0].type !== experimental_utils_1.TSESTree.AST_NODE_TYPES.Literal
+                    || typeof node.arguments[0].value !== 'string') {
+                    return;
+                }
+                const sourceCode = context.getSourceCode();
+                const interfaceNames = sourceCode.ast.body
+                    .filter((statement) => statement.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.ExportNamedDeclaration
+                    && statement.declaration?.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.TSInterfaceDeclaration
+                    && (statement.declaration.extends || []).some((heritageClause) => heritageClause.expression.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.Identifier
+                        && heritageClause.expression.name === 'Configuration'))
+                    .map((statement) => statement.declaration.id.name);
+                const fnArgInterfaceName = node.arguments[0].value;
+                if (interfaceNames.length && !interfaceNames.includes(fnArgInterfaceName)) {
+                    return context.report({
+                        node: node.arguments[0],
+                        loc: node.arguments[0].loc,
+                        messageId: 'error',
+                        data: {
+                            currentValue: fnArgInterfaceName,
+                            possibleValues: interfaceNames.join(', ')
+                        },
+                        fix: (fixer) => {
+                            return fixer.replaceText(node.arguments[0], `'${interfaceNames[0]}'`);
+                        },
+                        suggest: interfaceNames.map((interfaceName) => ({
+                            messageId: 'suggestion',
+                            data: {
+                                currentValue: fnArgInterfaceName,
+                                recommendedValue: interfaceName
+                            },
+                            fix: (fixer) => {
+                                return fixer.replaceText(node.arguments[0], `'${interfaceName}'`);
+                            }
+                        }))
+                    });
+                }
+            }
+        };
+    }
+});