eslint-plugin-sonarjs 1.0.4 → 2.0.0

package/lib/helpers/express.d.ts

@@ -0,0 +1,47 @@
+import { Rule } from 'eslint';
+import * as estree from 'estree';
+/**
+ * This modules provides utilities for writing rules about Express.js.
+ */
+export declare namespace Express {
+    /**
+     * Checks whether the declaration looks somewhat like `<id> = express()`
+     * and returns `<id>` if it matches.
+     */
+    function attemptFindAppInstantiation(varDecl: estree.VariableDeclarator, context: Rule.RuleContext): estree.Identifier | undefined;
+    /**
+     * Checks whether the function injects an instantiated app and is exported like `module.exports = function(app) {}`
+     * or `module.exports.property = function(app) {}`, and returns app if it matches.
+     */
+    function attemptFindAppInjection(functionDef: estree.Function, context: Rule.RuleContext, node: estree.Node): estree.Identifier | undefined;
+    /**
+     * Checks whether the expression looks somewhat like `app.use(m1, [m2, m3], ..., mN)`,
+     * where one of `mK`-nodes satisfies the given predicate.
+     */
+    function isUsingMiddleware(context: Rule.RuleContext, callExpression: estree.CallExpression, app: estree.Identifier, middlewareNodePredicate: (n: estree.Node) => boolean): boolean;
+    /**
+     * Checks whether a node looks somewhat like `require('m')()` for
+     * some middleware `m` from the list of middlewares.
+     */
+    function isMiddlewareInstance(context: Rule.RuleContext, middlewares: string[], n: estree.Node): boolean;
+    /**
+     * Rule factory for detecting sensitive settings that are passed to
+     * middlewares eventually used by Express.js applications:
+     *
+     * app.use(
+     *   middleware(settings)
+     * )
+     *
+     * or
+     *
+     * app.use(
+     *   middleware.method(settings)
+     * )
+     *
+     * @param sensitivePropertyFinder - a function looking for a sensitive setting on a middleware call
+     * @param message - the reported message when an issue is raised
+     * @param meta - the rule metadata
+     * @returns a rule module that raises issues when a sensitive property is found
+     */
+    function SensitiveMiddlewarePropertyRule(sensitivePropertyFinder: (context: Rule.RuleContext, middlewareCall: estree.CallExpression) => estree.Property[], message: string, meta?: Rule.RuleMetaData): Rule.RuleModule;
+}

package/lib/helpers/express.js

