@anolilab/eslint-config 5.0.9 → 6.0.0

package/config.cjs

@@ -1,88 +0,0 @@
-const { hasAnyDep, hasTypescript } = require("./lib/utils.cjs");
-const isModuleAvailable = require("./lib/is-module-available.cjs");
-
-// Base rules
-const rules = ["best-practices", "errors", "style", "es6", "variables"];
-
-// Base plugin rules
-const pRules = [
-    "compat",
-    "eslint-comments",
-    "import",
-    "json",
-    "jsonc",
-    "jsonc",
-    "markdown",
-    "optimize-regex",
-    "promise",
-    "simple-import-sort",
-    "toml",
-    "unicorn",
-    "yml",
-    "you-dont-need-lodash-underscore",
-    "you-dont-need-momentjs",
-
-    // Security Rules
-    "no-secrets",
-    "sonarjs",
-];
-
-// Optionals rules based on project dependencies
-const depRules = [
-    "array-func",
-    "html",
-    "jsdoc",
-    "lodash",
-    "mdx",
-    "no-unsanitized",
-    "react",
-    "react-redux",
-    ["lodash", "lodash-fp"],
-    ["react", "jsx-a11y"],
-    ["react", "react-hooks"],
-    "tailwindcss",
-];
-
-const testRules = [
-    "cypress",
-    "jest",
-    "jest-dom",
-    ["@testing-library/dom", "testing-library"],
-    ["@testing-library/jest-dom", "jest-dom"],
-    ["jest", "jest-async", "jest-dom"],
-    ["jest-formatting", "jest"],
-];
-
-// Extra required optional packages
-const extraInstalled = [];
-
-depRules.forEach((depRule) => {
-    const rule = typeof depRule === "string" ? [depRule, depRule] : depRule;
-
-    if (hasAnyDep(rule[0])) {
-        pRules.push(rule[1]);
-    }
-});
-
-testRules.forEach((depRule) => {
-    const rule = typeof depRule === "string" ? [depRule, depRule] : depRule;
-
-    if (isModuleAvailable(rule[0])) {
-        pRules.push(rule[1]);
-    }
-});
-
-if (hasTypescript) {
-    pRules.push("typescript");
-    extraInstalled.push(["typescript", "@typescript-eslint/parser"], ["typescript", "@typescript-eslint/eslint-plugin"]);
-
-    if (hasAnyDep("eslint-plugin-typescript-sort-keys")) {
-        pRules.push("typescript-sort-keys");
-    }
-}
-
-module.exports = {
-    rules,
-    pluginRules: pRules,
-    extraInstallPackage: extraInstalled,
-};

package/index.cjs

@@ -1,58 +0,0 @@
-const path = require("node:path");
-const checkMissing = require("./lib/check-missing.cjs");
-const showLoaded = require("./lib/show-loaded.cjs");
-const { rules, pluginRules, extraInstallPackage } = require("./config.cjs");
-
-// Workaround VS Code trying to run this file twice!
-if (!global.hasAnolilabEsLintConfigLoaded) {
-    checkMissing(pluginRules, extraInstallPackage);
-    showLoaded(pluginRules, extraInstallPackage);
-
-    global.hasAnolilabEsLintConfigLoaded = true;
-}
-
-module.exports = {
-    extends: [
-        ...rules
-            // eslint-disable-next-line no-undef
-            .map((plugin) => path.join(__dirname, `./rules/${plugin.split("@")[0]}.cjs`)),
-        // eslint-disable-next-line no-undef
-        ...pluginRules.map((plugin) => path.join(__dirname, `./rules/plugins/${plugin.split("@")[0]}.cjs`)),
-    ],
-    // @see https://www.npmjs.com/package/@rushstack/eslint-plugin-security
-    plugins: ["@rushstack/eslint-plugin-security"],
-    rules: {
-        // This is disabled for tools because, for example, it is a common and safe practice for a tool
-        // to read a RegExp from a config file and use it to filter files paths.
-        // eslint-disable-next-line no-undef
-        "@rushstack/security/no-unsafe-regexp": process.env.TRUSTED_TOOL ? "off" : "warn",
-    },
-    parserOptions: {
-        ecmaVersion: 12,
-        sourceType: "module",
-    },
-    env: {
-        es2021: true,
-    },
-    ignorePatterns: [
-        "!.*",
-
-        ".git/",
-        "node_modules/",
-        "bower_components/",
-        "jspm_packages/",
-        ".npm/",
-        "vendor/",
-
-        "lib-cov/",
-        "coverage/",
-        ".nyc_output/",
-        ".cache/",
-
-        "build/",
-        "dist/",
-        "tmp/",
-
-        "**/*.min.*",
-    ],
-};

package/lib/check-missing.cjs

