@asd14/eslint-config 10.3.0 → 11.0.0

package/src/utils/find-up-sync.js

@@ -0,0 +1,56 @@
+import fs from "node:fs"
+import path from "node:path"
+
+/**
+ * @typedef {Object} FindUpSyncOptions
+ *
+ * @property {string} [cwd] - The current working directory to start from.
+ */
+
+/**
+ * @callback FindUpSyncFn
+ *
+ * @param {string} fileName - The name of the file to find.
+ * @param {FindUpSyncOptions} [options] - Options for the function.
+ * @returns {string} The absolute path to the file.
+ */
+
+/**
+ * Find a file up the directory tree synchronously.
+ *
+ * @type {FindUpSyncFn}
+ *
+ * @throws {Error} If the starting folder does not exist.
+ *
+ * @throws {Error} If the file does not exist up the tree.
+ *
+ * @example
+ *  const filePath = findUpSync("lerna.json");
+ *  //=> "/Users/johndoe/Projects/WootWoot/lerna.json"
+ *
+ */
+const findUpSync = (fileName, options = {}) => {
+  let { cwd } = options
+  cwd = path.resolve(cwd ?? process.cwd())
+
+  if (!fs.statSync(cwd).isDirectory()) {
+    throw new Error(`Path "${cwd}" does not exist or is not a directory`)
+  }
+
+  let { root } = path.parse(cwd)
+
+  while (cwd !== root) {
+    const file_path = path.join(cwd, fileName)
+
+    if (fs.existsSync(file_path)) {
+      return file_path
+    }
+
+    cwd = path.dirname(cwd)
+    root = path.parse(cwd).root
+  }
+
+  throw new Error(`File "${fileName}" does not exist up the tree`)
+}
+
+export { findUpSync }

package/rules/best-practices.js

@@ -1,11 +0,0 @@
-module.exports = {
-  rules: {
-    // Encourages use of dot notation whenever possible
-    "dot-notation": [
-      "error",
-      {
-        allowKeywords: true,
-      },
-    ],
-  },
-}

package/rules/comments.js

@@ -1,46 +0,0 @@
-module.exports = {
-  rules: {
-    /*
-     * Enforce a consistent style of comments across your codebase,
-     * specifically by either requiring or disallowing a capitalized
-     * letter as the first word character in a comment. This rule will not
-     * issue warnings when non-cased letters are used.
-     */
-    "capitalized-comments": "off",
-
-    /*
-     * Enforces consistent position of line comments. Block comments are
-     * not affected by this rule. By default, this rule ignores comments
-     * starting with the following words: eslint, jshint, jslint,
-     * istanbul, global, exported, jscs, falls through.
-     */
-    "line-comment-position": [
-      "error",
-      {
-        position: "above",
-      },
-    ],
-
-    // Disallow usage of configurable warning terms in comments: e.g. todo
-    "no-warning-comments": [
-      0,
-      {
-        location: "start",
-        terms: ["todo", "fixme", "xxx"],
-      },
-    ],
-
-    /*
-     * Enforce consistency of spacing after the start of a comment // or
-     * /*. It also provides several exceptions for various documentation
-     * styles.
-     */
-    "spaced-comment": ["error", "always"],
-
-    /*
-     * This rule aims to enforce a particular style for
-     * multiline comments.
-     */
-    "multiline-comment-style": "off",
-  },
-}

package/rules/errors.js