@@ -0,0 +1,145 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.Express = void 0;
+const _1 = require(".");
+/**
+ * This modules provides utilities for writing rules about Express.js.
+ */
+var Express;
+(function (Express) {
+    const EXPRESS = 'express';
+    /**
+     * Checks whether the declaration looks somewhat like `<id> = express()`
+     * and returns `<id>` if it matches.
+     */
+    function attemptFindAppInstantiation(varDecl, context) {
+        const rhs = varDecl.init;
+        if (rhs && rhs.type === 'CallExpression' && (0, _1.getFullyQualifiedName)(context, rhs) === EXPRESS) {
+            const pattern = varDecl.id;
+            return pattern.type === 'Identifier' ? pattern : undefined;
+        }
+        return undefined;
+    }
+    Express.attemptFindAppInstantiation = attemptFindAppInstantiation;
+    /**
+     * Checks whether the function injects an instantiated app and is exported like `module.exports = function(app) {}`
+     * or `module.exports.property = function(app) {}`, and returns app if it matches.
+     */
+    function attemptFindAppInjection(functionDef, context, node) {
+        const app = functionDef.params.find(param => param.type === 'Identifier' && param.name === 'app');
+        if (app) {
+            const parent = (0, _1.getParent)(context, node);
+            if (parent?.type === 'AssignmentExpression') {
+                const { left } = parent;
+                if (left.type === 'MemberExpression' &&
+                    ((0, _1.isModuleExports)(left) || (0, _1.isModuleExports)(left.object))) {
+                    return app;
+                }
+            }
+        }
+        return undefined;
+    }
+    Express.attemptFindAppInjection = attemptFindAppInjection;
+    /**
+     * Checks whether the expression looks somewhat like `app.use(m1, [m2, m3], ..., mN)`,
+     * where one of `mK`-nodes satisfies the given predicate.
+     */
+    function isUsingMiddleware(context, callExpression, app, middlewareNodePredicate) {
+        if ((0, _1.isMethodInvocation)(callExpression, app.name, 'use', 1)) {
+            const flattenedArgs = (0, _1.flattenArgs)(context, callExpression.arguments);
+            return Boolean(flattenedArgs.find(middlewareNodePredicate));
+        }
+        return false;
+    }
+    Express.isUsingMiddleware = isUsingMiddleware;
+    /**
+     * Checks whether a node looks somewhat like `require('m')()` for
+     * some middleware `m` from the list of middlewares.
+     */
+    function isMiddlewareInstance(context, middlewares, n) {
+        if (n.type === 'CallExpression') {
+            const fqn = (0, _1.getFullyQualifiedName)(context, n);
+            return middlewares.some(middleware => middleware === fqn);
+        }
+        return false;
+    }
+    Express.isMiddlewareInstance = isMiddlewareInstance;
+    /**
+     * Rule factory for detecting sensitive settings that are passed to
+     * middlewares eventually used by Express.js applications:
+     *
+     * app.use(
+     *   middleware(settings)
+     * )
+     *
+     * or
+     *
+     * app.use(
+     *   middleware.method(settings)
+     * )
+     *
+     * @param sensitivePropertyFinder - a function looking for a sensitive setting on a middleware call
+     * @param message - the reported message when an issue is raised
+     * @param meta - the rule metadata
+     * @returns a rule module that raises issues when a sensitive property is found
+     */
+    function SensitiveMiddlewarePropertyRule(sensitivePropertyFinder, message, meta = {}) {
+        return {
+            meta,
+            create(context) {
+                let app;
+                let sensitiveProperties;
+                function isExposing(middlewareNode) {
+                    return Boolean(sensitiveProperties.push(...findSensitiveProperty(middlewareNode)));
+                }
+                function findSensitiveProperty(middlewareNode) {
+                    if (middlewareNode.type === 'CallExpression') {
+                        return sensitivePropertyFinder(context, middlewareNode);
+                    }
+                    return [];
+                }
+                return {
+                    Program: () => {
+                        app = null;
+                        sensitiveProperties = [];
+                    },
+                    CallExpression: (node) => {
+                        if (app) {
+                            const callExpr = node;
+                            const isSafe = !isUsingMiddleware(context, callExpr, app, isExposing);
+                            if (!isSafe) {
+                                for (const sensitive of sensitiveProperties) {
+                                    (0, _1.report)(context, {
+                                        node: callExpr,
+                                        message,
+                                    }, [(0, _1.toSecondaryLocation)(sensitive)]);
+                                }
+                                sensitiveProperties = [];
+                            }
+                        }
+                    },
+                    VariableDeclarator: (node) => {
+                        if (!app) {
+                            const varDecl = node;
+                            const instantiatedApp = attemptFindAppInstantiation(varDecl, context);
+                            if (instantiatedApp) {
+                                app = instantiatedApp;
+                            }
+                        }
+                    },
+                    ':function': (node) => {
+                        if (!app) {
+                            const functionDef = node;
+                            const injectedApp = attemptFindAppInjection(functionDef, context, node);
+                            if (injectedApp) {
+                                app = injectedApp;
+                            }
+                        }
+                    },
+                };
+            },
+        };
+    }
+    Express.SensitiveMiddlewarePropertyRule = SensitiveMiddlewarePropertyRule;
+})(Express || (exports.Express = Express = {}));
+//# sourceMappingURL=express.js.map

