@metamask-previews/oxlint-config-typescript 0.0.0-preview-d6c6adc

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,34 @@
+# `@metamask/oxlint-config-typescript`
+
+MetaMask's [TypeScript](https://www.typescriptlang.org) Oxlint configuration.
+
+## Usage
+
+```bash
+yarn add --dev \
+    @metamask/oxlint-config@^0.0.0 \
+    @metamask/oxlint-config-typescript@^0.0.0 \
+    oxlint@^1.82.0 \
+    oxlint-tsgolint@^7.0.2001
+```
+
+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';
+import typescript from '@metamask/oxlint-config-typescript';
+
+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,
+    typescript,
+  ],
+});
+```

package/package.json

@@ -0,0 +1,52 @@
+{
+  "name": "@metamask-previews/oxlint-config-typescript",
+  "version": "0.0.0-preview-d6c6adc",
+  "description": "Shareable MetaMask Oxlint config for TypeScript",
+  "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",
+    "!src/**/__test__"
+  ],
+  "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-typescript",
+    "changelog:validate": "../../scripts/validate-changelog.sh @metamask/oxlint-config-typescript",
+    "test": "oxlint ."
+  },
+  "devDependencies": {
+    "@metamask/auto-changelog": "^3.4.4",
+    "@metamask/oxlint-config": "^0.0.0",
+    "oxlint": "^1.82.0",
+    "oxlint-tsgolint": "^7.0.2001",
+    "typescript": "^5.9.3",
+    "typescript-eslint": "^8.58.1",
+    "vitest": "^2.1.9"
+  },
+  "peerDependencies": {
+    "@metamask/oxlint-config": "^0.0.0",
+    "oxlint": "^1.82.0",
+    "oxlint-tsgolint": "^7.0.2001"
+  },
+  "engines": {
+    "node": "^18.18 || >=20"
+  }
+}

package/src/index.d.ts

@@ -0,0 +1,4 @@
+import { OxlintConfig } from 'oxlint';
+
+declare const config: OxlintConfig;
+export default config;

package/src/index.js

@@ -0,0 +1,131 @@
+import { createConfig } from '@metamask/oxlint-config';
+
+const config = createConfig({
+  plugins: ['typescript'],
+
+  categories: {
+    correctness: 'allow',
+  },
+
+  options: {
+    typeAware: true,
+  },
+
+  rules: {
+    // Our rules
+    'typescript/array-type': 'error',
+    'typescript/consistent-type-assertions': 'error',
+    'typescript/consistent-type-definitions': ['error', 'type'],
+    'typescript/explicit-function-return-type': 'error',
+    'typescript/no-explicit-any': 'off',
+    'typescript/no-namespace': ['error', { allowDefinitionFiles: true }],
+    'typescript/no-non-null-assertion': 'error',
+    'typescript/parameter-properties': 'error',
+    'typescript/prefer-for-of': 'error',
+    'typescript/prefer-function-type': 'error',
+    'typescript/prefer-optional-chain': 'error',
+    'typescript/unified-signatures': 'error',
+    'typescript/no-dupe-class-members': 'error',
+    'typescript/no-unused-vars': [
+      'error',
+      {
+        vars: 'all',
+        args: 'all',
+        argsIgnorePattern: '[_]+',
+        ignoreRestSiblings: true,
+      },
+    ],
+
+    // Recommended rules that require type information
+    'typescript/no-unsafe-argument': 'off',
+    'typescript/no-unsafe-assignment': 'off',
+    'typescript/no-unsafe-call': 'off',
+    'typescript/no-unsafe-member-access': 'off',
+    'typescript/no-unsafe-return': 'off',
+
+    // Recommended rules that we do not want to use
+    'typescript/no-duplicate-type-constituents': 'off',
+    'typescript/no-redundant-type-constituents': 'off',
+    'typescript/no-unsafe-enum-comparison': 'off',
+    'typescript/require-await': 'off',
+
+    // Disabled because unnecessary type arguments are sometimes helpful for
+    // readability
+    'typescript/no-unnecessary-type-arguments': 'off',
+
+    // Our rules that require type information
+    'typescript/consistent-type-exports': 'error',
+    'typescript/no-meaningless-void-operator': 'error',
+    'typescript/no-unnecessary-boolean-literal-compare': 'error',
+    'typescript/no-unnecessary-qualifier': 'error',
+    'typescript/prefer-enum-initializers': 'error',
+    'typescript/prefer-includes': 'error',
+    'typescript/prefer-nullish-coalescing': 'error',
+    'typescript/prefer-promise-reject-errors': [
+      'error',
+      { allowThrowingUnknown: true },
+    ],
+    'typescript/prefer-readonly': 'error',
+    'typescript/prefer-reduce-type-parameter': 'error',
+    'typescript/prefer-string-starts-ends-with': 'error',
+    'typescript/promise-function-async': 'error',
+    'typescript/restrict-template-expressions': [
+      'error',
+      {
+        allowBoolean: true,
+        allowNumber: true,
+      },
+    ],
+    'typescript/switch-exhaustiveness-check': [
+      'error',
+      {
+        considerDefaultExhaustiveForUnions: true,
+      },
+    ],
+
+    'default-param-last': 'off',
+    'typescript/default-param-last': 'error',
+
+    'no-shadow': 'off',
+    'typescript/no-shadow': ['error', { builtinGlobals: true }],
+
+    'typescript/no-unused-expressions': [
+      'error',
+      { allowShortCircuit: true, allowTernary: true },
+    ],
+
+    'no-use-before-define': 'off',
+    'typescript/no-use-before-define': ['error', { functions: false }],
+
+    'no-useless-constructor': 'off',
+    'typescript/no-useless-constructor': 'error',
+
+    /* Import plugin rules */
+
+    // This rule is too aggressive about combining type and non-type imports,
+    // which I'm not sure that we want.
+    // But more importantly, the auto-fixer is broken.
+    // See here for details on that bug: https://github.com/un-ts/eslint-plugin-import-x/issues/231
+    // TODO: Check if this is the case for Oxlint.
+    'import/no-duplicates': 'off',
+
+    // Combined with the "verbatimModuleSyntax" tsconfig option, a better option
+    // than `typescript/consistent-type-imports`.
+    'import/consistent-type-specifier-style': ['error', 'prefer-top-level'],
+
+    /* JSDoc plugin rules */
+
+    // These all conflict with `jsdoc/no-types`.
+    'jsdoc/require-param-type': 'off',
+    'jsdoc/require-property-type': 'off',
+    'jsdoc/require-returns-type': 'off',
+    // 'jsdoc/valid-types': 'off',
+
+    /* Promise plugin rules */
+
+    // TypeScript already validates Promise params, no need to validate them twice
+    'promise/valid-params': 'off',
+  },
+});
+
+export default config;