@metamask/eslint-config-typescript 11.0.0 → 11.1.0

package/CHANGELOG.md

@@ -6,6 +6,15 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [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))
+- Allow parameters to use PascalCase ([#264](https://github.com/MetaMask/eslint-config/pull/264))
+
 ## [11.0.0]
 ### Added
 - **BREAKING:** Add rules that require type information ([#250](https://github.com/MetaMask/eslint-config/pull/250))
@@ -84,7 +93,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.0...HEAD
+[Unreleased]: https://github.com/MetaMask/eslint-config/compare/v11.1.0...HEAD
+[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
 [9.0.1]: https://github.com/MetaMask/eslint-config/compare/v9.0.0...v9.0.1

package/README.md

@@ -6,7 +6,7 @@ MetaMask's [TypeScript](https://www.typescriptlang.org) ESLint configuration.
 
 ```bash
 yarn add --dev \
-    @metamask/eslint-config@^11.0.0 \
+    @metamask/eslint-config@^11.0.1 \
     @metamask/eslint-config-typescript@^11.0.0 \
     @typescript-eslint/eslint-plugin@^5.42.1 \
     @typescript-eslint/parser@^5.42.1 \

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@metamask/eslint-config-typescript",
-  "version": "11.0.0",
+  "version": "11.1.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",
@@ -47,4 +49,4 @@
     "access": "public",
     "registry": "https://registry.npmjs.org/"
   }
-}
+}

package/src/index.js

@@ -72,6 +72,9 @@ module.exports = {
     '@typescript-eslint/no-unsafe-member-access': 'off',
     '@typescript-eslint/no-unsafe-return': 'off',
 
+    // Recommended rules that we do not want to use
+    '@typescript-eslint/require-await': 'off',
+
     // Our rules that require type information
     '@typescript-eslint/consistent-type-exports': 'error',
     '@typescript-eslint/naming-convention': [
@@ -111,6 +114,11 @@ module.exports = {
         format: ['camelCase', 'UPPER_CASE', 'PascalCase'],
         leadingUnderscore: 'allow',
       },
+      {
+        selector: 'parameter',
+        format: ['camelCase', 'PascalCase'],
+        leadingUnderscore: 'allow',
+      },
     ],
     '@typescript-eslint/no-meaningless-void-operator': 'error',
     '@typescript-eslint/no-unnecessary-boolean-literal-compare': '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);
-  });
-});