package/lib/helpers/express.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"express.js","sourceRoot":"","sources":["../../helpers/express.ts"],"names":[],"mappings":";;;AAqBA,wBAQW;AAEX;;GAEG;AACH,IAAiB,OAAO,CAyKvB;AAzKD,WAAiB,OAAO;IACtB,MAAM,OAAO,GAAG,SAAS,CAAC;IAE1B;;;OAGG;IACH,SAAgB,2BAA2B,CACzC,OAAkC,EAClC,OAAyB;QAEzB,MAAM,GAAG,GAAG,OAAO,CAAC,IAAI,CAAC;QACzB,IAAI,GAAG,IAAI,GAAG,CAAC,IAAI,KAAK,gBAAgB,IAAI,IAAA,wBAAqB,EAAC,OAAO,EAAE,GAAG,CAAC,KAAK,OAAO,EAAE,CAAC;YAC5F,MAAM,OAAO,GAAG,OAAO,CAAC,EAAE,CAAC;YAC3B,OAAO,OAAO,CAAC,IAAI,KAAK,YAAY,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,SAAS,CAAC;QAC7D,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IAVe,mCAA2B,8BAU1C,CAAA;IAED;;;OAGG;IACH,SAAgB,uBAAuB,CACrC,WAA4B,EAC5B,OAAyB,EACzB,IAAiB;QAEjB,MAAM,GAAG,GAAG,WAAW,CAAC,MAAM,CAAC,IAAI,CACjC,KAAK,CAAC,EAAE,CAAC,KAAK,CAAC,IAAI,KAAK,YAAY,IAAI,KAAK,CAAC,IAAI,KAAK,KAAK,CAC5B,CAAC;QACnC,IAAI,GAAG,EAAE,CAAC;YACR,MAAM,MAAM,GAAG,IAAA,YAAS,EAAC,OAAO,EAAE,IAAI,CAAC,CAAC;YACxC,IAAI,MAAM,EAAE,IAAI,KAAK,sBAAsB,EAAE,CAAC;gBAC5C,MAAM,EAAE,IAAI,EAAE,GAAG,MAAM,CAAC;gBACxB,IACE,IAAI,CAAC,IAAI,KAAK,kBAAkB;oBAChC,CAAC,IAAA,kBAAe,EAAC,IAAI,CAAC,IAAI,IAAA,kBAAe,EAAC,IAAI,CAAC,MAAM,CAAC,CAAC,EACvD,CAAC;oBACD,OAAO,GAAG,CAAC;gBACb,CAAC;YACH,CAAC;QACH,CAAC;QACD,OAAO,SAAS,CAAC;IACnB,CAAC;IArBe,+BAAuB,0BAqBtC,CAAA;IAED;;;OAGG;IACH,SAAgB,iBAAiB,CAC/B,OAAyB,EACzB,cAAqC,EACrC,GAAsB,EACtB,uBAAoD;QAEpD,IAAI,IAAA,qBAAkB,EAAC,cAAc,EAAE,GAAG,CAAC,IAAI,EAAE,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC;YAC3D,MAAM,aAAa,GAAG,IAAA,cAAW,EAAC,OAAO,EAAE,cAAc,CAAC,SAAS,CAAC,CAAC;YACrE,OAAO,OAAO,CAAC,aAAa,CAAC,IAAI,CAAC,uBAAuB,CAAC,CAAC,CAAC;QAC9D,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAXe,yBAAiB,oBAWhC,CAAA;IAED;;;OAGG;IACH,SAAgB,oBAAoB,CAClC,OAAyB,EACzB,WAAqB,EACrB,CAAc;QAEd,IAAI,CAAC,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;YAChC,MAAM,GAAG,GAAG,IAAA,wBAAqB,EAAC,OAAO,EAAE,CAAC,CAAC,CAAC;YAC9C,OAAO,WAAW,CAAC,IAAI,CAAC,UAAU,CAAC,EAAE,CAAC,UAAU,KAAK,GAAG,CAAC,CAAC;QAC5D,CAAC;QACD,OAAO,KAAK,CAAC;IACf,CAAC;IAVe,4BAAoB,uBAUnC,CAAA;IAED;;;;;;;;;;;;;;;;;;OAkBG;IACH,SAAgB,+BAA+B,CAC7C,uBAGsB,EACtB,OAAe,EACf,OAA0B,EAAE;QAE5B,OAAO;YACL,IAAI;YACJ,MAAM,CAAC,OAAyB;gBAC9B,IAAI,GAA6B,CAAC;gBAClC,IAAI,mBAAsC,CAAC;gBAE3C,SAAS,UAAU,CAAC,cAA2B;oBAC7C,OAAO,OAAO,CAAC,mBAAmB,CAAC,IAAI,CAAC,GAAG,qBAAqB,CAAC,cAAc,CAAC,CAAC,CAAC,CAAC;gBACrF,CAAC;gBAED,SAAS,qBAAqB,CAAC,cAA2B;oBACxD,IAAI,cAAc,CAAC,IAAI,KAAK,gBAAgB,EAAE,CAAC;wBAC7C,OAAO,uBAAuB,CAAC,OAAO,EAAE,cAAc,CAAC,CAAC;oBAC1D,CAAC;oBACD,OAAO,EAAE,CAAC;gBACZ,CAAC;gBAED,OAAO;oBACL,OAAO,EAAE,GAAG,EAAE;wBACZ,GAAG,GAAG,IAAI,CAAC;wBACX,mBAAmB,GAAG,EAAE,CAAC;oBAC3B,CAAC;oBACD,cAAc,EAAE,CAAC,IAAiB,EAAE,EAAE;wBACpC,IAAI,GAAG,EAAE,CAAC;4BACR,MAAM,QAAQ,GAAG,IAA6B,CAAC;4BAC/C,MAAM,MAAM,GAAG,CAAC,iBAAiB,CAAC,OAAO,EAAE,QAAQ,EAAE,GAAG,EAAE,UAAU,CAAC,CAAC;4BACtE,IAAI,CAAC,MAAM,EAAE,CAAC;gCACZ,KAAK,MAAM,SAAS,IAAI,mBAAmB,EAAE,CAAC;oCAC5C,IAAA,SAAM,EACJ,OAAO,EACP;wCACE,IAAI,EAAE,QAAQ;wCACd,OAAO;qCACR,EACD,CAAC,IAAA,sBAAmB,EAAC,SAAS,CAAC,CAAC,CACjC,CAAC;gCACJ,CAAC;gCACD,mBAAmB,GAAG,EAAE,CAAC;4BAC3B,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,kBAAkB,EAAE,CAAC,IAAiB,EAAE,EAAE;wBACxC,IAAI,CAAC,GAAG,EAAE,CAAC;4BACT,MAAM,OAAO,GAAG,IAAiC,CAAC;4BAClD,MAAM,eAAe,GAAG,2BAA2B,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;4BACtE,IAAI,eAAe,EAAE,CAAC;gCACpB,GAAG,GAAG,eAAe,CAAC;4BACxB,CAAC;wBACH,CAAC;oBACH,CAAC;oBACD,WAAW,EAAE,CAAC,IAAiB,EAAE,EAAE;wBACjC,IAAI,CAAC,GAAG,EAAE,CAAC;4BACT,MAAM,WAAW,GAAG,IAAuB,CAAC;4BAC5C,MAAM,WAAW,GAAG,uBAAuB,CAAC,WAAW,EAAE,OAAO,EAAE,IAAI,CAAC,CAAC;4BACxE,IAAI,WAAW,EAAE,CAAC;gCAChB,GAAG,GAAG,WAAW,CAAC;4BACpB,CAAC;wBACH,CAAC;oBACH,CAAC;iBACF,CAAC;YACJ,CAAC;SACF,CAAC;IACJ,CAAC;IAtEe,uCAA+B,kCAsE9C,CAAA;AACH,CAAC,EAzKgB,OAAO,uBAAP,OAAO,QAyKvB"}

