.eslintrc.yml

---
root: true

env:
    node: true
    es6: true
    jest/globals: true

settings:
    jest:
        version: 27

parserOptions:
    sourceType: script

globals:
    # Allow the Intl global but don't allow it to be overwritten
    Intl: false

plugins:
    - promise
    - unicorn
    - node
    - jest

extends:
    - 'eslint:recommended'
    - 'plugin:promise/recommended'
    - 'plugin:unicorn/recommended'
    - 'plugin:node/recommended'

rules:

### POSSIBLE ERRORS
    getter-return: error
    no-await-in-loop: error
    # This seems like a good idea, but questionable value?
    no-prototype-builtins: off
    no-template-curly-in-string: error
    valid-jsdoc:
        - error
        - 
            prefer:
                return: returns
                arg: param
                class: constructor
            preferType:
                object: Object
                bool: boolean

### BEST PRACTICES
    accessor-pairs: error
    array-callback-return: error
    block-scoped-var: error
    class-methods-use-this: warn
    consistent-return: error
    curly:
        - error
        - all
    default-case: error
    dot-location:
        - error
        - property
    dot-notation: error
    eqeqeq: error
    guard-for-in: error
    no-alert: error
    no-caller: error
    no-div-regex: warn
    no-else-return: error
    no-empty-function: warn
    no-eval: error
    no-extend-native: error
    no-extra-bind: error
    no-floating-decimal: error
    no-global-assign: error
    no-implicit-coercion: warn
    no-implicit-globals: error
    no-implied-eval: error
    no-invalid-this: error
    no-iterator: error
    no-labels: 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-return-await: error
    no-script-url: error
    no-self-compare: error
    no-sequences: error
    no-throw-literal: error
    no-unmodified-loop-condition: error
    no-unused-expressions: error
    no-useless-call: error
    no-useless-concat: error
    no-useless-return: error
    no-void: error
    no-with: error
    prefer-promise-reject-errors: error
    radix: error
    require-await: warn
    wrap-iife: error
    yoda:
        - error
        - never
    # no-restricted-properties

### STRICT MODE
    strict:
        - error
        - safe

### VARIABLES
    no-catch-shadow: error
    no-delete-var: error
    no-shadow: error
    no-shadow-restricted-names: error
    # Turn on someday, just use null everywhere if we can
    no-undefined: off
    # We allow some unused args
    no-unused-vars:
        - error
        -
            args: after-used
    no-use-before-define: error

### NODE AND COMMONJS
    callback-return: error
    global-require: error
    handle-callback-err:
        - error
        - '^.*(e|E)rr'
    # Buffer constructor is unsafe, enable when we don't support Node 4.x anymore
    no-buffer-constructor: off
    no-mixed-requires: error
    no-new-require: error
    no-path-concat: error
    no-process-exit: error
    no-sync: error

### STYLISTIC ISSUES
    array-bracket-newline: &arraySpacingOptions
        - error
        - 
            multiline: true
            minItems: 2
    array-element-newline: *arraySpacingOptions
    block-spacing: error
    brace-style:
        - error
        - 1tbs
        - 
            allowSingleLine: true
    camelcase:
        - error
        - 
            properties: never
    comma-dangle:
        - error
        - only-multiline
    comma-spacing: error
    comma-style:
        - error
        - last
    consistent-this:
        - error
        - self
    eol-last: error
    func-call-spacing: error
    func-name-matching: error
    func-style:
        - error
        - declaration
        - 
            allowArrowFunctions: true
    implicit-arrow-linebreak: error
    # This rule can be customized for switch/case etc.
    indent:
        - error
        - tab
    key-spacing: error
    keyword-spacing:
        - error
        - 
            before: true
            after: true
    linebreak-style:
        - error
        - unix
    lines-between-class-members: error
    max-depth: error
    # We should turn this on to enforce readable line lengths
    max-len:
        - off
        - 120
    max-params:
        - error
        - 6
    max-statements-per-line:
        - error
        - 
            max: 1
    multiline-ternary:
        - error
        - never
    new-cap: error
    new-parens: error
    newline-per-chained-call:
        - error
        - 
            ignoreChainWithDepth: 2
    no-array-constructor: error
    no-bitwise: warn
    no-continue: error
    no-lonely-if: error
    no-mixed-operators: error
    no-multi-assign: error
    no-multiple-empty-lines: error
    no-negated-condition: error
    no-nested-ternary: error
    no-new-object: error
    no-plusplus:
        - error
        - 
            allowForLoopAfterthoughts: true
    no-trailing-spaces: error
    no-unneeded-ternary: error
    no-whitespace-before-property: error
    one-var-declaration-per-line: error
    operator-assignment: error
    quote-props:
        - error
        - as-needed
    quotes:
        - error
        - single
        - avoid-escape
    require-jsdoc:
        - error
        - 
            require:
                FunctionDeclaration: true
                MethodDefinition: true
                ClassDeclaration: true
    semi:
        - error
        - always
    semi-spacing: error
    semi-style:
        - error
        - last
    space-before-blocks: error
    space-before-function-paren:
        - error
        - never
    space-infix-ops: error
    space-unary-ops:
        - error
        - 
            words: true
            nonwords: false
    spaced-comment:
        - error
        - always
    switch-colon-spacing: error
    template-tag-spacing:
        - error
        - never
    unicode-bom: error

### ES6
    arrow-body-style:
        - error
        - as-needed
    arrow-parens:
        - error
        - as-needed
    arrow-spacing: error
    generator-star-spacing:
        - error
        - after
    no-confusing-arrow:
        - error
        - 
            allowParens: true
    no-duplicate-imports:
        - error
        - 
            includeExports: true
    no-useless-computed-key: error
    no-useless-constructor: error
    no-useless-rename: error
    # Turn this on when we support only newer Node versions
    no-var: off
    object-shorthand:
        - warn
        - always
        - 
            avoidQuotes: true
            avoidExplicitReturnArrows: true
    prefer-arrow-callback:
        - error
        - 
            allowNamedFunctions: true
    # Turn on when we don't support older Node.js versions
    prefer-destructuring: off
    prefer-numeric-literals: error
    # Turn on when we don't support older Node.js versions
    prefer-rest-params: off
    # Turn on when we don't support older Node.js versions
    prefer-spread: off
    prefer-template: error
    rest-spread-spacing:
        - error
        - never
    symbol-description: error
    template-curly-spacing:
        - error
        - never
    yield-star-spacing:
        - error
        - after
### PROMISES
    promise/no-nesting: off
    # Disable as Promise already suppported in native NodeJS
    # promise/no-native: error
    promise/no-promise-in-callback: error
    promise/no-callback-in-promise: error
    # promise/avoid-new: error
    promise/no-return-in-finally: error

### UNICORN
    # Need to disable until we no longer support Node 4
    unicorn/no-new-buffer: off

### NODE
    node/no-deprecated-api:
        - error
        -
            ignoreGlobalItems:
                - new Buffer()
    node/exports-style:
        - error
        - module.exports

    node/no-missing-require:
        - error
        - tryExtensions:
            - ".js"
            - ".ts"