@@ -1,57 +0,0 @@
-const isModuleAvailable = require("./is-module-available.cjs");
-const { consoleLog } = require("./loggers.cjs");
-
-const moduleNotAvailable = (package_) => !isModuleAvailable(package_);
-
-const atLatest = (package_) => {
-    if (!package_.split("@").includes("@")) {
-        return `${package_}@latest`;
-    }
-
-    return package_;
-};
-
-module.exports = function checkMissing(rules, extraInstallPackage) {
-    const notInstalled = rules
-        .map((plugin) => {
-            if (plugin === "typescript") {
-                return plugin;
-            }
-
-            return `eslint-plugin-${plugin}`;
-        })
-        .filter((package_) => moduleNotAvailable(package_));
-
-    extraInstallPackage.forEach(([rule, package_]) => {
-        if (rules.includes(rule) && moduleNotAvailable(package_)) {
-            notInstalled.push(package_);
-        }
-    });
-
-    if (notInstalled.length === 0) {
-        return;
-    }
-
-    const s = notInstalled.length === 1 ? "" : "s";
-
-    consoleLog(`\nOops! Something went wrong! :(
-
-@anolilab/eslint-config could not find the following package${s}
-
-  ${notInstalled.join("\n  ")}
-
-To install the missing package${s}, please run the following command:
-
-  npm install ${notInstalled.map((element) => atLatest(element)).join(" ")} --save-dev
-
-or
-
-  yarn add ${notInstalled.map((element) => atLatest(element)).join(" ")} --dev
-
-or
-
-  pnpm add ${notInstalled.map((element) => atLatest(element)).join(" ")} -D
-`);
-
-    // process.exit(1); // eslint-disable-line unicorn/no-process-exit
-};

package/lib/is-module-available.cjs

@@ -1,8 +0,0 @@
-module.exports = function isModuleAvailable(name) {
-    try {
-        require.resolve(name);
-        return true;
-    } catch {
-        return false;
-    }
-};

package/lib/loggers.cjs

@@ -1,12 +0,0 @@
-// eslint-disable-next-line unicorn/no-useless-undefined
-const noop = () => undefined;
-
-const consolePrefix = (prefix) =>
-    // eslint-disable-next-line no-console,implicit-arrow-linebreak,no-undef
-    ((process.env.NO_LOGS && process.env.NO_LOGS === "true") ? noop : (file) => console.log(`${prefix}${file}`));
-
-module.exports = {
-    consolePlugin: consolePrefix("  eslint-plugin-"),
-    consoleConfig: consolePrefix("  eslint-config-"),
-    consoleLog: consolePrefix(""),
-};

package/lib/postinstall.cjs

@@ -1,115 +0,0 @@
-#!/usr/bin/env node
-
-// eslint-disable-next-line no-undef
-if (process.env.CI) {
-    // eslint-disable-next-line no-undef
-    process.exit(0);
-}
-
-const { writeFile, existsSync } = require("node:fs");
-// eslint-disable-next-line unicorn/import-style
-const { resolve, join } = require("node:path");
-const { promisify } = require("node:util");
-
-const writeFileAsync = promisify(writeFile);
-
-// get the path to the host project.
-// eslint-disable-next-line no-undef
-const projectPath = resolve(process.cwd(), "..", "..", "..");
-
-console.log("Configuring @anolilab/eslint-config", projectPath, "\n");
-
-/**
- * Writes .eslintrc.cjs if it doesn't exist. Warns if it exists.
- */
-const writeEslintRc = () => {
-    const eslintPath = join(projectPath, ".eslintrc.cjs");
-    const content = `
-/** @ts-check */
-/** @type {import('eslint').Linter.Config} */
-module.exports = {
-    root: true,
-    extends: ["@anolilab/eslint-config"],
-    ignorePatterns: ["!**/*"],
-    env: {
-        // Your environments (which contains several predefined global variables)
-        // browser: true,
-        // node: true,
-        // mocha: true,
-        // jest: true,
-        // jquery: true
-    },
-    globals: {
-        // Your global variables (setting to false means it's not allowed to be reassigned)
-        // myGlobal: false
-    },
-    rules: {
-        // Customize your rules
-    },
-    overrides: [
-        {
-            files: ["*.ts", "*.tsx", "*.js", "*.jsx"],
-            // Set parserOptions.project for the project to allow TypeScript to create the type-checker behind the scenes when we run linting
-            "parserOptions": {
-            },
-            rules: {},
-        },
-        {
-            files: ["*.ts", "*.tsx"],
-            // Set parserOptions.project for the project to allow TypeScript to create the type-checker behind the scenes when we run linting
-            "parserOptions": {
-            },
-            rules: {},
-        },
-        {
-            files: ["*.js", "*.jsx"],
-            rules: {},
-        },
-    ],
-};
-`;
-
-    if (existsSync(eslintPath)) {
-        console.warn(`⚠️  .eslintrc.cjs already exists;
-Make sure that it includes the following for @anolilab/eslint-config'
-to work as it should: { extends: ["@anolilab/eslint-config"] }.`);
-
-        return Promise.resolve();
-    }
-
-    return writeFileAsync(eslintPath, content, "utf-8");
-};
-
-/**
- * Writes .eslintignore if it doesn't exist. Warns if it exists.
- */
-const writeEslintIgnore = () => {
-    const eslintIgnorePath = join(projectPath, ".eslintignore");
-
-    if (existsSync(eslintIgnorePath)) {
-        console.warn("⚠️  .eslintignore already exists");
-
-        return Promise.resolve();
-    }
-
-    return writeFileAsync(eslintIgnorePath, "", "utf-8");
-};
-
-// eslint-disable-next-line unicorn/prefer-top-level-await
-(async () => {
-    try {
-        // eslint-disable-next-line compat/compat
-        await Promise.all([writeEslintRc(), writeEslintIgnore()]);
-
-        console.log("😎  Everything went well, have fun!");
-
-        // eslint-disable-next-line no-undef
-        process.exit(0);
-    } catch (error) {
-        console.log("😬  something went wrong:");
-        console.error(error.message);
-
-        // eslint-disable-next-line no-undef
-        process.exit(1);
-    }
-})();