@@ -1,112 +0,0 @@
-module.exports = {
-  rules: {
-    /*
-     * A for loop with a stop condition that can never be reached, such as
-     * one with a counter that moves in the wrong direction, will run
-     * infinitely. While there are occasions when an infinite loop is
-     * intended, the convention is to construct such loops as while loops.
-     * More typically, an infinite for loop is a bug.
-     */
-    "for-direction": "error",
-
-    // Disallow assignment in conditional expressions
-    "no-cond-assign": ["error", "always"],
-
-    // Disallow use of console
-    "no-console": 1,
-
-    // Disallow use of constant expressions in conditions
-    "no-constant-condition": 1,
-
-    // Disallow control characters in regular expressions
-    "no-control-regex": "error",
-
-    // Disallow use of debugger
-    "no-debugger": 1,
-
-    // Disallow duplicate arguments in functions
-    "no-dupe-args": "error",
-
-    // Disallow duplicate keys when creating object literals
-    "no-dupe-keys": "error",
-
-    // Disallow a duplicate case label.
-    "no-duplicate-case": "error",
-
-    // Disallow empty statements
-    "no-empty": "error",
-
-    // Disallow the use of empty character classes in regular expressions
-    "no-empty-character-class": "error",
-
-    // Disallow assigning to the exception in a catch block
-    "no-ex-assign": "error",
-
-    // Disallow double-negation boolean casts in a boolean context
-    "no-extra-boolean-cast": 0,
-
-    // Disallow overwriting functions written as function declarations
-    "no-func-assign": "error",
-
-    // Disallow function or variable declarations in nested blocks
-    "no-inner-declarations": "error",
-
-    /*
-     * Disallow invalid regular expression strings in the RegExp
-     * Constructor
-     */
-    "no-invalid-regexp": "error",
-
-    // Disallow irregular whitespace outside of strings and comments
-    "no-irregular-whitespace": "error",
-
-    // Disallow negation of the left operand of an in expression
-    "no-negated-in-lhs": "error",
-
-    /*
-     * Disallow the use of object properties of the global object (Math
-     * And JSON) as functions
-     */
-    "no-obj-calls": "error",
-
-    // Disallow multiple spaces in a regular expression literal
-    "no-regex-spaces": "error",
-
-    /*
-     * This rule disallows sparse array literals which have "holes" where
-     * Commas are not preceded by elements. It does not apply to a
-     * Trailing comma following the last element.
-     */
-    "no-sparse-arrays": "error",
-
-    /*
-     * Disallow unreachable statements after a return, throw, continue, or
-     * Break statement
-     */
-    "no-unreachable": "error",
-
-    // Disallow comparisons with the value NaN
-    "use-isnan": "error",
-
-    /*
-     * Ensure that the results of typeof are compared against a valid
-     * String
-     */
-    "valid-typeof": "error",
-
-    // Enforces that a return statement is present in property getters
-    "getter-return": "error",
-
-    /*
-     * The parseInt() and Number.parseInt() functions can be used to turn
-     * binary, octal, and hexadecimal strings into integers. As binary,
-     * octal, and hexadecimal literals are supported in ES6, this rule
-     * encourages use of those numeric literals instead of parseInt() or
-     * Number.parseInt().
-     *
-     * 0b111110111 === 503; // not parseInt("111110111", 2) === 503;
-     * 0o767 === 503; // not parseInt("767", 8) === 503;
-     */
-    "prefer-numeric-literals": "error",
-  },
-}

package/rules/es6.js

@@ -1,48 +0,0 @@
-module.exports = {
-  rules: {
-    // Require braces in arrow function body
-    "arrow-body-style": ["error", "as-needed"],
-
-    // Verify super() callings in constructors
-    "constructor-super": 0,
-
-    // Disallow modifying variables of class declarations
-    "no-class-assign": 0,
-
-    // Disallow modifying variables that are declared using const
-    "no-const-assign": "error",
-
-    // Disallow duplicate name in class members
-    "no-dupe-class-members": 0,
-
-    // Disallow to use this/super before super() calling in constructors.
-    "no-this-before-super": 0,
-
-    // Require let or const instead of var
-    "no-var": "error",
-
-    // Require method and property shorthand syntax for object literals
-    "object-shorthand": ["warn", "always"],
-
-    // Suggest using arrow functions as callbacks
-    "prefer-arrow-callback": "warn",
-
-    /*
-     * Suggest using of const declaration for variables that are never
-     * Modified after declared
-     */
-    "prefer-const": "error",
-
-    // Suggest using Reflect methods where applicable
-    "prefer-reflect": 0,
-
-    // Suggest using the spread operator instead of .apply()
-    "prefer-spread": 0,
-
-    // Suggest using template literals instead of strings concatenation
-    "prefer-template": "error",
-
-    // Disallow generator functions that do not have yield
-    "require-yield": 0,
-  },
-}