package/lib/helpers/files.d.ts

@@ -0,0 +1,22 @@
+/**
+ * Synchronous read of file contents from a file path
+ *
+ * The function gets rid of any Byte Order Marker (BOM)
+ * present in the file's header.
+ *
+ * @param filePath the path of a file
+ * @returns Promise which resolves with the content of the file
+ */
+export declare function readFileSync(filePath: string): string;
+/**
+ * Converts a path to Unix format
+ * @param path the path to convert
+ * @returns the converted path
+ */
+export declare function toUnixPath(path: string): string;
+/**
+ * Find nearest file with a given name in current or parent dirs
+ * @param dir
+ * @param name filename to search for
+ */
+export declare function findParent(dir: string, name: string): string | null;

package/lib/helpers/files.js

@@ -0,0 +1,86 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.findParent = exports.toUnixPath = exports.readFileSync = void 0;
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+/**
+ * Byte Order Marker
+ */
+const BOM_BYTE = 0xfeff;
+/**
+ * Synchronous read of file contents from a file path
+ *
+ * The function gets rid of any Byte Order Marker (BOM)
+ * present in the file's header.
+ *
+ * @param filePath the path of a file
+ * @returns Promise which resolves with the content of the file
+ */
+function readFileSync(filePath) {
+    const fileContent = fs_1.default.readFileSync(filePath, { encoding: 'utf8' });
+    return stripBOM(fileContent);
+}
+exports.readFileSync = readFileSync;
+/**
+ * Removes any Byte Order Marker (BOM) from a string's head
+ *
+ * A string's head is nothing else but its first character.
+ *
+ * @param str the input string
+ * @returns the stripped string
+ */
+function stripBOM(str) {
+    if (str.charCodeAt(0) === BOM_BYTE) {
+        return str.slice(1);
+    }
+    return str;
+}
+/**
+ * Converts a path to Unix format
+ * @param path the path to convert
+ * @returns the converted path
+ */
+function toUnixPath(path) {
+    return path.replace(/[\\/]+/g, '/');
+}
+exports.toUnixPath = toUnixPath;
+/**
+ * Find nearest file with a given name in current or parent dirs
+ * @param dir
+ * @param name filename to search for
+ */
+function findParent(dir, name) {
+    const filename = path_1.default.join(dir, name);
+    if (fs_1.default.existsSync(filename)) {
+        return filename;
+    }
+    const parentDir = path_1.default.resolve(dir, '..');
+    if (dir === parentDir) {
+        return null;
+    }
+    return findParent(parentDir, name);
+}
+exports.findParent = findParent;
+//# sourceMappingURL=files.js.map

