typescript-eslint · bradzacher · Dec 2, 2019
diff --git a/.eslintrc-example-test-temp.ts b/.eslintrc-example-test-temp.ts
@@ -0,0 +1,252 @@
+/**
+ * TEST FILE TODO DELETE THIS BEFORE FINAL COMMIT
+ */
+
+import {
+  typedConfig,
+  ESLintConfig as ESLintConfigBase,
+} from './packages/typed-config/dist/index';
+
+declare global {
+  namespace ESLintConfig {
+    interface Rules {
+      myRule?:
+        | ESLintConfigBase.RuleLevelAndNoOptions
+        | [ESLintConfigBase.RuleLevel, { test: string }];
+    }
+  }
+}
+
+// eslint-plugin-eslint-comments
+// some hand-crafted types for the smallest plugin we have installed
+declare global {
+  namespace ESLintConfig {
+    interface Rules {
+      'eslint-comments/disable-enable-pair'?:
+        | ESLintConfigBase.RuleLevelAndNoOptions
+        | [
+            ESLintConfigBase.RuleLevel,
+            {
+              allowWholeFile?: boolean;
+            },
+          ];
+      'eslint-comments/no-aggregating-enable'?: ESLintConfigBase.RuleLevelAndNoOptions;
+      'eslint-comments/no-duplicate-disable'?: ESLintConfigBase.RuleLevelAndNoOptions;
+      'eslint-comments/no-restricted-disable'?:
+        | ESLintConfigBase.RuleLevelAndNoOptions
+        | [ESLintConfigBase.RuleLevel, ...string[]];
+      'eslint-comments/no-unlimited-disable'?: ESLintConfigBase.RuleLevelAndNoOptions;
+      'eslint-comments/no-unused-disable'?: ESLintConfigBase.RuleLevelAndNoOptions;
+      'eslint-comments/no-unused-enable'?: ESLintConfigBase.RuleLevelAndNoOptions;
+      'eslint-comments/no-use'?:
+        | ESLintConfigBase.RuleLevelAndNoOptions
+        | [
+            ESLintConfigBase.RuleLevel,
+            {
+              allow?: (
+                | 'eslint'
+                | 'eslint-disable'
+                | 'eslint-disable-line'
+                | 'eslint-disable-next-line'
+                | 'eslint-enable'
+                | 'eslint-env'
+                | 'exported'
+                | 'global'
+                | 'globals'
+              )[];
+            },
+          ];
+    }
+  }
+}
+
+export = typedConfig({
+  root: true,
+  plugins: [
+    'eslint-plugin',
+    '@typescript-eslint',
+    'jest',
+    'import',
+    'eslint-comments',
+    1, // expected error: Type 'number' is not assignable to type 'string'.
+  ],
+  env: {
+    es6: true,
+    node: true,
+  },
+  extends: [
+    'eslint:recommended',
+    'plugin:@typescript-eslint/eslint-recommended',
+    'plugin:@typescript-eslint/recommended',
+    'plugin:@typescript-eslint/recommended-requiring-type-checking',
+    1, // expected error: Type 'number' is not assignable to type 'string'.
+  ],
+  rules: {
+    myRule: [
+      // expected error: Type 'string[]' is missing the following properties from type '[RuleLevel, { test: string; }]': 0, 1
+      'error',
+      'foo',
+    ],
+
+    //
+    // our plugin :D
+    //
+
+    '@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
+    '@typescript-eslint/explicit-function-return-type': 'error',
+    '@typescript-eslint/no-explicit-any': 'error',
+    '@typescript-eslint/no-non-null-assertion': 'off',
+    '@typescript-eslint/no-use-before-define': 'off',
+    '@typescript-eslint/no-var-requires': 'off',
+    '@typescript-eslint/prefer-nullish-coalescing': 'error',
+    '@typescript-eslint/prefer-optional-chain': 'error',
+    '@typescript-eslint/unbound-method': 'off',
+
+    'no-empty-function': 'off',
+    '@typescript-eslint/no-empty-function': [
+      'error',
+      { allow: ['arrowFunctions'] },
+    ],
+
+    //
+    // eslint base
+    //
+
+    'comma-dangle': ['error', 'always-multiline'],
+    'constructor-super': 'off',
+    curly: ['error', 'all'],
+    'no-mixed-operators': 'error',
+    'no-console': 'error',
+    'no-process-exit': 'error',
+
+    //
+    // eslint-plugin-eslint-comment
+    //
+
+    // require a eslint-enable comment for every eslint-disable comment
+    'eslint-comments/disable-enable-pair': [
+      'error',
+      {
+        allowWholeFile: true,
+      },
+    ],
+    // disallow a eslint-enable comment for multiple eslint-disable comments
+    'eslint-comments/no-aggregating-enable': 'error',
+    // disallow duplicate eslint-disable comments
+    'eslint-comments/no-duplicate-disable': 'error',
+    // disallow eslint-disable comments without rule names
+    'eslint-comments/no-unlimited-disable': 'error',
+    // disallow unused eslint-disable comments
+    'eslint-comments/no-unused-disable': 'error',
+    // disallow unused eslint-enable comments
+    'eslint-comments/no-unused-enable': 'error',
+    // disallow ESLint directive-comments
+    'eslint-comments/no-use': [
+      'error',
+      {
+        allow: [
+          'eslint-disable',
+          'eslint-disable-line',
+          'eslint-disable-next-line',
+          'eslint-enable',
+        ],
+      },
+    ],
+
+    //
+    // eslint-plugin-import
+    //
+
+    // disallow non-import statements appearing before import statements
+    'import/first': 'error',
+    // Require a newline after the last import/require in a group
+    'import/newline-after-import': 'error',
+    // Forbid import of modules using absolute paths
+    'import/no-absolute-path': 'error',
+    // disallow AMD require/define
+    'import/no-amd': 'error',
+    // forbid default exports
+    'import/no-default-export': 'error',
+    // Forbid the use of extraneous packages
+    'import/no-extraneous-dependencies': [
+      'error',
+      {
+        devDependencies: true,
+        peerDependencies: true,
+        optionalDependencies: false,
+      },
+    ],
+    // Forbid mutable exports
+    'import/no-mutable-exports': 'error',
+    // Prevent importing the default as if it were named
+    'import/no-named-default': 'error',
+    // Prohibit named exports
+    'import/no-named-export': 'off', // we want everything to be a named export
+    // Forbid a module from importing itself
+    'import/no-self-import': 'error',
+    // Require modules with a single export to use a default export
+    'import/prefer-default-export': 'off', // we want everything to be named
+  },
+  parserOptions: {
+    sourceType: 'module',
+    ecmaFeatures: {
+      jsx: false,
+    },
+    project: ['./tsconfig.eslint.json', './packages/*/tsconfig.json'],
+    tsconfigRootDir: __dirname,
+  },
+  overrides: [
+    {
+      files: [
+        'packages/eslint-plugin-tslint/tests/**/*.ts',
+        'packages/eslint-plugin/tests/**/*.test.ts',
+        'packages/parser/tests/**/*.ts',
+        'packages/typescript-estree/tests/**/*.ts',
+      ],
+      env: {
+        'jest/globals': true,
+      },
+      rules: {
+        'jest/no-disabled-tests': 'warn',
+        'jest/no-focused-tests': 'error',
+        'jest/no-alias-methods': 'error',
+        'jest/no-identical-title': 'error',
+        'jest/no-jasmine-globals': 'error',
+        'jest/no-jest-import': 'error',
+        'jest/no-test-prefixes': 'error',
+        'jest/no-test-callback': 'error',
+        'jest/no-test-return-statement': 'error',
+        'jest/prefer-to-have-length': 'warn',
+        'jest/prefer-spy-on': 'error',
+        'jest/valid-expect': 'error',
+      },
+    },
+    {
+      files: [
+        'packages/eslint-plugin/tests/**/*.test.ts',
+        'packages/eslint-plugin-tslint/tests/**/*.spec.ts',
+      ],
+      rules: {
+        'eslint-plugin/no-identical-tests': 'error',
+      },
+    },
+    {
+      files: [
+        'packages/eslint-plugin/src/rules/**/*.ts',
+        'packages/eslint-plugin/src/configs/**/*.ts',
+        'packages/eslint-plugin-tslint/src/rules/**/*.ts',
+      ],
+      rules: {
+        // specifically for rules - default exports makes the tooling easier
+        'import/no-default-export': 'off',
+      },
+    },
+    {
+      files: ['**/tools/**/*.ts', '**/tests/**/*.ts'],
+      rules: {
+        // allow console logs in tools and tests
+        'no-console': 'off',
+      },
+    },
+  ],
+});
diff --git a/.eslintrc.js b/.eslintrc.js
@@ -1,4 +1,7 @@
-module.exports = {
+// @ts-check
+const { typedConfig } = require('@typescript-eslint/typed-config');
+
+module.exports = typedConfig({
   root: true,
   plugins: [
     'eslint-plugin',
@@ -179,4 +182,4 @@ module.exports = {
       },
     },
   ],
-};
+});
diff --git a/packages/typed-config/LICENSE b/packages/typed-config/LICENSE
@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 TypeScript ESLint and other contributors
+
+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.
diff --git a/packages/typed-config/README.md b/packages/typed-config/README.md
@@ -0,0 +1,41 @@
+<h1 align="center">Typed ESLint Config</h1>
+
+<p align="center">A utility function which provides types for `.eslintrc` files.</p>
+
+<p align="center">
+    <a href="https://dev.azure.com/typescript-eslint/TypeScript%20ESLint/_build/latest?definitionId=1&branchName=master"><img src="https://img.shields.io/azure-devops/build/typescript-eslint/TypeScript%20ESLint/1/master.svg?label=%F0%9F%9A%80%20Azure%20Pipelines&style=flat-square" alt="Azure Pipelines"/></a>
+    <a href="https://github.com/typescript-eslint/typed-config/blob/master/LICENSE"><img src="https://img.shields.io/npm/l/typed-config.svg?style=flat-square" alt="GitHub license" /></a>
+    <a href="https://www.npmjs.com/package/@typescript-eslint/typed-config"><img src="https://img.shields.io/npm/v/@typescript-eslint/typed-config.svg?style=flat-square" alt="NPM Version" /></a>
+    <a href="https://www.npmjs.com/package/@typescript-eslint/typed-config"><img src="https://img.shields.io/npm/dm/@typescript-eslint/typed-config.svg?style=flat-square" alt="NPM Downloads" /></a>
+    <a href="http://commitizen.github.io/cz-cli/"><img src="https://img.shields.io/badge/commitizen-friendly-brightgreen.svg?style=flat-square" alt="Commitizen friendly" /></a>
+</p>
+
+<br>
+
+## About
+
+## Installation
+
+```sh
+npm install @typescript-eslint/typed-config --save-dev
+```
+
+## Usage
+
+Create a `.eslintrc.js` configuration file, and use the function:
+
+```js
+const typedConfig = require('@typescript-eslint/typed-config');
+
+module.exports = typedConfig({});
+```
+
+## Supported TypeScript Version
+
+Please see https://github.com/typescript-eslint/typescript-eslint for the supported TypeScript version.
+
+**Please ensure that you are using a supported version before submitting any issues/bug reports.**
+
+## Reporting Issues
+
+Please use the @typescript-eslint/typed-config issue template when creating your issue and fill out the information requested as best you can. This will really help us when looking into your issue.
diff --git a/packages/typed-config/jest.config.js b/packages/typed-config/jest.config.js
@@ -0,0 +1,13 @@
+'use strict';
+
+module.exports = {
+  testEnvironment: 'node',
+  transform: {
+    '^.+\\.tsx?$': 'ts-jest',
+  },
+  testRegex: './tests/(lib/.*\\.(jsx?|tsx?)|ast-alignment/spec\\.ts)$',
+  collectCoverage: false,
+  collectCoverageFrom: ['src/**/*.{js,jsx,ts,tsx}'],
+  moduleFileExtensions: ['ts', 'tsx', 'js', 'jsx', 'json', 'node'],
+  coverageReporters: ['text-summary', 'lcov'],
+};
diff --git a/packages/typed-config/package.json b/packages/typed-config/package.json
@@ -0,0 +1,36 @@
+{
+  "name": "@typescript-eslint/typed-config",
+  "version": "2.10.0",
+  "description": "A utility function which provides types for `.eslintrc` files.",
+  "main": "dist/index.js",
+  "types": "dist/index.d.ts",
+  "files": [
+    "dist",
+    "README.md",
+    "LICENSE"
+  ],
+  "engines": {
+    "node": "^8.10.0 || ^10.13.0 || >=11.10.1"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/typescript-eslint/typescript-eslint.git",
+    "directory": "packages/typed-config"
+  },
+  "bugs": {
+    "url": "https://github.com/typescript-eslint/typescript-eslint/issues"
+  },
+  "license": "MIT",
+  "keywords": [
+    "typescript",
+    "eslint"
+  ],
+  "scripts": {
+    "build": "tsc -b tsconfig.build.json",
+    "clean": "tsc -b tsconfig.build.json --clean",
+    "format": "prettier --write \"./**/*.{ts,js,json,md}\" --ignore-path ../../.prettierignore",
+    "lint": "eslint . --ext .js,.ts --ignore-path='../../.eslintignore'",
+    "test": "jest --coverage",
+    "typecheck": "tsc -p tsconfig.json --noEmit"
+  }
+}