@o3r/eslint-plugin 9.6.0-rc.0 → 10.0.0-alpha.1

package/collection.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://raw.githubusercontent.com/angular/angular-cli/main/packages/angular_devkit/schematics/collection-schema.json",
+  "schematics": {
+    "ng-add": {
+      "description": "Add Otter eslint-plugin to the project.",
+      "factory": "./schematics/ng-add/index#ngAdd",
+      "schema": "./schematics/ng-add/schema.json",
+      "aliases": ["install", "i"]
+    }
+  }
+}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@o3r/eslint-plugin",
-  "version": "9.6.0-rc.0",
+  "version": "10.0.0-alpha.1",
   "description": "The module provides in-house eslint plugins to use in your own eslint configuration.",
   "main": "./src/public_api.js",
   "keywords": [
@@ -17,7 +17,7 @@
     "build": "yarn nx build eslint-plugin",
     "postbuild": "patch-package-json-main",
     "prepare:publish": "prepare-publish ./dist",
-    "prepare:build:builders": "yarn cpy 'schematics/**/*.json' dist/schematics && yarn cpy 'collection.json' dist",
+    "prepare:build:builders": "yarn cpy './collection.json' dist",
     "build:builders": "tsc -b tsconfig.builders.json --pretty && yarn generate-cjs-manifest"
   },
   "dependencies": {
@@ -32,49 +32,54 @@
     },
     "jsonc-eslint-parser": {
       "optional": true
+    },
+    "yaml-eslint-parser": {
+      "optional": true
     }
   },
   "peerDependencies": {
-    "@angular-eslint/template-parser": "~16.3.0",
-    "@angular-eslint/utils": "~16.3.0",
-    "@angular/compiler": "~16.2.0",
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.60.1",
+    "@angular-eslint/template-parser": "~17.1.0",
+    "@angular-eslint/utils": "~17.1.0",
+    "@angular/compiler": "~17.0.2",
+    "@typescript-eslint/eslint-plugin": "^6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
     "eslint": "^8.22.0",
-    "jsonc-eslint-parser": "~2.4.0"
+    "jsonc-eslint-parser": "~2.4.0",
+    "yaml-eslint-parser": "^1.2.2"
   },
   "devDependencies": {
-    "@angular-devkit/core": "~16.2.0",
-    "@angular-devkit/schematics": "~16.2.0",
-    "@angular-eslint/eslint-plugin": "~16.3.0",
-    "@angular-eslint/template-parser": "~16.3.0",
-    "@angular-eslint/utils": "~16.3.0",
-    "@angular/compiler": "~16.2.0",
+    "@angular-devkit/core": "~17.0.3",
+    "@angular-devkit/schematics": "~17.0.3",
+    "@angular-eslint/eslint-plugin": "~17.1.0",
+    "@angular-eslint/template-parser": "~17.1.0",
+    "@angular-eslint/utils": "~17.1.0",
+    "@angular/compiler": "~17.0.4",
     "@babel/core": "~7.23.0",
     "@babel/preset-typescript": "~7.23.0",
     "@compodoc/compodoc": "^1.1.19",
-    "@nx/eslint-plugin": "~16.10.0",
-    "@nx/jest": "~16.10.0",
-    "@o3r/build-helpers": "^9.6.0-rc.0",
+    "@nx/eslint-plugin": "~17.1.1",
+    "@nx/jest": "~17.1.1",
+    "@o3r/build-helpers": "^10.0.0-alpha.1",
     "@types/jest": "~29.5.2",
-    "@types/node": "^18.0.0",
+    "@types/node": "^20.0.0",
     "@types/semver": "^7.3.13",
-    "@typescript-eslint/eslint-plugin": "^5.60.1",
-    "@typescript-eslint/parser": "^5.60.1",
-    "cpy-cli": "^4.2.0",
+    "@typescript-eslint/eslint-plugin": "6.11.0",
+    "@typescript-eslint/parser": "^6.11.0",
+    "cpy-cli": "^5.0.0",
     "eslint": "^8.42.0",
     "eslint-plugin-jest": "~27.6.0",
-    "eslint-plugin-jsdoc": "~46.10.0",
+    "eslint-plugin-jsdoc": "~48.0.0",
     "eslint-plugin-prefer-arrow": "~1.2.3",
-    "eslint-plugin-unicorn": "^47.0.0",
+    "eslint-plugin-unicorn": "^50.0.0",
     "jest": "~29.7.0",
     "jest-junit": "~16.0.0",
     "jsonc-eslint-parser": "~2.4.0",
-    "nx": "~16.10.0",
+    "nx": "~17.1.1",
     "rimraf": "^5.0.1",
     "ts-jest": "~29.1.1",
-    "type-fest": "^3.12.0",
-    "typescript": "~5.1.6"
+    "type-fest": "^4.3.1",
+    "typescript": "~5.2.2",
+    "yaml-eslint-parser": "^1.2.2"
   },
   "schematics": "./collection.json",
   "type": "commonjs",

