88c0631344
* bump @typescript-eslint deps * update rules * fix errors in pacakges * fix src/ * fix x-pack * fix test * fix typings * fix examples * allow _ as prefix and suffix * roll back prefix and suffix changes * add eslint-plugin-eslint-comments * report unused rules * remove unused eslint comments from tests * remove unused eslint comments 2nd pass * remove unused eslint comments from src/ * remove unused comments in x-pack * use no-script-url and no-unsanitized/property for ts files * remove unused eslint comments * eui/href-or-on-click removed when not complained * no import/* rules for ts files * cleanup * remove the unused eslint-disable * rollback unnecessary changes * allow underscore prefix & sufix in type name * update docs * fix type error in enterprise search plugin mocks * rename platform hack __coreProvider --> _coreProvider * rollback space removal in src/core/public/legacy/legacy_service.test.ts * fix naming convention in APM
256 lines
8.8 KiB
JavaScript
256 lines
8.8 KiB
JavaScript
// NOTE: This is the configuration to apply the typescript eslint parser
|
|
// in order to lint typescript files with eslint.
|
|
// Some IDEs could not be running eslint with the correct extensions yet
|
|
// as this package was moved from typescript-eslint-parser to @typescript-eslint/parser
|
|
|
|
const semver = require('semver');
|
|
const PKG = require('../../package.json');
|
|
|
|
const eslintConfigPrettierTypescriptEslintRules = require('eslint-config-prettier/@typescript-eslint').rules;
|
|
|
|
// The current implementation excluded all the variables matching the regexp.
|
|
// We should remove it as soon as multiple underscores are supported by the linter.
|
|
// https://github.com/typescript-eslint/typescript-eslint/issues/1712
|
|
// Due to the same reason we have to duplicate the "filter" option for "default" and other "selectors".
|
|
const allowedNameRegexp = '^(UNSAFE_|_{1,3})|_{1,3}$';
|
|
module.exports = {
|
|
overrides: [
|
|
{
|
|
files: ['**/*.{ts,tsx}'],
|
|
parser: '@typescript-eslint/parser',
|
|
|
|
plugins: [
|
|
'@typescript-eslint',
|
|
'ban',
|
|
'import',
|
|
'prefer-object-spread',
|
|
'eslint-comments'
|
|
],
|
|
|
|
settings: {
|
|
'import/resolver': {
|
|
node: {
|
|
extensions: ['.mjs', '.js', '.json', '.ts', '.tsx'],
|
|
},
|
|
},
|
|
react: {
|
|
version: semver.valid(semver.coerce(PKG.dependencies.react)),
|
|
},
|
|
},
|
|
|
|
env: {
|
|
es6: true,
|
|
node: true,
|
|
mocha: true,
|
|
browser: true,
|
|
},
|
|
|
|
parserOptions: {
|
|
sourceType: 'module',
|
|
ecmaVersion: 2018,
|
|
ecmaFeatures: {
|
|
jsx: true
|
|
},
|
|
// NOTE: That is to avoid a known performance issue related with the `ts.Program` used by
|
|
// typescript eslint. As we are not using rules that need types information, we can safely
|
|
// disabling that feature setting the project to undefined. That issue is being addressed
|
|
// by the typescript eslint team. More info could be found here:
|
|
// https://github.com/typescript-eslint/typescript-eslint/issues/389
|
|
// https://github.com/typescript-eslint/typescript-eslint/issues/243
|
|
// https://github.com/typescript-eslint/typescript-eslint/pull/361
|
|
project: undefined
|
|
},
|
|
|
|
// NOTE: we can't override the extends option here to apply
|
|
// all the recommend rules as it is not allowed yet
|
|
// more info on: https://github.com/eslint/rfcs/pull/13 and
|
|
// https://github.com/eslint/eslint/issues/8813
|
|
//
|
|
// For now we are using an workaround to create
|
|
// those extended rules arrays
|
|
rules: Object.assign(
|
|
{
|
|
// Most of the ports were done according
|
|
// https://github.com/typescript-eslint/typescript-eslint/blob/master/packages/eslint-plugin/ROADMAP.md
|
|
//
|
|
// Old recommended tslint rules
|
|
'@typescript-eslint/adjacent-overload-signatures': 'error',
|
|
'@typescript-eslint/array-type': ['error', { default: 'array-simple', readonly: 'array-simple' }],
|
|
'@typescript-eslint/ban-types': ['error', {
|
|
types: {
|
|
SFC: {
|
|
message: 'Use FC or FunctionComponent instead.',
|
|
fixWith: 'FC'
|
|
},
|
|
'React.SFC': {
|
|
message: 'Use FC or FunctionComponent instead.',
|
|
fixWith: 'React.FC'
|
|
},
|
|
StatelessComponent: {
|
|
message: 'Use FunctionComponent instead.',
|
|
fixWith: 'FunctionComponent'
|
|
},
|
|
'React.StatelessComponent': {
|
|
message: 'Use FunctionComponent instead.',
|
|
fixWith: 'React.FunctionComponent'
|
|
},
|
|
// used in the codebase in the wild
|
|
'{}': false,
|
|
'object': false,
|
|
'Function': false,
|
|
}
|
|
}],
|
|
'camelcase': 'off',
|
|
'@typescript-eslint/naming-convention': [
|
|
'error',
|
|
{
|
|
selector: 'default',
|
|
format: ['camelCase'],
|
|
filter: {
|
|
regex: allowedNameRegexp,
|
|
match: false
|
|
}
|
|
},
|
|
{
|
|
selector: 'variable',
|
|
format: [
|
|
'camelCase',
|
|
'UPPER_CASE', // const SOMETHING = ...
|
|
'PascalCase', // React.FunctionComponent =
|
|
],
|
|
filter: {
|
|
regex: allowedNameRegexp,
|
|
match: false
|
|
}
|
|
},
|
|
{
|
|
selector: 'parameter',
|
|
format: [
|
|
'camelCase',
|
|
'PascalCase',
|
|
],
|
|
filter: {
|
|
regex: allowedNameRegexp,
|
|
match: false
|
|
}
|
|
},
|
|
{
|
|
selector: 'memberLike',
|
|
format: [
|
|
'camelCase',
|
|
'PascalCase',
|
|
'snake_case', // keys in elasticsearch requests / responses
|
|
'UPPER_CASE'
|
|
],
|
|
filter: {
|
|
regex: allowedNameRegexp,
|
|
match: false
|
|
}
|
|
},
|
|
{
|
|
selector: 'function',
|
|
format: [
|
|
'camelCase',
|
|
'PascalCase' // React.FunctionComponent =
|
|
],
|
|
filter: {
|
|
regex: allowedNameRegexp,
|
|
match: false
|
|
}
|
|
},
|
|
{
|
|
selector: 'typeLike',
|
|
format: ['PascalCase', 'UPPER_CASE'],
|
|
leadingUnderscore: 'allow',
|
|
trailingUnderscore: 'allow',
|
|
},
|
|
{
|
|
selector: 'enum',
|
|
format: ['PascalCase', 'UPPER_CASE', 'camelCase'],
|
|
},
|
|
],
|
|
'@typescript-eslint/explicit-member-accessibility': ['error',
|
|
{
|
|
accessibility: 'off',
|
|
overrides: {
|
|
accessors: 'explicit',
|
|
constructors: 'no-public',
|
|
parameterProperties: 'explicit'
|
|
}
|
|
}
|
|
],
|
|
'@typescript-eslint/prefer-function-type': 'error',
|
|
'@typescript-eslint/consistent-type-definitions': ['error', 'interface'],
|
|
'@typescript-eslint/member-ordering': ['error', {
|
|
'default': ['public-static-field', 'static-field', 'instance-field']
|
|
}],
|
|
'@typescript-eslint/consistent-type-assertions': 'error',
|
|
'@typescript-eslint/no-empty-interface': 'error',
|
|
'@typescript-eslint/no-extra-non-null-assertion': 'error',
|
|
'@typescript-eslint/no-misused-new': 'error',
|
|
'@typescript-eslint/no-namespace': 'error',
|
|
'@typescript-eslint/triple-slash-reference': ['error', {
|
|
path: 'never',
|
|
types: 'never',
|
|
lib: 'never'
|
|
}],
|
|
'@typescript-eslint/no-var-requires': 'error',
|
|
'@typescript-eslint/unified-signatures': 'error',
|
|
'constructor-super': 'error',
|
|
'dot-notation': 'error',
|
|
'eqeqeq': ['error', 'always', {'null': 'ignore'}],
|
|
'guard-for-in': 'error',
|
|
'import/order': ['error', {
|
|
'groups': [
|
|
['external', 'builtin'],
|
|
'internal',
|
|
['parent', 'sibling', 'index'],
|
|
],
|
|
}],
|
|
'max-classes-per-file': ['error', 1],
|
|
'no-bitwise': 'error',
|
|
'no-caller': 'error',
|
|
'no-cond-assign': 'error',
|
|
'no-console': 'error',
|
|
'no-debugger': 'error',
|
|
'no-empty': 'error',
|
|
'no-extend-native': 'error',
|
|
'no-eval': 'error',
|
|
'no-new-wrappers': 'error',
|
|
'no-script-url': 'error',
|
|
'no-shadow': 'error',
|
|
'no-throw-literal': 'error',
|
|
'no-undef-init': 'error',
|
|
'no-unsafe-finally': 'error',
|
|
'no-unsanitized/property': 'error',
|
|
'no-unused-expressions': 'error',
|
|
'no-unused-labels': 'error',
|
|
'no-var': 'error',
|
|
'object-shorthand': 'error',
|
|
'one-var': [ 'error', 'never' ],
|
|
'prefer-const': 'error',
|
|
'prefer-rest-params': 'error',
|
|
'radix': 'error',
|
|
'spaced-comment': ["error", "always", {
|
|
"exceptions": ["/"]
|
|
}],
|
|
'use-isnan': 'error',
|
|
|
|
// Old tslint yml override or defined rules
|
|
'ban/ban': [
|
|
2,
|
|
{'name': ['describe', 'only'], 'message': 'No exclusive suites.'},
|
|
{'name': ['it', 'only'], 'message': 'No exclusive tests.'},
|
|
{'name': ['test', 'only'], 'message': 'No exclusive tests.'},
|
|
|
|
],
|
|
'import/no-default-export': 'error',
|
|
|
|
'eslint-comments/no-unused-disable': 'error',
|
|
'eslint-comments/no-unused-enable': 'error'
|
|
},
|
|
eslintConfigPrettierTypescriptEslintRules
|
|
)
|
|
},
|
|
]
|
|
};
|