vue.js

/**
 * Vue configuration for ESLint shareable configuration eslint-config-chromatix.
 *
 * @author Jay Oswald <j@chromatix.com.au>
 */

const INDENTATION_SPACES = 2;

module.exports = {

  env: {
    browser: true,
    es6: true,
    jquery: false,
    node:  true,
  },

  parserOptions: {
    ecmaVersion: 8,
    sourceType: "module",
  },

  // @see https://github.com/WordPress-Coding-Standards/eslint-config-wordpress/blob/master/index.js
  // @see https://github.com/WordPress-Coding-Standards/eslint-plugin-wordpress/tree/master/lib
  extends: [
    'eslint:recommended',
    'plugin:nuxt/recommended'
  ],

  plugins: [

  ],

  // @see https://eslint.org/docs/rules/{NAME-OF-RULE}
  rules: {

    semi: [
      'warn',
      'always',
    ],

    'array-bracket-newline': [ // Stylistic.
      'error',
      'consistent'
    ],

    'array-bracket-spacing': [
      'warn',
      'always'
    ],

    'array-callback-return': [ 'warn' ], // Purely helpful.

    'array-element-newline': [ // Stylistic.
      'error',
      'always'
    ],

    'callback-return': [ 'error' ], // Node safety.

    'capitalized-comments': [ // Documentation.
      'warn',
      'always',
      {
        ignoreConsecutiveComments: true
      }
    ],

    complexity: [ // Best practices.
      'error',
      {
        max: 20
      }
    ],

    'dot-location': [ // Stylistic.
      'error',
      'property'
    ],

    eqeqeq: [ // Best practices.
      'error',
      'always'
    ],

    'guard-for-in':        [ 'error' ], // Best practices.
    'handle-callback-err': [ 'error' ], // Node safety.

    // Indentation.
    // @see https://eslint.org/docs/rules/indent
    indent: [
      'error',
      INDENTATION_SPACES,
      {
        flatTernaryExpressions: true,
        SwitchCase:             1,

        VariableDeclarator: {
          const: 3,
          let:   2,
          var:   2
        }
      }
    ],

    'key-spacing': [ // Stylistic.
      'warn',
      {
        beforeColon: false,
        afterColon: true,
        mode: 'minimum'
      }
    ],

    'linebreak-style': [ 'off' ], // Handled by git.

    'lines-around-comment': [ // Documentation.
      'warn',
      {
        beforeBlockComment: true,
        beforeLineComment:  true
      }
    ],

    'max-depth': [ // Best practices.
      'error',
      {
        max: 6
      }
    ],

    'max-len': [ // Stylistic.
      'error',
      {
        code:       140,
        ignoreUrls: true,
        tabWidth:   2
      }
    ],

    'max-lines': [ // Stylistic.
      'error',
      {
        max:            1000,
        skipBlankLines: true,
        skipComments:   true
      }
    ],

    'max-nested-callbacks': [ // Best practices.
      'error',
      {
        max: 3
      }
    ],

    'max-params': [ // Best practices.
      'error',
      {
        max: 4
      }
    ],

    'max-statements': [ // Best practices.
      'error',
      {
        max: 20
      }
    ],

    'max-statements-per-line': [ 'error' ], // Stylistic.

    'no-alert':              [ 'error' ], // UX.
    'no-array-constructor':  [ 'error' ], // Stylistic.
    'no-buffer-constructor': [ 'error' ], // Node safety.
    'no-console':            [ 'off' ], // Handled by strip-debug during minify for prod.
    'no-empty-function':     [ 'error' ], // Stylistic.
    'no-eq-null':            [ 'error' ], // Best practices.
    'no-eval':               [ 'error' ], // Security.
    'no-implicit-coercion':  [ 'error' ], // Best practices.
    'no-implied-eval':       [ 'error' ], // Security.
    'no-lone-blocks':        [ 'error' ], // Stylistic.
    'no-lonely-if':          [ 'error' ], // Stylistic.
    'no-loop-func':          [ 'error' ], // Best practices.
    'no-magic-numbers':      0,

    'no-mixed-requires': [ // Node safety.
      'error',
      {
        allowCall: true
      }
    ],

    'no-multi-spaces': [ 'error' ], // Stylistic.
    'no-multi-str':    [ 'error' ], // Stylistic.

    'no-multiple-empty-lines': [ // Stylistic.
      'error',
      {
        max:    1,
        maxBOF: 1,
        maxEOF: 1
      }
    ],
    'no-negated-condition':    [ 'error' ], // Stylistic.
    'no-new-object':           [ 'error' ], // Stylistic.
    'no-param-reassign':       [ 'error' ], // Best practices.
    'no-path-concat':          [ 'error' ], // Node safety.
    'no-plusplus':             [ 'off' ], // Only should be on if not using semicolons
    'no-process-exit':         [ 'error' ], // Node safety.
    'no-return-assign':        [ 'error' ], // Best practices.
    'no-self-compare':         [ 'error' ], // Best practices.
    'no-tabs':                 [ 'error' ], // Stylistic.
    'no-unused-expressions':   [
      'error',
      {
        allowTernary: true
      }
    ], // Best practices.
    'no-use-before-define':    [ 'error' ], // Variables.
    'no-warning-comments':     [ 'warn' ], // Documentation.
    'object-property-newline': [ 'error' ], // Stylistic.
    'require-jsdoc':           [ 'warn' ], // Documentation.

    strict: [ // Best practices.
      'error',
      'safe'
    ],

    'valid-jsdoc': [ 'warn' ], // Documentation.

    'comma-dangle': [
      'error',
      'only-multiline',
    ],
    'no-trailing-spaces': [
      'warn',
      {
        skipBlankLines: true,
        ignoreComments: true
      }
    ],
    yoda:   0,
    quotes: 0,

  } // Rules.
}; // Module.exports