package/src/index.js

@@ -6,8 +6,10 @@ const o3r_widget_tags_1 = require("./rules/typescript/o3r-widget-tags/o3r-widget
 const no_inner_html_1 = require("./rules/template/no-inner-html/no-inner-html");
 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 yarnrc_package_extensions_harmonize_1 = require("./rules/yaml/yarnrc-package-extensions-harmonize/yarnrc-package-extensions-harmonize");
 const matching_configuration_name_1 = require("./rules/typescript/matching-configuration-name/matching-configuration-name");
 const no_multiple_type_configuration_property_1 = require("./rules/typescript/no-multiple-type-configuration-property/no-multiple-type-configuration-property");
+const o3r_categories_tags_1 = require("./rules/typescript/o3r-categories-tags/o3r-categories-tags");
 module.exports = {
     rules: {
         'no-folder-import-for-module': no_folder_import_for_module_1.default,
@@ -16,10 +18,13 @@ module.exports = {
         'o3r-widget-tags': o3r_widget_tags_1.default,
         'json-dependency-versions-harmonize': json_dependency_versions_harmonize_1.default,
         'matching-configuration-name': matching_configuration_name_1.default,
-        'no-multiple-type-configuration-property': no_multiple_type_configuration_property_1.default
+        'yarnrc-package-extensions-harmonize': yarnrc_package_extensions_harmonize_1.default,
+        'no-multiple-type-configuration-property': no_multiple_type_configuration_property_1.default,
+        'o3r-categories-tags': o3r_categories_tags_1.default
     },
     configs: {
         '@o3r/no-folder-import-for-module': 'error',
+        '@o3r/o3r-categories-tags': 'error',
         '@o3r/json-dependency-versions-harmonize': 'error',
         '@o3r/no-multiple-type-configuration-property': 'error',
         '@o3r/template-async-number-limitation': 'warn',
@@ -29,6 +34,7 @@ module.exports = {
                 '@o3r/matching-configuration-name': 'error',
                 '@o3r/no-multiple-type-configuration-property': 'error',
                 '@o3r/no-folder-import-for-module': 'error',
+                '@o3r/o3r-categories-tags': 'error',
                 '@o3r/template-async-number-limitation': 'off'
             }
         },
@@ -42,6 +48,11 @@ module.exports = {
             rules: {
                 '@o3r/json-dependency-versions-harmonize': 'error'
             }
+        },
+        'yarn-recommended': {
+            rules: {
+                '@o3r/yarnrc-package-extensions-harmonize': 'error'
+            }
         }
     }
 };

package/src/rules/json/json-dependency-versions-harmonize/json-dependency-versions-harmonize.js

@@ -31,6 +31,7 @@ exports.default = (0, utils_1.createRule)({
                     dependencyTypes: {
                         type: 'array',
                         description: 'List of dependency types to update',
+                        default: defaultOptions[0].dependencyTypes,
                         items: {
                             type: 'string'
                         }

package/src/rules/json/utils.js

@@ -6,7 +6,7 @@ exports.ensureJsoncParser = exports.getJsoncParserServices = exports.isObjectExp
  * @param parserServices Parser services object
  */
 function isJsoncParserServices(parserServices) {
-    return !!parserServices;
+    return !!parserServices && typeof parserServices.isJSON !== undefined;
 }
 exports.isJsoncParserServices = isJsoncParserServices;
 /**

package/src/rules/template/utils.d.ts

@@ -21,20 +21,17 @@ interface TemplateParserServices extends ParserServices {
 }
 /**
  * Determine if @angular-eslint/template-parser is used
- *
  * @param parserServices Parser services object
  */
 export declare function isTemplateParserServices(parserServices: any): parserServices is TemplateParserServices;
 /**
  * Retrieve the template parser services object or throw if the invalid parser is used
- *
  * @param context Rule context
  */
 export declare function getTemplateParserServices(context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>): TemplateParserServices;
 /**
  * Utility for rule authors to ensure that their rule is correctly being used with @angular-eslint/template-parser
  * If @angular-eslint/template-parser is not the configured parser when the function is invoked it will throw
- *
  * @param context
  */
 export declare function ensureTemplateParser(context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>): void;

package/src/rules/template/utils.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 exports.ensureTemplateParser = exports.getTemplateParserServices = exports.isTemplateParserServices = void 0;
 /**
  * Determine if @angular-eslint/template-parser is used
- *
  * @param parserServices Parser services object
  */
 function isTemplateParserServices(parserServices) {
@@ -13,7 +12,6 @@ function isTemplateParserServices(parserServices) {
 exports.isTemplateParserServices = isTemplateParserServices;
 /**
  * Retrieve the template parser services object or throw if the invalid parser is used
- *
  * @param context Rule context
  */
 function getTemplateParserServices(context) {
@@ -31,7 +29,6 @@ exports.getTemplateParserServices = getTemplateParserServices;
 /**
  * Utility for rule authors to ensure that their rule is correctly being used with @angular-eslint/template-parser
  * If @angular-eslint/template-parser is not the configured parser when the function is invoked it will throw
- *
  * @param context
  */
 function ensureTemplateParser(context) {

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

@@ -2,6 +2,7 @@
 Object.defineProperty(exports, "__esModule", { value: true });
 const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
 const utils_1 = require("../../utils");
+const nameDeterminingFunctionNames = ['computeItemIdentifier', 'computeConfigurationName'];
 exports.default = (0, utils_1.createRule)({
     name: 'matching-configuration-name',
     meta: {
@@ -10,7 +11,7 @@ exports.default = (0, utils_1.createRule)({
         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).',
+            description: 'Ensures that the configuration interface name matches the first parameter of `computeItemIdentifier` (or `computeConfigurationName`) used beside the configuration interface to expose its ID (as generated by the configuration module).',
             recommended: 'error'
         },
         schema: [],
@@ -25,7 +26,7 @@ exports.default = (0, utils_1.createRule)({
             // 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'
+                    || !nameDeterminingFunctionNames.includes(node.callee.name)
                     || !node.arguments.length
                     || node.arguments[0].type !== experimental_utils_1.TSESTree.AST_NODE_TYPES.Literal
                     || typeof node.arguments[0].value !== 'string') {

package/src/rules/typescript/o3r-categories-tags/o3r-categories-tags.d.ts

@@ -0,0 +1,7 @@
+export interface O3rCategoriesTagsRuleOption {
+    supportedInterfaceNames?: string[];
+    globalConfigCategories?: string[];
+}
+type Messages = 'alreadyDefined' | 'undefinedCategory' | 'onlyOneCategoryAllowed' | 'notInConfigurationInterface' | 'suggestReplaceO3rCategory';
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<Messages, [O3rCategoriesTagsRuleOption, ...any[]], import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>;
+export default _default;

package/src/rules/typescript/o3r-categories-tags/o3r-categories-tags.js

@@ -0,0 +1,137 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const utils_1 = require("../../utils");
+exports.default = (0, utils_1.createRule)({
+    name: 'o3r-categories-tags',
+    meta: {
+        hasSuggestions: true,
+        fixable: 'code',
+        type: 'problem',
+        docs: {
+            description: 'Ensures that @o3rCategories and @o3rCategory are used with correct value',
+            recommended: 'error'
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    supportedInterfaceNames: {
+                        type: 'array',
+                        items: {
+                            type: 'string'
+                        },
+                        default: utils_1.defaultSupportedInterfaceNames
+                    },
+                    globalConfigCategories: {
+                        type: 'array',
+                        items: {
+                            type: 'string'
+                        },
+                        default: []
+                    }
+                }
+            }
+        ],
+        messages: {
+            alreadyDefined: '{{ currentCategory }} is already defined globally.',
+            undefinedCategory: '{{ currentCategory }} is not supported. Supported @o3rCategory: {{ supportedCategories }}.',
+            onlyOneCategoryAllowed: '@o3rCategory must be defined only once.',
+            notInConfigurationInterface: '@o3rCategory and @o3rCategories can only be used in `Configuration` interface.',
+            suggestReplaceO3rCategory: 'Replace {{ currentCategory }} by {{ suggestedCategory }}.'
+        }
+    },
+    defaultOptions: [{
+            supportedInterfaceNames: utils_1.defaultSupportedInterfaceNames,
+            globalConfigCategories: []
+        }],
+    create: (context, [options]) => {
+        const globalConfigCategories = new Set(options.globalConfigCategories);
+        return {
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            TSPropertySignature: (node) => {
+                const sourceCode = context.getSourceCode();
+                const comment = (0, utils_1.getNodeComment)(node, sourceCode);
+                if (!comment || !comment.value.length) {
+                    return;
+                }
+                const { loc, value: docText } = comment;
+                const categories = Array.from(docText.matchAll(/@o3rCategory (\w+)/g)).map((match) => match[1]);
+                if (categories.length < 1) {
+                    return;
+                }
+                else if (categories.length > 1) {
+                    return context.report({
+                        messageId: 'onlyOneCategoryAllowed',
+                        node,
+                        loc
+                    });
+                }
+                const category = categories[0];
+                const interfaceDeclNode = node.parent?.parent;
+                if (!(0, utils_1.isExtendingConfiguration)(interfaceDeclNode, options.supportedInterfaceNames)) {
+                    return context.report({
+                        messageId: 'notInConfigurationInterface',
+                        node,
+                        loc
+                    });
+                }
+                const interfaceComment = (0, utils_1.getNodeComment)(interfaceDeclNode, sourceCode);
+                const supportedO3rCategories = new Set(options.globalConfigCategories);
+                Array.from(interfaceComment?.value.matchAll(/@o3rCategories (\w+)/g) || []).forEach((match) => supportedO3rCategories.add(match[1]));
+                if (!supportedO3rCategories.has(category)) {
+                    return context.report({
+                        messageId: 'undefinedCategory',
+                        node,
+                        loc,
+                        data: {
+                            currentCategory: category,
+                            supportedCategories: Array.from(supportedO3rCategories).join(', ')
+                        },
+                        suggest: Array.from(supportedO3rCategories).map((suggestedCategory) => ({
+                            messageId: 'suggestReplaceO3rCategory',
+                            data: {
+                                currentCategory: category,
+                                suggestedCategory: suggestedCategory
+                            },
+                            fix: (fixer) => {
+                                return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(`@o3rCategory ${category}`, `@o3rCategory ${suggestedCategory}`)));
+                            }
+                        }))
+                    });
+                }
+            },
+            // eslint-disable-next-line @typescript-eslint/naming-convention
+            TSInterfaceDeclaration: (node) => {
+                const sourceCode = context.getSourceCode();
+                const comment = (0, utils_1.getNodeComment)(node, sourceCode);
+                if (!comment || !comment.value.length) {
+                    return;
+                }
+                const { loc, value: docText } = comment;
+                const categories = Array.from(docText.matchAll(/@o3rCategories (\w+)/g)).map((match) => match[1]);
+                if (categories.length < 1) {
+                    return;
+                }
+                if (!(0, utils_1.isExtendingConfiguration)(node, options.supportedInterfaceNames)) {
+                    return context.report({
+                        messageId: 'notInConfigurationInterface',
+                        node,
+                        loc
+                    });
+                }
+                const alreadyDefined = categories.find((category) => globalConfigCategories.has(category));
+                if (alreadyDefined) {
+                    return context.report({
+                        messageId: 'alreadyDefined',
+                        fix: (fixer) => fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(new RegExp(`.*@o3rCategories ${alreadyDefined}.*\n`), ''))),
+                        data: {
+                            currentCategory: alreadyDefined
+                        },
+                        node,
+                        loc
+                    });
+                }
+            }
+        };
+    }
+});

package/src/rules/typescript/o3r-widget-tags/o3r-widget-tags.js

@@ -3,7 +3,6 @@ Object.defineProperty(exports, "__esModule", { value: true });
 const utils_1 = require("../../utils");
 const o3rWidgetParameterPattern = '^[a-zA-Z0-9-_:.]+$';
 const o3rWidgetParamTypes = ['string', 'number', 'boolean', 'string[]', 'number[]', 'boolean[]'];
-const createCommentString = (comment) => `/*${comment}*/`;
 const defaultOptions = [{
         supportedInterfaceNames: utils_1.defaultSupportedInterfaceNames,
         widgets: {}
@@ -77,7 +76,7 @@ exports.default = (0, utils_1.createRule)({
             // eslint-disable-next-line @typescript-eslint/naming-convention
             TSPropertySignature: (node) => {
                 const sourceCode = context.getSourceCode();
-                const [comment] = sourceCode.getCommentsBefore(node);
+                const comment = (0, utils_1.getNodeComment)(node, sourceCode);
                 if (!comment || !comment.value.length) {
                     return;
                 }
@@ -85,7 +84,7 @@ exports.default = (0, utils_1.createRule)({
                 const widgetTypes = Array.from(docText.matchAll(/@o3rWidget (.*)/g));
                 if (widgetTypes.length > 1) {
                     const fix = (fixer) => {
-                        return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(/(.*(@o3rWidget ).*(\n.*)*)(\n.*)\2.*/, '$1')));
+                        return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(/(.*(@o3rWidget ).*(\n.*)*)(\n.*)\2.*/, '$1')));
                     };
                     return context.report({
                         messageId: 'onlyOneWidgetAllowed',
@@ -104,7 +103,7 @@ exports.default = (0, utils_1.createRule)({
                 if (!widgetType) {
                     if (widgetParameterTexts.length) {
                         const fix = (fixer) => {
-                            return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(/((.*)@o3rWidgetParam .*)/, '$2@o3rWidget widgetType\n$1')));
+                            return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(/((.*)@o3rWidgetParam .*)/, '$2@o3rWidget widgetType\n$1')));
                         };
                         return context.report({
                             messageId: 'noParamWithoutWidget',
@@ -143,7 +142,7 @@ exports.default = (0, utils_1.createRule)({
                                 suggestedType: suggestedWidget
                             },
                             fix: (fixer) => {
-                                return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(`@o3rWidget ${widgetType}`, `@o3rWidget ${suggestedWidget}`)));
+                                return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(`@o3rWidget ${widgetType}`, `@o3rWidget ${suggestedWidget}`)));
                             }
                         }))
                     });
@@ -161,7 +160,7 @@ exports.default = (0, utils_1.createRule)({
                 for (const widgetParameterName of widgetParameterNames) {
                     if (checkedParam.has(widgetParameterName)) {
                         const fix = (fixer) => {
-                            return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(/(.*(@o3rWidgetParam ).*(\n.*)*)(\n.*)\2.*/m, '$1')));
+                            return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(/(.*(@o3rWidgetParam ).*(\n.*)*)(\n.*)\2.*/m, '$1')));
                         };
                         return context.report({
                             messageId: 'duplicatedParam',
@@ -194,7 +193,7 @@ exports.default = (0, utils_1.createRule)({
                                     suggestedType: suggestedParam
                                 },
                                 fix: (fixer) => {
-                                    return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(`@o3rWidgetParam ${widgetType}`, `@o3rWidgetParam ${suggestedParam}`)));
+                                    return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(`@o3rWidgetParam ${widgetType}`, `@o3rWidgetParam ${suggestedParam}`)));
                                 }
                             }))
                         });
@@ -205,7 +204,7 @@ exports.default = (0, utils_1.createRule)({
                 if (firstRequiredParam) {
                     const [firstRequiredParamName] = firstRequiredParam;
                     const fix = (fixer) => {
-                        return fixer.replaceTextRange(comment.range, createCommentString(comment.value.replace(/((.*)@o3rWidget (.*))/, `$1\n$2@o3rWidgetParam ${firstRequiredParamName} value`)));
+                        return fixer.replaceTextRange(comment.range, (0, utils_1.createCommentString)(comment.value.replace(/((.*)@o3rWidget (.*))/, `$1\n$2@o3rWidgetParam ${firstRequiredParamName} value`)));
                     };
                     return context.report({
                         messageId: 'requiredParamMissing',

package/src/rules/utils.d.ts

@@ -1,6 +1,6 @@
-import { ESLintUtils, TSESTree } from '@typescript-eslint/experimental-utils';
+import { ESLintUtils, TSESLint, TSESTree } from '@typescript-eslint/experimental-utils';
 /** ESLint rule generator */
-export declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string, TRuleListener extends import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener = import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleListener>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>>) => import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<TMessageIds, TOptions, TRuleListener>;
+export declare const createRule: <TOptions extends readonly unknown[], TMessageIds extends string, TRuleListener extends TSESLint.RuleListener = TSESLint.RuleListener>({ name, meta, ...rule }: Readonly<ESLintUtils.RuleWithMetaAndName<TOptions, TMessageIds, TRuleListener>>) => TSESLint.RuleModule<TMessageIds, TOptions, TRuleListener>;
 /** Default supported interface names */
 export declare const defaultSupportedInterfaceNames: string[];
 /**
@@ -8,4 +8,15 @@ export declare const defaultSupportedInterfaceNames: string[];
  * @param interfaceDeclNode
  * @param supportedInterfaceNames
  */
-export declare const isExtendingConfiguration: (interfaceDeclNode: TSESTree.Node | undefined, supportedInterfaceNames?: string[]) => boolean | undefined;
+export declare const isExtendingConfiguration: (interfaceDeclNode: TSESTree.Node | undefined, supportedInterfaceNames?: string[]) => interfaceDeclNode is TSESTree.Node;
+/**
+ * Returns the comment above the node
+ * @param node
+ * @param sourceCode
+ */
+export declare const getNodeComment: (node: TSESTree.Node, sourceCode: TSESLint.SourceCode) => TSESTree.Comment | undefined;
+/**
+ * Wraps `commentValue` into a comment
+ * @param commentValue
+ */
+export declare const createCommentString: (commentValue: string) => string;

package/src/rules/utils.js

@@ -1,6 +1,6 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.isExtendingConfiguration = exports.defaultSupportedInterfaceNames = exports.createRule = void 0;
+exports.createCommentString = exports.getNodeComment = exports.isExtendingConfiguration = exports.defaultSupportedInterfaceNames = exports.createRule = void 0;
 const experimental_utils_1 = require("@typescript-eslint/experimental-utils");
 const path = require("node:path");
 /** Current package version (format: <major>.<minor>)*/
@@ -23,8 +23,26 @@ exports.defaultSupportedInterfaceNames = ['Configuration', 'NestedConfiguration'
 const isExtendingConfiguration = (interfaceDeclNode, supportedInterfaceNames = []) => {
     const supportedInterfaceNamesSet = new Set(supportedInterfaceNames.length > 0 ? supportedInterfaceNames : exports.defaultSupportedInterfaceNames);
     return interfaceDeclNode?.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.TSInterfaceDeclaration
-        && interfaceDeclNode.extends?.some((ext) => ext.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.TSInterfaceHeritage
+        && !!interfaceDeclNode.extends?.some((ext) => ext.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.TSInterfaceHeritage
             && ext.expression.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.Identifier
             && supportedInterfaceNamesSet.has(ext.expression.name));
 };
 exports.isExtendingConfiguration = isExtendingConfiguration;
+/**
+ * Returns the comment above the node
+ * @param node
+ * @param sourceCode
+ */
+const getNodeComment = (node, sourceCode) => {
+    const [comment] = node.parent?.type === experimental_utils_1.TSESTree.AST_NODE_TYPES.ExportNamedDeclaration
+        ? sourceCode.getCommentsBefore(node.parent)
+        : sourceCode.getCommentsBefore(node);
+    return comment;
+};
+exports.getNodeComment = getNodeComment;
+/**
+ * Wraps `commentValue` into a comment
+ * @param commentValue
+ */
+const createCommentString = (commentValue) => `/*${commentValue.replace(/\*\//g, '*\\/')}*/`;
+exports.createCommentString = createCommentString;

package/src/rules/yaml/utils.d.ts

@@ -0,0 +1,22 @@
+import { ParserServices, TSESLint } from '@typescript-eslint/experimental-utils';
+/** Basic interface for the Parser Services object provided by yaml-eslint-parser */
+interface YamlParserServices extends ParserServices {
+    isYAML: boolean;
+}
+/**
+ * Determine if yaml-eslint-parser is used
+ * @param parserServices Parser services object
+ */
+export declare function isYamlParserServices(parserServices: any): parserServices is YamlParserServices;
+/**
+ * Retrieve the yaml parser services object or throw if the invalid parser is used
+ * @param context Rule context
+ */
+export declare function getYamlParserServices(context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>): YamlParserServices;
+/**
+ * Utility for rule authors to ensure that their rule is correctly being used with yaml-eslint-parser
+ * If yaml-eslint-parser is not the configured parser when the function is invoked it will throw
+ * @param context
+ */
+export declare function ensureJsoncParser(context: Readonly<TSESLint.RuleContext<string, readonly unknown[]>>): void;
+export {};

package/src/rules/yaml/utils.js

@@ -0,0 +1,42 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ensureJsoncParser = exports.getYamlParserServices = exports.isYamlParserServices = void 0;
+/**
+ * Determine if yaml-eslint-parser is used
+ * @param parserServices Parser services object
+ */
+function isYamlParserServices(parserServices) {
+    return !!parserServices && parserServices.isYAML;
+}
+exports.isYamlParserServices = isYamlParserServices;
+/**
+ * Retrieve the yaml parser services object or throw if the invalid parser is used
+ * @param context Rule context
+ */
+function getYamlParserServices(context) {
+    const parserService = context.parserServices;
+    if (!isYamlParserServices(parserService)) {
+        /*
+         * The user needs to have configured "parser" in their eslint config and set it
+         * to yaml-eslint-parser
+         */
+        throw new Error('You have used a rule which requires \'yaml-eslint-parser\' to be used as the \'parser\' in your ESLint config.');
+    }
+    return parserService;
+}
+exports.getYamlParserServices = getYamlParserServices;
+/**
+ * Utility for rule authors to ensure that their rule is correctly being used with yaml-eslint-parser
+ * If yaml-eslint-parser is not the configured parser when the function is invoked it will throw
+ * @param context
+ */
+function ensureJsoncParser(context) {
+    if (!(context.parserServices)) {
+        /*
+         * The user needs to have configured "parser" in their eslint config and set it
+         * to yaml-eslint-parser
+         */
+        throw new Error('You have used a rule which requires \'yaml-eslint-parser\' to be used as the \'parser\' in your ESLint config.');
+    }
+}
+exports.ensureJsoncParser = ensureJsoncParser;

package/src/rules/yaml/yarnrc-package-extensions-harmonize/yarnrc-package-extensions-harmonize.d.ts

@@ -0,0 +1,12 @@
+interface Options {
+    /** List of package.json to ignore when determining the dependencies versions */
+    excludePackages: string[];
+    /** List of dependency types in package.json to parse */
+    dependencyTypesInPackages: string[];
+    /** List of dependencies to ignore */
+    ignoredDependencies: string[];
+    /** List of dependency types to validate in .yarnrc.yml */
+    yarnrcDependencyTypes: string[];
+}
+declare const _default: import("@typescript-eslint/utils/dist/ts-eslint/Rule").RuleModule<"error" | "versionUpdate", [Options, ...any[]], any>;
+export default _default;

package/src/rules/yaml/yarnrc-package-extensions-harmonize/yarnrc-package-extensions-harmonize.js

@@ -0,0 +1,122 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+const path = require("node:path");
+const semver = require("semver");
+const utils_1 = require("../../utils");
+const utils_2 = require("../utils");
+const yaml_eslint_parser_1 = require("yaml-eslint-parser");
+const version_harmonize_1 = require("../../json/json-dependency-versions-harmonize/version-harmonize");
+const defaultOptions = [{
+        ignoredDependencies: [],
+        excludePackages: [],
+        yarnrcDependencyTypes: ['peerDependencies', 'dependencies'],
+        dependencyTypesInPackages: ['optionalDependencies', 'dependencies', 'devDependencies', 'peerDependencies', 'generatorDependencies']
+    }];
+exports.default = (0, utils_1.createRule)({
+    name: 'yarnrc-package-extensions-harmonize',
+    meta: {
+        hasSuggestions: true,
+        type: 'problem',
+        docs: {
+            description: 'Ensure that the package extension versions are aligned with range defined in packages.',
+            recommended: 'error'
+        },
+        schema: [
+            {
+                type: 'object',
+                properties: {
+                    excludePackages: {
+                        type: 'array',
+                        description: 'List of package.json to ignore when determining the dependencies versions',
+                        items: {
+                            type: 'string'
+                        }
+                    },
+                    yarnrcDependencyTypes: {
+                        type: 'array',
+                        description: 'List of dependency types to validate in .yarnrc.yml',
+                        default: defaultOptions[0].yarnrcDependencyTypes,
+                        items: {
+                            type: 'string'
+                        }
+                    },
+                    dependencyTypesInPackages: {
+                        type: 'array',
+                        description: 'List of dependency types in package.json to parse',
+                        default: defaultOptions[0].dependencyTypesInPackages,
+                        items: {
+                            type: 'string'
+                        }
+                    },
+                    ignoredDependencies: {
+                        type: 'array',
+                        description: 'List of dependencies to ignore',
+                        items: {
+                            type: 'string'
+                        }
+                    }
+                },
+                additionalProperties: false
+            }
+        ],
+        messages: {
+            versionUpdate: 'Set version {{version}}',
+            error: '{{depName}} should be updated to version {{version}} (from: {{packageJsonFile}})'
+        },
+        fixable: 'code'
+    },
+    defaultOptions,
+    create: (context, [options]) => {
+        const parserServices = (0, utils_2.getYamlParserServices)(context);
+        const dirname = path.dirname(context.getFilename());
+        const workspace = (0, version_harmonize_1.findWorkspacePackageJsons)(dirname);
+        const bestRanges = workspace ?
+            (0, version_harmonize_1.getBestRanges)(options.dependencyTypesInPackages, workspace.packages.filter(({ content }) => !content.name || !options.excludePackages.includes(content.name))) :
+            {};
+        const ignoredDependencies = options.ignoredDependencies.map((dep) => new RegExp(dep.replace(/[.+?^${}()|[\]\\]/g, '\\$&').replace(/\*/g, '.*')));
+        if (parserServices.isYAML) {
+            return {
+                // eslint-disable-next-line @typescript-eslint/naming-convention
+                'YAMLPair': (node) => {
+                    if (node.value) {
+                        const range = (0, yaml_eslint_parser_1.getStaticYAMLValue)(node.value)?.toString();
+                        const parent = node.parent.parent && node.parent.parent.type === 'YAMLPair' && (0, yaml_eslint_parser_1.getStaticYAMLValue)(node.parent.parent.key)?.toString();
+                        const baseNode = node.parent.parent.parent.parent?.parent?.parent;
+                        const isCorrectNode = baseNode && baseNode.type === 'YAMLPair' && (0, yaml_eslint_parser_1.getStaticYAMLValue)(baseNode.key)?.toString() === 'packageExtensions';
+                        if (isCorrectNode && semver.validRange(range) && parent && options.yarnrcDependencyTypes.some((t) => t === parent)) {
+                            const depName = node.key && (0, yaml_eslint_parser_1.getStaticYAMLValue)(node.key)?.toString();
+                            if (!depName || !bestRanges[depName] || ignoredDependencies.some((ignore) => ignore.test(depName))) {
+                                return;
+                            }
+                            const minYarnrcVersion = semver.minVersion(range);
+                            const minBestRangeVersion = semver.minVersion(bestRanges[depName].range);
+                            if (minYarnrcVersion && minBestRangeVersion && semver.lt(minYarnrcVersion, minBestRangeVersion)) {
+                                const version = bestRanges[depName].range;
+                                const packageJsonFile = bestRanges[depName].path;
+                                context.report({
+                                    loc: node.value.loc,
+                                    messageId: 'error',
+                                    data: {
+                                        depName,
+                                        version,
+                                        packageJsonFile
+                                    },
+                                    fix: (fixer) => fixer.replaceTextRange(node.value.range, `${version}`),
+                                    suggest: [
+                                        {
+                                            messageId: 'versionUpdate',
+                                            data: {
+                                                version
+                                            },
+                                            fix: (fixer) => fixer.replaceTextRange(node.value.range, `${version}`)
+                                        }
+                                    ]
+                                });
+                            }
+                        }
+                    }
+                }
+            };
+        }
+    }
+});

package/tsconfig.tsbuildinfo

@@ -1 +1 @@
-{"version":"5.1.6"}
+{"version":"5.2.2"}

package/schematics/ng-add/index.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../schematics/ng-add/index.ts"],"names":[],"mappings":";;;AAAA,2DAAkD;AAGlD;;GAEG;AACH,SAAgB,KAAK;IACnB,kBAAkB;IAClB,OAAO,IAAA,iBAAI,GAAE,CAAC;AAChB,CAAC;AAHD,sBAGC"}

package/schematics/ng-add/schema.js.map

@@ -1 +0,0 @@
-{"version":3,"file":"schema.js","sourceRoot":"","sources":["../../../schematics/ng-add/schema.ts"],"names":[],"mappings":""}

package/schematics/package.json

@@ -1,3 +0,0 @@
-{
-  "type": "commonjs"
-}