package/rules/html.js

@@ -1,59 +0,0 @@
-module.exports = {
-  plugins: ["html"],
-  settings: {
-    /*
-     * By default, this plugin will only consider files ending with those
-     * extensions as HTML: .erb, .handlebars, .hbs, .htm, .html,
-     * .mustache, .nunjucks, .php, .tag, .twig, .vue, .we. You can set
-     * your own list of HTML extensions by using this setting. Example:
-     */
-    "html/html-extensions": [
-      ".erb",
-      ".handlebars",
-      ".hbs",
-      ".htm",
-      ".html",
-      ".mustache",
-      ".nunjucks",
-      ".php",
-      ".tag",
-      ".twig",
-      ".vue",
-      ".we",
-    ],
-
-    /*
-     * By default, this plugin will only consider files ending with those
-     * extensions as XML: .xhtml, .xml. You can set your own list of XML
-     * extensions by using this setting. Example:
-     */
-    "html/xml-extensions": [".xhtml", ".xml"],
-
-    /*
-     * Indentation is the <script> indentation plus two spaces.
-     */
-    "html/indent": "+0",
-
-    /*
-     * By default, this plugin won't warn if it encounters a problematic
-     * indentation (ex: a line is under indented). If you want to make
-     * sure the indentation is correct, use the html/report-bad-indent in
-     * conjunction with the indent rule. Pass "warn" or 1 to display
-     * warnings, "error" or 2 to display errors. Example:
-     */
-    "html/report-bad-indent": "error",
-
-    /*
-     * By default, the code between <script> tags is considered as
-     * JavaScript code only if there is no type attribute or if its value
-     * matches the pattern:
-     * /^(application|text)\/(x-)?(javascript|babel|ecmascript-6)$/i
-     *
-     * You can customize the types that should be considered as JavaScript
-     * by providing one or multiple MIME types. If a MIME type starts with
-     * a /, it will be considered as a regular expression.
-     */
-    "html/javascript-mime-types":
-      "/^(application|text)/(x-)?(javascript|babel|ecmascript-6)$/i",
-  },
-}

package/rules/import-ts.js

@@ -1,41 +0,0 @@
-module.exports = {
-  extends: ["plugin:import/typescript"],
-
-  rules: {
-    /*
-     * TypeScript compilation already ensures that named imports exist in the
-     * referenced module
-     */
-    "import/named": "off",
-
-    // Typescript handles file resolving
-    "import/no-unresolved": "off",
-
-    /*
-     * A list of file extensions that will be parsed as modules and
-     * inspected for exports.
-     */
-    "import/extensions": [
-      "error",
-      "always",
-      {
-        js: "always",
-        ts: "never",
-      },
-    ],
-  },
-
-  settings: {
-    "import/external-module-folders": ["node_modules", "node_modules/@types"],
-
-    "import/parsers": {
-      "@typescript-eslint/parser": [".ts", ".tsx", ".d.ts"],
-    },
-
-    "import/resolver": {
-      node: {
-        extensions: [".ts", ".tsx", ".d.ts", ".js", ".jsx"],
-      },
-    },
-  },
-}

package/rules/import.js