package/lib/helpers/files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"files.js","sourceRoot":"","sources":["../../helpers/files.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,4CAAoB;AACpB,gDAAwB;AAExB;;GAEG;AACH,MAAM,QAAQ,GAAG,MAAM,CAAC;AAExB;;;;;;;;GAQG;AACH,SAAgB,YAAY,CAAC,QAAgB;IAC3C,MAAM,WAAW,GAAG,YAAE,CAAC,YAAY,CAAC,QAAQ,EAAE,EAAE,QAAQ,EAAE,MAAM,EAAE,CAAC,CAAC;IACpE,OAAO,QAAQ,CAAC,WAAW,CAAC,CAAC;AAC/B,CAAC;AAHD,oCAGC;AAED;;;;;;;GAOG;AACH,SAAS,QAAQ,CAAC,GAAW;IAC3B,IAAI,GAAG,CAAC,UAAU,CAAC,CAAC,CAAC,KAAK,QAAQ,EAAE,CAAC;QACnC,OAAO,GAAG,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;IACtB,CAAC;IACD,OAAO,GAAG,CAAC;AACb,CAAC;AACD;;;;GAIG;AACH,SAAgB,UAAU,CAAC,IAAY;IACrC,OAAO,IAAI,CAAC,OAAO,CAAC,SAAS,EAAE,GAAG,CAAC,CAAC;AACtC,CAAC;AAFD,gCAEC;AAED;;;;GAIG;AAEH,SAAgB,UAAU,CAAC,GAAW,EAAE,IAAY;IAClD,MAAM,QAAQ,GAAG,cAAI,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IACtC,IAAI,YAAE,CAAC,UAAU,CAAC,QAAQ,CAAC,EAAE,CAAC;QAC5B,OAAO,QAAQ,CAAC;IAClB,CAAC;IACD,MAAM,SAAS,GAAG,cAAI,CAAC,OAAO,CAAC,GAAG,EAAE,IAAI,CAAC,CAAC;IAC1C,IAAI,GAAG,KAAK,SAAS,EAAE,CAAC;QACtB,OAAO,IAAI,CAAC;IACd,CAAC;IACD,OAAO,UAAU,CAAC,SAAS,EAAE,IAAI,CAAC,CAAC;AACrC,CAAC;AAVD,gCAUC"}

package/lib/helpers/find-files.d.ts

@@ -0,0 +1,30 @@
+type ParserFunction = (filename: string, contents: string | null) => unknown;
+type RawFilter = {
+    pattern: string;
+    parser?: ParserFunction;
+};
+/**
+ * filterId -> filter
+ */
+type RawFilterMap = Record<string, RawFilter>;
+export interface File<T> {
+    filename: string;
+    contents: T;
+}
+/**
+ * filterId -> dirname -> files
+ */
+type FilesByFilter = {
+    [filter: string]: Record<string, File<unknown>[]>;
+};
+/**
+ * Traverse the directory tree recursively from `dir` and
+ * gather files matching the `inclusionFilters`
+ * that were not matching the `exclusionPatterns`.
+ *
+ * @param rawDir directory where the search starts
+ * @param inclusionFilters glob patterns to search for, and parser function
+ * @param exclusions glob patterns to ignore while walking the tree
+ */
+export declare function searchFiles(rawDir: string, inclusionFilters: RawFilterMap, exclusions: string[]): FilesByFilter;
+export {};

package/lib/helpers/find-files.js

