@metamask-previews/oxlint-config 0.0.0-preview-60e73da

package/CHANGELOG.md

@@ -0,0 +1,10 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+## [Unreleased]
+
+[Unreleased]: https://github.com/MetaMask/oxlint-config/

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2020 MetaMask
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,30 @@
+# `@metamask/oxlint-config`
+
+MetaMask's base Oxlint configuration.
+
+## Usage
+
+```bash
+yarn add --dev \
+    @metamask/oxlint-config@^0.0.0 \
+    oxlint@^1.82.0
+```
+
+The order in which you extend ESLint rules matters.
+The `@metamask/*` Oxlint configs should be added to the config array _last_,
+with `@metamask/oxlint-config` first, and `@metamask/oxlint-config-*` in any
+order thereafter.
+
+```js
+import base, { createConfig } from '@metamask/oxlint-config';
+
+const config = createConfig({
+  extends: [
+    // Any custom shared config should be added here.
+    // ...
+
+    // This should be added last unless you know what you're doing.
+    base,
+  ],
+});
+```

package/package.json

@@ -0,0 +1,47 @@
+{
+  "name": "@metamask-previews/oxlint-config",
+  "version": "0.0.0-preview-60e73da",
+  "description": "Shareable MetaMask Oxlint config",
+  "homepage": "https://github.com/MetaMask/oxlint-config#readme",
+  "bugs": {
+    "url": "https://github.com/MetaMask/oxlint-config/issues"
+  },
+  "license": "MIT",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/MetaMask/oxlint-config.git"
+  },
+  "files": [
+    "src/",
+    "!src/**/*.test.js"
+  ],
+  "type": "module",
+  "exports": {
+    ".": {
+      "types": "./src/index.d.ts",
+      "default": "./src/index.js"
+    }
+  },
+  "publishConfig": {
+    "access": "public",
+    "registry": "https://registry.npmjs.org/"
+  },
+  "scripts": {
+    "changelog:update": "../../scripts/update-changelog.sh @metamask/oxlint-config",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/oxlint-config",
+    "test": "oxlint ."
+  },
+  "dependencies": {
+    "deepmerge": "^4.3.1"
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "oxlint": "^1.82.0"
+  },
+  "peerDependencies": {
+    "oxlint": "^1.82.0"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,15 @@
+import type { OxlintConfig } from 'oxlint';
+
+/**
+ * Create a new Oxlint configuration object by merging extended configurations
+ * with the main configuration.
+ *
+ * @param options - An object containing custom configuration options to
+ *   override or extend the base configuration.
+ * @returns A new Oxlint configuration object that combines the base
+ *   configuration with the provided extensions.
+ */
+export function createConfig(options: Partial<OxlintConfig>): OxlintConfig;
+
+declare const config: OxlintConfig;
+export default config;

package/src/index.js

@@ -0,0 +1,272 @@
+// @ts-check
+
+import { defineConfig } from 'oxlint';
+
+export default defineConfig({
+  plugins: ['eslint', 'import', 'jsdoc', 'promise'],
+
+  categories: {
+    correctness: 'allow',
+  },
+
+  env: {
+    'shared-node-browser': true,
+  },
+
+  rules: {
+    // Default ESLint rules, all set to "error" since Oxlint sets them to "warn"
+    // by default.
+    'eslint/constructor-super': 'error',
+    'eslint/for-direction': 'error',
+    'eslint/no-async-promise-executor': 'error',
+    'eslint/no-caller': 'error',
+    'eslint/no-class-assign': 'error',
+    'eslint/no-compare-neg-zero': 'error',
+    'eslint/no-cond-assign': 'error',
+    'eslint/no-const-assign': 'error',
+    'eslint/no-constant-binary-expression': 'error',
+    'eslint/no-constant-condition': 'error',
+    'eslint/no-control-regex': 'error',
+    'eslint/no-debugger': 'error',
+    'eslint/no-delete-var': 'error',
+    'eslint/no-dupe-class-members': 'error',
+    'eslint/no-dupe-else-if': 'error',
+    'eslint/no-dupe-keys': 'error',
+    'eslint/no-duplicate-case': 'error',
+    'eslint/no-empty-character-class': 'error',
+    'eslint/no-empty-pattern': 'error',
+    'eslint/no-empty-static-block': 'error',
+    'eslint/no-eval': 'error',
+    'eslint/no-ex-assign': 'error',
+    'eslint/no-extra-boolean-cast': 'error',
+    'eslint/no-func-assign': 'error',
+    'eslint/no-global-assign': 'error',
+    'eslint/no-import-assign': 'error',
+    'eslint/no-invalid-regexp': 'error',
+    'eslint/no-irregular-whitespace': 'error',
+    'eslint/no-iterator': 'error',
+    'eslint/no-loss-of-precision': 'error',
+    'eslint/no-misleading-character-class': 'error',
+    'eslint/no-new-native-nonconstructor': 'error',
+    'eslint/no-nonoctal-decimal-escape': 'error',
+    'eslint/no-obj-calls': 'error',
+    'eslint/no-self-assign': 'error',
+    'eslint/no-setter-return': 'error',
+    'eslint/no-shadow-restricted-names': 'error',
+    'eslint/no-sparse-arrays': 'error',
+    'eslint/no-this-before-super': 'error',
+    'eslint/no-unassigned-vars': 'error',
+    'eslint/no-unsafe-finally': 'error',
+    'eslint/no-unsafe-negation': 'error',
+    'eslint/no-unsafe-optional-chaining': 'error',
+    'eslint/no-unused-labels': 'error',
+    'eslint/no-useless-backreference': 'error',
+    'eslint/no-useless-catch': 'error',
+    'eslint/no-useless-escape': 'error',
+    'eslint/no-useless-rename': 'error',
+    'eslint/no-with': 'error',
+    'eslint/require-yield': 'error',
+    'eslint/use-isnan': 'error',
+    'eslint/valid-typeof': 'error',
+
+    // Extra ESLint rules that are not enabled by default, but we want to
+    // enable.
+    'eslint/accessor-pairs': 'error',
+    'eslint/array-callback-return': 'error',
+    'eslint/block-scoped-var': 'error',
+    'eslint/curly': ['error', 'all'],
+    'eslint/default-case': 'error',
+    'eslint/default-param-last': 'error',
+    'eslint/eqeqeq': ['error', 'smart'],
+    'eslint/grouped-accessor-pairs': 'error',
+    'eslint/guard-for-in': 'error',
+    'eslint/id-length': [
+      'error',
+      {
+        min: 2,
+        properties: 'never',
+        exceptionPatterns: ['_', 'a', 'b', 'i', 'j', 'k'],
+      },
+    ],
+    'eslint/new-cap': [
+      'error',
+      {
+        newIsCap: true,
+        capIsNew: false,
+      },
+    ],
+    'eslint/no-alert': 'error',
+    'eslint/no-array-constructor': 'error',
+    'eslint/no-bitwise': 'error',
+    'eslint/no-constructor-return': 'error',
+    'eslint/no-div-regex': 'error',
+    'eslint/no-else-return': 'error',
+    'eslint/no-empty-function': 'error',
+    'eslint/no-eq-null': 'error',
+    'eslint/no-extend-native': 'error',
+    'eslint/no-extra-bind': 'error',
+    'eslint/no-extra-label': 'error',
+    'eslint/no-implicit-coercion': 'error',
+    'eslint/no-inner-declarations': ['error', 'functions'],
+    'eslint/no-labels': [
+      'error',
+      {
+        allowLoop: false,
+        allowSwitch: false,
+      },
+    ],
+    'eslint/no-lone-blocks': 'error',
+    'eslint/no-lonely-if': 'error',
+    'eslint/no-loop-func': 'error',
+    'eslint/no-multi-assign': 'error',
+    'eslint/no-multi-str': 'error',
+    'eslint/no-negated-condition': 'error',
+    'eslint/no-nested-ternary': 'error',
+    'eslint/no-new': 'error',
+    'eslint/no-new-func': 'error',
+    'eslint/no-new-wrappers': 'error',
+    'eslint/no-param-reassign': 'error',
+    'eslint/no-plusplus': [
+      'error',
+      {
+        allowForLoopAfterthoughts: true,
+      },
+    ],
+    'eslint/no-proto': 'error',
+    'eslint/no-return-assign': ['error', 'except-parens'],
+    'eslint/no-script-url': 'error',
+    'eslint/no-self-compare': 'error',
+    'eslint/no-shadow': ['error', { builtinGlobals: true }],
+    'eslint/no-template-curly-in-string': 'error',
+    'eslint/no-throw-literal': 'error',
+    'eslint/no-unmodified-loop-condition': 'error',
+    'eslint/no-unneeded-ternary': [
+      'error',
+      {
+        defaultAssignment: false,
+      },
+    ],
+    'eslint/no-unused-expressions': [
+      'error',
+      {
+        allowShortCircuit: true,
+        allowTernary: true,
+      },
+    ],
+    'eslint/no-unused-vars': [
+      'error',
+      {
+        vars: 'all',
+        args: 'all',
+        argsIgnorePattern: '[_]+',
+        ignoreRestSiblings: true,
+      },
+    ],
+    'eslint/no-use-before-define': [
+      'error',
+      {
+        functions: false,
+      },
+    ],
+    'eslint/no-useless-call': 'error',
+    'eslint/no-useless-computed-key': 'error',
+    'eslint/no-useless-concat': 'error',
+    'eslint/no-useless-constructor': 'error',
+    'eslint/no-useless-return': 'error',
+    'eslint/no-var': 'error',
+    'eslint/no-void': 'error',
+    // 'eslint/object-shorthand': 'error',
+    'eslint/operator-assignment': 'error',
+    'eslint/prefer-const': 'error',
+    'eslint/prefer-destructuring': [
+      'error',
+      {
+        VariableDeclarator: {
+          array: false,
+          object: true,
+        },
+        AssignmentExpression: {
+          array: false,
+          object: false,
+        },
+      },
+      {
+        enforceForRenamedProperties: false,
+      },
+    ],
+    'eslint/prefer-numeric-literals': 'error',
+    'eslint/prefer-promise-reject-errors': 'error',
+    'eslint/prefer-rest-params': 'error',
+    'eslint/prefer-spread': 'error',
+    'eslint/prefer-template': 'error',
+    'eslint/radix': 'error',
+    'eslint/symbol-description': 'error',
+    'eslint/yoda': ['error', 'never'],
+
+    // Import rules.
+    'import/extensions': [
+      'error',
+      'ignorePackages',
+      {
+        json: 'always',
+      },
+    ],
+    'import/first': 'error',
+    'import/no-absolute-path': 'error',
+    'import/no-amd': 'error',
+    'import/no-anonymous-default-export': 'error',
+    'import/no-duplicates': 'error',
+    'import/no-dynamic-require': 'error',
+    'import/no-mutable-exports': 'error',
+    'import/no-named-as-default': 'error',
+    'import/no-named-as-default-member': 'error',
+    'import/no-named-default': 'error',
+    'import/no-nodejs-modules': 'error',
+    'import/no-self-import': 'error',
+    'import/no-unassigned-import': 'error',
+    'import/no-webpack-loader-syntax': 'error',
+    'import/unambiguous': 'error',
+
+    // JSDoc rules.
+    'jsdoc/check-access': 'error',
+    'jsdoc/check-property-names': 'error',
+    'jsdoc/check-tag-names': 'error',
+    'jsdoc/empty-tags': 'error',
+    'jsdoc/implements-on-classes': 'error',
+    'jsdoc/no-defaults': 'error',
+    'jsdoc/require-param-name': 'error',
+    'jsdoc/require-param': 'error',
+    'jsdoc/require-param-description': 'error',
+    'jsdoc/require-param-type': 'error',
+    'jsdoc/require-property': 'error',
+    'jsdoc/require-property-description': 'error',
+    'jsdoc/require-property-name': 'error',
+    'jsdoc/require-property-type': 'error',
+    'jsdoc/require-returns': 'error',
+    'jsdoc/require-returns-description': 'error',
+    'jsdoc/require-returns-type': 'error',
+    'jsdoc/require-yields': 'error',
+
+    // Promise rules.
+    'promise/catch-or-return': [
+      'error',
+      {
+        allowFinally: true,
+      },
+    ],
+    'promise/no-callback-in-promise': 'error',
+    'promise/no-nesting': 'error',
+    'promise/no-promise-in-callback': 'error',
+    'promise/no-return-in-finally': 'error',
+    'promise/param-names': [
+      'error',
+      {
+        resolvePattern: '^_?resolve',
+        rejectPattern: '^_?reject',
+      },
+    ],
+    'promise/valid-params': 'error',
+  },
+});
+
+export { createConfig } from './utils.js';

package/src/utils.js

@@ -0,0 +1,89 @@
+import deepmerge from 'deepmerge';
+
+/**
+ * @typedef {import('oxlint').OxlintConfig} OxlintConfig
+ */
+
+/**
+ * @typedef {import('eslint').Linter.Config} Config
+ *
+ * @typedef {Config & { extends?: Config | Config[] | Config[][] }} ConfigWithExtends
+ */
+
+/**
+ * Get an array from a value. If the value is already an array, it is returned
+ * as is. Otherwise, the value is wrapped in an array.
+ *
+ * @template Type
+ * @param {Type | Type[]} value - The value to convert to an array.
+ * @returns {Type[]} The value as an array.
+ */
+export function getArray(value) {
+  if (value === undefined) {
+    return [];
+  }
+
+  return Array.isArray(value) ? value : [value];
+}
+
+/**
+ * Create a config object that extends other configs.
+ *
+ * This function handles merging multiple configs together specified in the
+ * `extends` property of the input config. It recursively resolves any nested
+ * `extends` properties in the base configs as well. Oxlint by default only
+ * merges the `rules` and `plugins` properties of the configs, but this function
+ * can be used to merge any properties of the configs.
+ *
+ * @example <caption>Extending a single config</caption>
+ *   import { createConfig } from '@metamask/oxlint-config';
+ *   import typescript from '@metamask/oxlint-config-typescript';
+ *
+ *   const configs = createConfig({
+ *     extends: typescript,
+ *   });
+ *
+ *   export default configs;
+ *
+ * @example <caption>Extending multiple configs</caption>
+ *   import { createConfig } from '@metamask/oxlint-config';
+ *   import typescript from '@metamask/oxlint-config-typescript';
+ *   import nodejs from '@metamask/oxlint-config-nodejs';
+ *
+ *   const configs = createConfig({
+ *     extends: [typescript, nodejs],
+ *   });
+ *
+ *   export default configs;
+ *
+ * @param {OxlintConfig} config - The config object to create, which may include
+ *   an `extends` property that specifies one or more base configs to extend.
+ * @returns {Omit<OxlintConfig, "extends">} A single config object with all the
+ *   extended configs merged in.
+ */
+export function createConfig(config) {
+  const { extends: baseConfig, ...extension } = config;
+  const baseConfigs = getArray(baseConfig);
+
+  if (baseConfigs.length === 0) {
+    return extension;
+  }
+
+  const mergedBaseConfig = baseConfigs.reduce((mergedConfig, currentConfig) => {
+    const parsedConfig = currentConfig.extends
+      ? createConfig(currentConfig)
+      : currentConfig;
+
+    return deepmerge(mergedConfig, parsedConfig, {
+      arrayMerge(target, source, options) {
+        if (options?.isMergeableObject) {
+          return [...new Set([...target, ...source])];
+        }
+
+        return source;
+      },
+    });
+  }, {});
+
+  return deepmerge(mergedBaseConfig, extension);
+}