package/lib/show-loaded.cjs

@@ -1,21 +0,0 @@
-const { consoleLog, consolePlugin } = require("./loggers.cjs");
-
-module.exports = function showLoaded(rules, extraInstallPackage) {
-    const all = [...rules];
-
-    extraInstallPackage.forEach(([rule, package_]) => {
-        if (all.includes(rule)) {
-            all.push(package_);
-        }
-    });
-
-    consoleLog("\n@anolilab/eslint-config loaded the following packages:\n");
-
-    all.forEach((element) => {
-        if (element[0] === "@" || element === "typescript") {
-            consoleLog(`  ${element}`);
-        } else {
-            consolePlugin(element);
-        }
-    });
-};

package/lib/utils.cjs

@@ -1,90 +0,0 @@
-// From kcd-scripts
-const { existsSync, realpathSync } = require("node:fs");
-// eslint-disable-next-line unicorn/import-style
-const { dirname, join } = require("node:path");
-// eslint-disable-next-line lodash/import-scope
-const has = require("lodash.has");
-const readPkgUp = require("read-pkg-up");
-
-function arrify(value) {
-    if (value === null || value === undefined) {
-        return [];
-    }
-
-    if (Array.isArray(value)) {
-        return value;
-    }
-
-    if (typeof value === "string") {
-        return [value];
-    }
-
-    if (typeof value[Symbol.iterator] === "function") {
-        return [...value];
-    }
-
-    return [value];
-}
-
-// eslint-disable-next-line @typescript-eslint/naming-convention
-const { packageJson: package_, path: packagePath } = readPkgUp.sync({
-    // eslint-disable-next-line no-undef
-    cwd: realpathSync(process.cwd()),
-});
-// eslint-disable-next-line max-len
-const hasPackageProperty = (properties) => arrify(properties).some((property) => has(package_, property)); // eslint-disable-line lodash-fp/no-extraneous-function-wrapping
-
-const hasPackageSubProperty = (packageProperty) => (properties) => hasPackageProperty(arrify(properties).map((p) => `${packageProperty}.${p}`));
-
-function environmentIsSet(name) {
-    return (
-        // eslint-disable-next-line no-undef
-        process.env.hasOwnProperty(name) // eslint-disable-line no-prototype-builtins
-        // eslint-disable-next-line no-undef
-        && process.env[name]
-        // eslint-disable-next-line no-undef
-        && process.env[name] !== "undefined"
-    );
-}
-
-// eslint-disable-next-line unicorn/prevent-abbreviations
-function parseEnvironment(name, def) {
-    if (environmentIsSet(name)) {
-        try {
-            // eslint-disable-next-line no-undef
-            return JSON.parse(process.env[name]);
-        } catch {
-            // eslint-disable-next-line no-undef
-            return process.env[name];
-        }
-    }
-    return def;
-}
-
-const appDirectory = dirname(packagePath);
-const fromRoot = (...p) => join(appDirectory, ...p);
-const hasFile = (...p) => existsSync(fromRoot(...p));
-const hasScript = hasPackageSubProperty("scripts");
-const hasPeerDep = hasPackageSubProperty("peerDependencies");
-const hasDep = hasPackageSubProperty("dependencies");
-const hasDevelopmentDep = hasPackageSubProperty("devDependencies");
-const hasAnyDep = (arguments_) => [hasDep, hasDevelopmentDep, hasPeerDep].some((function_) => function_(arguments_));
-const hasTypescript = hasAnyDep("typescript") && hasFile("tsconfig.json");
-
-module.exports = {
-    uniq: function uniq(array) {
-        return [...new Set(array)];
-    },
-    hasPkgProp: hasPackageProperty,
-    parseEnv: parseEnvironment,
-    pkg: package_,
-    appDirectory,
-    fromRoot,
-    hasFile,
-    hasScript,
-    hasPeerDep,
-    hasDep,
-    hasDevelopmentDep,
-    hasAnyDep,
-    hasTypescript,
-};