@@ -0,0 +1,106 @@
+"use strict";
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.searchFiles = void 0;
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+const fs_1 = __importDefault(require("fs"));
+const path_1 = __importDefault(require("path"));
+const minimatch_1 = require("minimatch");
+const files_1 = require("./files");
+function debug(message) {
+    console.log(`DEBUG ${message}`);
+}
+// Patterns enforced to be ignored no matter what the user configures on sonar.properties
+const IGNORED_PATTERNS = ['.scannerwork'];
+/**
+ * Traverse the directory tree recursively from `dir` and
+ * gather files matching the `inclusionFilters`
+ * that were not matching the `exclusionPatterns`.
+ *
+ * @param rawDir directory where the search starts
+ * @param inclusionFilters glob patterns to search for, and parser function
+ * @param exclusions glob patterns to ignore while walking the tree
+ */
+function searchFiles(rawDir, inclusionFilters, exclusions) {
+    const dir = path_1.default.posix.normalize((0, files_1.toUnixPath)(rawDir));
+    const compiledInclusionFilters = compilePatterns(inclusionFilters);
+    const exclusionPatterns = stringToGlob(exclusions.concat(IGNORED_PATTERNS));
+    const result = {};
+    for (const filterId of Object.keys(inclusionFilters)) {
+        result[filterId] = {};
+    }
+    const dirs = [dir];
+    while (dirs.length) {
+        const dir = dirs.shift();
+        for (const filterId of Object.keys(compiledInclusionFilters)) {
+            result[filterId][dir] = [];
+        }
+        const files = fs_1.default.readdirSync(dir, { withFileTypes: true });
+        for (const file of files) {
+            const filename = path_1.default.posix.join(dir, file.name);
+            if (exclusionPatterns.some(pattern => pattern.match(filename))) {
+                continue;
+            }
+            if (file.isDirectory()) {
+                dirs.push(filename);
+            }
+            else {
+                for (const [filterId, filter] of Object.entries(compiledInclusionFilters)) {
+                    filterAndParse(filename, filter, result[filterId][dir]);
+                }
+            }
+        }
+    }
+    return result;
+}
+exports.searchFiles = searchFiles;
+function filterAndParse(filename, { patterns, parser }, db) {
+    if (patterns.some(pattern => pattern.match(filename))) {
+        debug(`Found file: ${filename}`);
+        if (!parser) {
+            db.push({ filename, contents: undefined });
+            return;
+        }
+        try {
+            const contents = (0, files_1.readFileSync)(filename);
+            db.push({ filename, contents: parser(filename, contents) });
+        }
+        catch (e) {
+            debug(`Error parsing file ${filename}: ${e}`);
+        }
+    }
+}
+function stringToGlob(patterns) {
+    return patterns.map(pattern => new minimatch_1.Minimatch(pattern, { nocase: true, matchBase: true }));
+}
+function compilePatterns(filters) {
+    const compiledFilterMap = {};
+    for (const [filterId, filter] of Object.entries(filters)) {
+        compiledFilterMap[filterId] = {
+            patterns: stringToGlob(filter.pattern.split(',')),
+            parser: filter.parser,
+        };
+    }
+    return compiledFilterMap;
+}
+//# sourceMappingURL=find-files.js.map