@@ -1,101 +0,0 @@
-module.exports = {
-  plugins: ["import", "no-relative-import-paths"],
-  extends: ["plugin:import/recommended"],
-  rules: {
-    "no-relative-import-paths/no-relative-import-paths": "off",
-
-    /*
-     * Sort alphabetically, and enforce that all imports are at the top
-     * of the file.
-     */
-    "import/order": [
-      "error",
-      {
-        "newlines-between": "always",
-        "alphabetize": {
-          order: "asc",
-          caseInsensitive: true,
-        },
-      },
-    ],
-
-    /*
-     * If a default import is requested, this rule will report if there is
-     * no default export in the imported module.
-     */
-    "import/default": "error",
-
-    /*
-     * Reports funny business with exports, like repeated exports of names
-     * or defaults.
-     */
-    "import/export": "error",
-
-    /*
-     * Verifies that all named imports are part of the set of named
-     * exports in the referenced module.
-     */
-    "import/named": "error",
-
-    /*
-     * Enforces names exist at the time they are dereferenced, when
-     * imported as a full namespace (i.e. import * as foo from './foo';
-     * foo.bar(); will report if bar is not exported by ./foo.).
-     */
-    "import/namespace": [
-      "error",
-      {
-        allowComputed: true,
-      },
-    ],
-
-    // Reports if a resolved path is imported more than once.
-    "import/no-duplicates": "error",
-
-    /*
-     * Reports use of an exported name as the locally imported name of a
-     * default export.
-     */
-    "import/no-named-as-default": "error",
-
-    // Reports use of an exported name as a property on the default export.
-    "import/no-named-as-default-member": "error",
-
-    /*
-     * Ensures an imported module can be resolved to a module on the local
-     * filesystem, as defined by standard Node require.resolve behavior.
-     */
-    "import/no-unresolved": [
-      "error",
-      {
-        commonjs: true,
-      },
-    ],
-
-    /*
-     * Warn if a module could be mistakenly parsed as a script by a
-     * consumer leveraging Unambiguous JavaScript Grammar to determine
-     * correct parsing goal.
-     */
-    "import/unambiguous": "off",
-
-    /*
-     * A list of file extensions that will be parsed as modules and
-     * inspected for exports.
-     */
-    "import/extensions": [
-      "error",
-      "always",
-      {
-        js: "always",
-      },
-    ],
-
-    /*
-     * Enforces that all exports are declared at the bottom of the file.
-     * This rule will report any export declarations that comes before any
-     * non-export statements.
-     */
-    "import/exports-last": "error",
-  },
-}

package/rules/jsdoc-ts.js

@@ -1,8 +0,0 @@
-module.exports = {
-  rules: {
-    "valid-jsdoc": "off",
-    "jsdoc/require-param": "off",
-    "jsdoc/require-returns": "off",
-    "jsdoc/require-example": "error",
-  },
-}

package/rules/jsdoc.js

@@ -1,103 +0,0 @@
-/*
- * JSDoc is a JavaScript API documentation generator. It uses
- * specially-formatted comments inside of code to generate API
- * documentation automatically.
- */
-
-module.exports = {
-  plugins: ["jsdoc"],
-
-  extends: ["plugin:eslint-plugin-jsdoc/recommended"],
-
-  rules: {
-    "require-jsdoc": [
-      "error",
-      {
-        require: {
-          ArrowFunctionExpression: false,
-          ClassDeclaration: false,
-          FunctionDeclaration: true,
-          MethodDefinition: false,
-        },
-      },
-    ],
-
-    "valid-jsdoc": [
-      "error",
-      {
-        requireParamType: false,
-        requireParamDescription: false,
-        requireReturnType: false,
-        requireReturnDescription: false,
-
-        prefer: {
-          arg: "param",
-          argument: "param",
-          class: "constructor",
-          return: "returns",
-          virtual: "abstract",
-        },
-
-        preferType: {
-          Boolean: "boolean",
-          Number: "number",
-          object: "object",
-          String: "string",
-        },
-      },
-    ],
-
-    // Allow lines between tags
-    "jsdoc/tag-lines": "off",
-
-    "jsdoc/check-tag-names": [
-      "warn",
-      {
-        definedTags: [
-          "tag",
-          "signature",
-          "api",
-          "apiDefine",
-          "apiDeprecated",
-          "apiDescription",
-          "apiError",
-          "apiErrorExample",
-          "apiExample",
-          "apiGroup",
-          "apiHeader",
-          "apiHeaderExample",
-          "apiIgnore",
-          "apiName",
-          "apiParam",
-          "apiParamExample",
-          "apiPermission",
-          "apiPrivate",
-          "apiSampleRequest",
-          "apiSuccess",
-          "apiSuccessExample",
-          "apiUse",
-          "apiVersion",
-        ],
-      },
-    ],
-
-    // Noise
-    "jsdoc/require-param-description": "off",
-    "jsdoc/require-returns-description": "off",
-    "jsdoc/require-property-description": "off",
-    "jsdoc/check-types": "off",
-
-    "jsdoc/check-indentation": [
-      "error",
-      { excludeTags: ["example", "param", "returns", "type", "typedef"] },
-    ],
-
-    "jsdoc/check-line-alignment": [
-      "error",
-      "always",
-      {
-        tags: ["param", "arg", "argument", "property", "prop"],
-      },
-    ],
-  },
-}

