.eslintrc.cjs
module.exports = {
plugins: [ 'filenames', 'jsdoc' ],
extends: [
'eslint:recommended',
'plugin:import/errors',
'plugin:import/warnings',
'plugin:jsdoc/recommended'
],
ignorePatterns: [
'.vscode',
'**/lib',
'**/node_modules',
'**/__*.*'
],
parserOptions: {
ecmaVersion: 2020,
sourceType: 'module'
},
env: {
es6: true,
node: true,
},
globals: {},
settings: { 'jsdoc': { mode: 'typescript' } }, // allow compact callback types in particular
rules: {
// Best practices
'block-scoped-var': 'error',
'class-methods-use-this': 'error',
'complexity': ['error', 14],
'consistent-return': 'error',
'curly': 'error',
'default-case': 'error',
'eqeqeq': ['error'],
'guard-for-in': 'error',
'max-classes-per-file': ['error', 1],
'no-alert': 'error',
'no-caller': 'error',
'no-case-declarations': 'error',
'no-div-regex': 'error',
'no-empty-function': 'error',
'no-eq-null': 'error',
'no-eval': 'error',
'no-extend-native': 'error',
'no-extra-bind': 'error',
'no-implied-eval': 'error',
'no-invalid-this': 'error',
'no-iterator': 'error',
'no-lone-blocks': 'error',
'no-loop-func': 'error',
'no-multi-spaces': 'error',
'no-multi-str': 'error',
'no-new': 'error',
'no-new-func': 'error',
'no-new-wrappers': 'error',
'no-octal-escape': 'error',
'no-proto': 'error',
'no-return-assign': 'error',
'no-script-url': 'error',
'no-self-compare': 'error',
'no-throw-literal': 'error',
'no-unused-expressions': 'error',
'no-useless-call': 'error',
'no-useless-concat': 'error',
'no-void': 'error',
'no-warning-comments': 'warn',
'radix': 'error',
'wrap-iife': ['error', 'any'],
// Variables
'no-undef-init': 'error',
'no-unused-vars': ['error', { 'args': 'none' }], // function shapes have to be clear
// Stylistic Issues
'block-spacing': 'error',
'brace-style': ['error', '1tbs', { 'allowSingleLine': true }],
'camelcase': 'error',
'comma-spacing': 'error',
'comma-style': 'error',
'eol-last': 'error',
'func-call-spacing': 'error',
'func-name-matching': ['error', { 'includeCommonJSModuleExports': true }],
'function-call-argument-newline': ['error', 'consistent'],
'function-paren-newline': ['error', 'consistent'],
'indent': ['error', 2, { 'SwitchCase': 1, 'flatTernaryExpressions': true }],
'key-spacing': ['error'],
'keyword-spacing': 'error',
'lines-between-class-members': 'error',
'max-depth': ['error', 5],
'max-len': ['error', 130],
'max-lines-per-function': ['error', 80],
'max-nested-callbacks': ['error', 4],
'max-params': ['error', 6],
'max-statements': ['error', 41],
'max-statements-per-line': ['error', { 'max': 2 }],
'multiline-ternary': ['error', 'always-multiline'],
'newline-per-chained-call': ['error', { 'ignoreChainWithDepth': 3 }],
'no-lonely-if': 'warn',
'no-mixed-operators': 'error',
'no-multiple-empty-lines': 'error',
'no-trailing-spaces': 'error',
'no-whitespace-before-property': 'error',
'object-curly-newline': ['error', { 'multiline': true }],
'object-curly-spacing': ['error', 'always'],
'object-property-newline': ['error', { 'allowAllPropertiesOnSameLine': true }],
'one-var': ['warn', 'never'],
'quote-props': ['error', 'consistent'],
'quotes': ['error', 'single', { 'avoidEscape': true, 'allowTemplateLiterals': true }],
'semi': 'error',
'semi-spacing': 'error',
'semi-style': 'error',
'sort-keys': ['error', 'asc', { minKeys: 4 }],
'space-before-blocks': 'error',
'space-before-function-paren': ['error'],
'space-in-parens': 'error',
'space-infix-ops': 'error',
'spaced-comment': ['error', 'always', { 'block': { 'exceptions': ['html'], 'balanced': true } }],
'template-tag-spacing': ['error', 'never'],
// ECMAScript 6
'arrow-body-style': ['error', 'as-needed'],
'arrow-spacing': 'error',
'no-confusing-arrow': 'error',
'no-var': 'error',
'object-shorthand': ['error', 'never'],
'prefer-const': 'error',
'prefer-destructuring': ['error', { AssignmentExpression: { array: false } }],
'prefer-rest-params': 'error',
'prefer-spread': 'error',
// JSDoc
'jsdoc/check-examples': 'off',
'jsdoc/check-indentation': 'error',
'jsdoc/check-syntax': 'error',
'jsdoc/empty-tags': 'error',
'jsdoc/no-undefined-types': 'off', // doesn't work with typedefs in a different file
'jsdoc/require-description-complete-sentence': ['error', { tags: ['typedef'] }],
'jsdoc/require-hyphen-before-param-description': ['error', 'never'],
'jsdoc/require-jsdoc': ['error', { 'publicOnly': true }],
'jsdoc/require-returns-description': 'off', // description might tell this better, avoid repetition
'jsdoc/tag-lines': 'off',
// Import
'import/no-deprecated': 'error',
'import/no-extraneous-dependencies': 'off',
'import/no-mutable-exports': 'error',
'import/no-amd': 'error',
'import/no-nodejs-modules': 'error',
'import/first': 'error',
'import/no-namespace': 'off',
'import/namespace': 'error',
'import/extensions': 'error',
'import/order': ['error', { 'newlines-between': 'always', 'alphabetize': { 'order': 'asc', 'caseInsensitive': true } }],
'import/newline-after-import': ['error', { 'count': 2 }],
'import/no-unassigned-import': 'error',
'import/no-named-default': 'error',
'import/no-named-as-default': 'error',
'import/group-exports': 'error',
'import/no-unresolved': 'off',
// Filenames
'filenames/match-regex': ['error', '^[a-z][a-z0-9\\.\\-]+$'],
'filenames/match-exported': 'error'
},
overrides: [
{
'files': ['packages/html-to-text-cli/**/*.js'],
'rules': {
'sort-keys': 'off',
'import/extensions': [ 'error', 'never', { 'json': 'always' } ],
'import/no-nodejs-modules': [ 'error', { 'allow': ['node:process'] }]
}
},
{
'files': ['example/*.js'],
'rules': { 'import/no-nodejs-modules': 'off' }
},
{
'files': ['**/test/*.js'],
'env': { mocha: true },
'rules': {
'import/no-nodejs-modules': 'off',
'max-len': 'off',
'max-lines-per-function': 'off'
}
},
{
'files': ['.eslintrc.cjs'],
'rules': {
'sort-keys': 'off',
'filenames/match-regex': 'off',
}
}
]
};