package/lib/helpers/find-files.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"find-files.js","sourceRoot":"","sources":["../../helpers/find-files.ts"],"names":[],"mappings":";;;;;;AAAA;;;;;;;;;;;;;;;;;;GAkBG;AACH,4CAAoB;AACpB,gDAAwB;AACxB,yCAAsC;AACtC,mCAAmD;AAEnD,SAAS,KAAK,CAAC,OAAe;IAC5B,OAAO,CAAC,GAAG,CAAC,SAAS,OAAO,EAAE,CAAC,CAAC;AAClC,CAAC;AAED,yFAAyF;AACzF,MAAM,gBAAgB,GAAG,CAAC,cAAc,CAAC,CAAC;AA+B1C;;;;;;;;GAQG;AACH,SAAgB,WAAW,CAAC,MAAc,EAAE,gBAA8B,EAAE,UAAoB;IAC9F,MAAM,GAAG,GAAG,cAAI,CAAC,KAAK,CAAC,SAAS,CAAC,IAAA,kBAAU,EAAC,MAAM,CAAC,CAAC,CAAC;IACrD,MAAM,wBAAwB,GAAG,eAAe,CAAC,gBAAgB,CAAC,CAAC;IACnE,MAAM,iBAAiB,GAAG,YAAY,CAAC,UAAU,CAAC,MAAM,CAAC,gBAAgB,CAAC,CAAC,CAAC;IAE5E,MAAM,MAAM,GAAkB,EAAE,CAAC;IACjC,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,gBAAgB,CAAC,EAAE,CAAC;QACrD,MAAM,CAAC,QAAQ,CAAC,GAAG,EAAE,CAAC;IACxB,CAAC;IAED,MAAM,IAAI,GAAG,CAAC,GAAG,CAAC,CAAC;IACnB,OAAO,IAAI,CAAC,MAAM,EAAE,CAAC;QACnB,MAAM,GAAG,GAAG,IAAI,CAAC,KAAK,EAAG,CAAC;QAC1B,KAAK,MAAM,QAAQ,IAAI,MAAM,CAAC,IAAI,CAAC,wBAAwB,CAAC,EAAE,CAAC;YAC7D,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,GAAG,EAAE,CAAC;QAC7B,CAAC;QACD,MAAM,KAAK,GAAG,YAAE,CAAC,WAAW,CAAC,GAAG,EAAE,EAAE,aAAa,EAAE,IAAI,EAAE,CAAC,CAAC;QAC3D,KAAK,MAAM,IAAI,IAAI,KAAK,EAAE,CAAC;YACzB,MAAM,QAAQ,GAAG,cAAI,CAAC,KAAK,CAAC,IAAI,CAAC,GAAG,EAAE,IAAI,CAAC,IAAI,CAAC,CAAC;YACjD,IAAI,iBAAiB,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;gBAC/D,SAAS;YACX,CAAC;YACD,IAAI,IAAI,CAAC,WAAW,EAAE,EAAE,CAAC;gBACvB,IAAI,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;YACtB,CAAC;iBAAM,CAAC;gBACN,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,wBAAwB,CAAC,EAAE,CAAC;oBAC1E,cAAc,CAAC,QAAQ,EAAE,MAAM,EAAE,MAAM,CAAC,QAAQ,CAAC,CAAC,GAAG,CAAC,CAAC,CAAC;gBAC1D,CAAC;YACH,CAAC;QACH,CAAC;IACH,CAAC;IACD,OAAO,MAAM,CAAC;AAChB,CAAC;AAhCD,kCAgCC;AAED,SAAS,cAAc,CACrB,QAAgB,EAChB,EAAE,QAAQ,EAAE,MAAM,EAAkB,EACpC,EAAmB;IAEnB,IAAI,QAAQ,CAAC,IAAI,CAAC,OAAO,CAAC,EAAE,CAAC,OAAO,CAAC,KAAK,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAC;QACtD,KAAK,CAAC,eAAe,QAAQ,EAAE,CAAC,CAAC;QACjC,IAAI,CAAC,MAAM,EAAE,CAAC;YACZ,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,SAAS,EAAE,CAAC,CAAC;YAC3C,OAAO;QACT,CAAC;QACD,IAAI,CAAC;YACH,MAAM,QAAQ,GAAG,IAAA,oBAAY,EAAC,QAAQ,CAAC,CAAC;YACxC,EAAE,CAAC,IAAI,CAAC,EAAE,QAAQ,EAAE,QAAQ,EAAE,MAAM,CAAC,QAAQ,EAAE,QAAQ,CAAC,EAAE,CAAC,CAAC;QAC9D,CAAC;QAAC,OAAO,CAAC,EAAE,CAAC;YACX,KAAK,CAAC,sBAAsB,QAAQ,KAAK,CAAC,EAAE,CAAC,CAAC;QAChD,CAAC;IACH,CAAC;AACH,CAAC;AAED,SAAS,YAAY,CAAC,QAAkB;IACtC,OAAO,QAAQ,CAAC,GAAG,CAAC,OAAO,CAAC,EAAE,CAAC,IAAI,qBAAS,CAAC,OAAO,EAAE,EAAE,MAAM,EAAE,IAAI,EAAE,SAAS,EAAE,IAAI,EAAE,CAAC,CAAC,CAAC;AAC5F,CAAC;AAED,SAAS,eAAe,CAAC,OAAqB;IAC5C,MAAM,iBAAiB,GAAc,EAAE,CAAC;IACxC,KAAK,MAAM,CAAC,QAAQ,EAAE,MAAM,CAAC,IAAI,MAAM,CAAC,OAAO,CAAC,OAAO,CAAC,EAAE,CAAC;QACzD,iBAAiB,CAAC,QAAQ,CAAC,GAAG;YAC5B,QAAQ,EAAE,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC,KAAK,CAAC,GAAG,CAAC,CAAC;YACjD,MAAM,EAAE,MAAM,CAAC,MAAM;SACtB,CAAC;IACJ,CAAC;IACD,OAAO,iBAAiB,CAAC;AAC3B,CAAC"}