package/rules/json.js

@@ -1,9 +0,0 @@
-module.exports = {
-  plugins: ["json"],
-
-  extends: ["plugin:json/recommended"],
-
-  rules: {
-    "json/colon-expected": "error",
-  },
-}

package/rules/node.js

@@ -1,56 +0,0 @@
-module.exports = {
-  rules: {
-    // Enforce return after a callback
-    "callback-return": 0,
-
-    // Disallow require() outside of the top-level module scope
-    "global-require": 0,
-
-    // Enforces error handling in callbacks (node environment)
-    "handle-callback-err": 0,
-
-    /*
-     * In Node.js, the behavior of the Buffer constructor is different
-     * depending on the type of its argument. Passing an argument from
-     * user input to Buffer() without validating its type can lead to
-     * security vulnerabilities such as remote memory disclosure and
-     * denial of service. As a result, the Buffer constructor has been
-     * deprecated and should not be used. Use the producer methods
-     * Buffer.from, Buffer.alloc, and Buffer.allocUnsafe instead.
-     */
-    "no-buffer-constructor": "error",
-
-    // Disallow mixing regular variable and require declarations
-    "no-mixed-requires": [0, false],
-
-    // Disallow use of new operator with the require function
-    "no-new-require": 0,
-
-    // Disallow string concatenation with __dirname and __filename
-    "no-path-concat": 0,
-
-    // Disallow process.exit()
-    "no-process-exit": 0,
-
-    // Restrict usage of specified node modules
-    "no-restricted-modules": 0,
-
-    /*
-     * In Node.js, most I/O is done through asynchronous methods. However,
-     * there are often synchronous versions of the asynchronous methods.
-     * For example, fs.exists() and fs.existsSync(). In some contexts,
-     * using synchronous operations is okay (if, as with ESLint, you are
-     * writing a command line utility). However, in other contexts the use
-     * of synchronous operations is considered a bad practice that should
-     * be avoided. For example, if you are running a high-travel web
-     * server on Node.js, you should consider carefully if you want to
-     * allow any synchronous operations that could lock up the server.
-     */
-    "no-sync": [
-      "error",
-      {
-        allowAtRootLevel: true,
-      },
-    ],
-  },
-}

package/rules/prettier.js

@@ -1,16 +0,0 @@
-module.exports = {
-  extends: ["plugin:prettier/recommended"],
-
-  rules: {
-    /**
-     * If a block (for example after if, else, for or while) contains only one
-     * statement, JavaScript allows omitting the curly braces around that
-     * statement. This rule enforces if or when those optional curly
-     * braces should be omitted.
-     *
-     * ! Needs to be Prettier compatible:
-     * https://github.com/prettier/eslint-config-prettier#curly
-     */
-    curly: ["error", "all"],
-  },
-}