@metamask/eslint-config-typescript 11.0.2 → 12.0.0

package/CHANGELOG.md

@@ -6,6 +6,20 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [12.0.0]
+### Added
+- **BREAKING:** Add rule to enforce generic parameters have a length of at least 3 characters ([#292](https://github.com/MetaMask/eslint-config/pull/292))
+- **BREAKING:** Enable `@typescript-eslint/consistent-type-imports` rule ([#284](https://github.com/MetaMask/eslint-config/pull/284))
+- **BREAKING:** Enable `@typescript-eslint/prefer-enum-initializers` rule ([#269](https://github.com/MetaMask/eslint-config/pull/269))
+
+### Changed
+- **BREAKING:** Update peer dependency `@metamask/eslint-config` to v12
+- Disable naming convention for properties that require quotes ([#293](https://github.com/MetaMask/eslint-config/pull/293))
+
+## [11.1.0]
+### Changed
+- Exclude test files from package ([#266](https://github.com/MetaMask/eslint-config/pull/266))
+
 ## [11.0.2]
 ### Changed
 - Allow async functions without any 'await' ([#262](https://github.com/MetaMask/eslint-config/pull/262))
@@ -89,7 +103,9 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
   - To continue extending this config, install this package and update your `.eslintrc.js` `extends` array to include `@metamask/eslint-config-typescript` instead of `@metamask/eslint-config/typescript`.
 - Update `eslint` and other ESLint peer dependencies ([#151](https://github.com/MetaMask/eslint-config/pull/151))
 
-[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v11.0.2...HEAD
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v12.0.0...HEAD
+[12.0.0]: https://github.com/MetaMask/eslint-config/compare/v11.1.0...v12.0.0
+[11.1.0]: https://github.com/MetaMask/eslint-config/compare/v11.0.2...v11.1.0
 [11.0.2]: https://github.com/MetaMask/eslint-config/compare/v11.0.0...v11.0.2
 [11.0.0]: https://github.com/MetaMask/eslint-config/compare/v10.0.0...v11.0.0
 [10.0.0]: https://github.com/MetaMask/eslint-config/compare/v9.0.1...v10.0.0

package/README.md

@@ -6,8 +6,8 @@ MetaMask's [TypeScript](https://www.typescriptlang.org) ESLint configuration.
 
 ```bash
 yarn add --dev \
-    @metamask/eslint-config@^11.0.1 \
-    @metamask/eslint-config-typescript@^11.0.0 \
+    @metamask/eslint-config@^12.0.0 \
+    @metamask/eslint-config-typescript@^12.0.0 \
     @typescript-eslint/eslint-plugin@^5.42.1 \
     @typescript-eslint/parser@^5.42.1 \
     eslint@^8.27.0 \
@@ -15,6 +15,7 @@ yarn add --dev \
     eslint-plugin-import@^2.26.0 \
     eslint-plugin-jsdoc@^39.6.2 \
     eslint-plugin-prettier@^4.2.1 \
+    eslint-plugin-promise@^6.1.1 \
     prettier@^2.7.1
 ```
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-typescript",
-  "version": "11.0.2",
+  "version": "12.0.0",
   "description": "Shareable MetaMask ESLint config for TypeScript.",
   "homepage": "https://github.com/MetaMask/eslint-config#readme",
   "bugs": {
@@ -13,7 +13,9 @@
   "license": "MIT",
   "main": "src/index.js",
   "files": [
-    "src/"
+    "src/",
+    "!src/**/*.test.js",
+    "!src/**/__test__"
   ],
   "scripts": {
     "lint:changelog": "auto-changelog validate",
@@ -22,7 +24,7 @@
   },
   "devDependencies": {
     "@metamask/auto-changelog": "^3.0.0",
-    "@metamask/eslint-config": "^11.0.0",
+    "@metamask/eslint-config": "^12.0.0",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
     "eslint": "^8.27.0",
@@ -34,7 +36,7 @@
     "typescript": "~4.8.4"
   },
   "peerDependencies": {
-    "@metamask/eslint-config": "^11.0.0",
+    "@metamask/eslint-config": "^12.0.0",
     "@typescript-eslint/eslint-plugin": "^5.42.1",
     "@typescript-eslint/parser": "^5.42.1",
     "eslint": "^8.27.0",

package/src/index.js

@@ -42,6 +42,7 @@ module.exports = {
     '@typescript-eslint/array-type': 'error',
     '@typescript-eslint/consistent-type-assertions': 'error',
     '@typescript-eslint/consistent-type-definitions': ['error', 'type'],
+    '@typescript-eslint/consistent-type-imports': 'error',
     '@typescript-eslint/no-explicit-any': 'off',
     '@typescript-eslint/no-namespace': [
       'error',
@@ -109,6 +110,14 @@ module.exports = {
         selector: 'typeLike',
         format: ['PascalCase'],
       },
+      {
+        selector: 'typeParameter',
+        format: ['PascalCase'],
+        custom: {
+          regex: '^.{3,}',
+          match: true,
+        },
+      },
       {
         selector: 'variable',
         format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
@@ -119,11 +128,26 @@ module.exports = {
         format: ['camelCase', 'PascalCase'],
         leadingUnderscore: 'allow',
       },
+      {
+        selector: [
+          'classProperty',
+          'objectLiteralProperty',
+          'typeProperty',
+          'classMethod',
+          'objectLiteralMethod',
+          'typeMethod',
+          'accessor',
+          'enumMember',
+        ],
+        format: null,
+        modifiers: ['requiresQuotes'],
+      },
     ],
     '@typescript-eslint/no-meaningless-void-operator': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': 'error',
     '@typescript-eslint/no-unnecessary-qualifier': 'error',
     '@typescript-eslint/no-unnecessary-type-arguments': 'error',
+    '@typescript-eslint/prefer-enum-initializers': 'error',
     '@typescript-eslint/prefer-includes': 'error',
     '@typescript-eslint/prefer-nullish-coalescing': 'error',
     '@typescript-eslint/prefer-readonly': 'error',

package/src/__test__/dummy.ts

@@ -1,2 +0,0 @@
-// This file is only used to test the config.
-console.log('Hello, world!');

package/src/index.test.js

@@ -1,31 +0,0 @@
-const { ESLint } = require('eslint');
-const { resolve } = require('path');
-
-const config = require('.');
-
-describe('index', () => {
-  it('is a valid ESLint config', async () => {
-    const api = new ESLint({
-      baseConfig: config,
-      useEslintrc: false,
-      overrideConfig: {
-        env: {
-          node: true,
-        },
-        parserOptions: {
-          tsconfigRootDir: resolve(__dirname, '..'),
-          project: 'tsconfig.json',
-        },
-      },
-    });
-
-    // In order to test rules that require type information, we need to actually
-    // compile the file with TypeScript, so rather than using `api.lintText()`,
-    // we use `api.lintFiles()` and pass in a file that we know will pass.
-    const result = await api.lintFiles(resolve(__dirname, '__test__/dummy.ts'));
-
-    expect(result[0].messages).toStrictEqual([]);
-    expect(result[0].warningCount).toBe(0);
-    expect(result[0].errorCount).toBe(0);
-  });
-});