package/lib/helpers/generate-meta.d.ts

@@ -0,0 +1,2 @@
+import { Rule } from 'eslint';
+export declare function generateMeta(rspecMeta: Rule.RuleMetaData, ruleMeta?: Rule.RuleMetaData): Rule.RuleMetaData;

package/lib/helpers/generate-meta.js

@@ -0,0 +1,39 @@
+"use strict";
+/*
+ * SonarQube JavaScript Plugin
+ * Copyright (C) 2011-2024 SonarSource SA
+ * mailto:info AT sonarsource DOT com
+ *
+ * This program is free software; you can redistribute it and/or
+ * modify it under the terms of the GNU Lesser General Public
+ * License as published by the Free Software Foundation; either
+ * version 3 of the License, or (at your option) any later version.
+ *
+ * This program is distributed in the hope that it will be useful,
+ * but WITHOUT ANY WARRANTY; without even the implied warranty of
+ * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+ * Lesser General Public License for more details.
+ *
+ * You should have received a copy of the GNU Lesser General Public License
+ * along with this program; if not, write to the Free Software Foundation,
+ * Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301, USA.
+ */
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.generateMeta = void 0;
+function generateMeta(rspecMeta, ruleMeta) {
+    if (rspecMeta.fixable && !ruleMeta?.fixable && !ruleMeta?.hasSuggestions) {
+        throw new Error(`Mismatch between RSPEC metadata and implementation for fixable attribute in rule ${rspecMeta.docs.url}`);
+    }
+    //rspec metadata should overwrite eslint metadata for decorated rules, our titles and docs should be shown instead
+    const metadata = {
+        ...ruleMeta,
+        ...rspecMeta,
+    };
+    if (!metadata.messages) {
+        metadata.messages = {};
+    }
+    metadata.messages.sonarRuntime = '{{sonarRuntimeData}}';
+    return metadata;
+}
+exports.generateMeta = generateMeta;
+//# sourceMappingURL=generate-meta.js.map

package/lib/helpers/generate-meta.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"generate-meta.js","sourceRoot":"","sources":["../../helpers/generate-meta.ts"],"names":[],"mappings":";AAAA;;;;;;;;;;;;;;;;;;GAkBG;;;AAIH,SAAgB,YAAY,CAC1B,SAA4B,EAC5B,QAA4B;IAE5B,IAAI,SAAS,CAAC,OAAO,IAAI,CAAC,QAAQ,EAAE,OAAO,IAAI,CAAC,QAAQ,EAAE,cAAc,EAAE,CAAC;QACzE,MAAM,IAAI,KAAK,CACb,oFAAoF,SAAS,CAAC,IAAK,CAAC,GAAG,EAAE,CAC1G,CAAC;IACJ,CAAC;IACD,kHAAkH;IAClH,MAAM,QAAQ,GAAG;QACf,GAAG,QAAQ;QACX,GAAG,SAAS;KACb,CAAC;IAEF,IAAI,CAAC,QAAQ,CAAC,QAAQ,EAAE,CAAC;QACvB,QAAQ,CAAC,QAAQ,GAAG,EAAE,CAAC;IACzB,CAAC;IAED,QAAQ,CAAC,QAAQ,CAAC,YAAY,GAAG,sBAAsB,CAAC;IAExD,OAAO,QAAQ,CAAC;AAClB,CAAC;AAtBD,oCAsBC"}

package/lib/helpers/globals.d.ts

@@ -0,0 +1,32 @@
+export declare const globalsByLibraries: {
+    builtin: string[];
+    browser: string[];
+    worker: string[];
+    node: string[];
+    commonjs: string[];
+    amd: string[];
+    mocha: string[];
+    jasmine: string[];
+    jest: string[];
+    qunit: string[];
+    phantomjs: string[];
+    couch: string[];
+    rhino: string[];
+    nashorn: string[];
+    wsh: string[];
+    jquery: string[];
+    yui: string[];
+    shelljs: string[];
+    prototypejs: string[];
+    meteor: string[];
+    mongo: string[];
+    applescript: string[];
+    serviceworker: string[];
+    atomtest: string[];
+    embertest: string[];
+    protractor: string[];
+    'shared-node-browser': string[];
+    webextensions: string[];
+    greasemonkey: string[];
+    flow: string[];
+};