.eslintrc.js

/*
 * Copyright 2018 Adobe. All rights reserved.
 * This file is licensed to you under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License. You may obtain a copy
 * of the License at http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software distributed under
 * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS
 * OF ANY KIND, either express or implied. See the License for the specific language
 * governing permissions and limitations under the License.
 */

const path = require('path');


module.exports = {
  'env': {
    'node': true,
    'es6': true
  },
  // this is the root project for all sub modules. stop searching for any
  // eslintrc files in parent directories.
  'root': true,
  'parserOptions': {
    'sourceType': 'script',
    'ecmaVersion': 10,
  },
  'plugins': [
    'header',
  ],
  'extends': 'airbnb',

  'settings': {
    'import/core-modules': ['ferrum.doctest', 'ferrum.doctest/cli']
  },

  'rules': {
    'strict': 0,

    'max-classes-per-file': 'off',

    // Allow while (true) infinite loops
    'no-constant-condition': ["error", { "checkLoops": false }],

    // Forbid multiple statements in one line
    'max-statements-per-line': ["error", { "max": 1 }],

    // Allow for-of loops
    'no-restricted-syntax': ['error', 'ForInStatement', 'WithStatement'],

    // Allow return before else & redundant else statements
    'no-else-return': 'off',

    // Dangling underscore is useful to mark variables/fields as private
    'no-underscore-dangle': 'off',

    // We have quite a lot of use cases where assignment to function
    // parameters is definitely desirable
    'no-param-reassign': 'off',

    // Allow marking variables unused using a underscore at the start
    'no-unused-vars': ["error", {
      "varsIgnorePattern": "^_.*$",
      "argsIgnorePattern": "^_.*$",
      "caughtErrorsIgnorePattern": "^_.*$"
    }],

    // Allow Anonymous generator functions
    'func-names': 'off',

    // Allow line break in one line arrow functions
    'implicit-arrow-linebreak': 'off',

    // Longer inline destructuring
    'object-curly-newline': 'off',

    // Required for some more complex algorithms
    'no-labels': 'off',
    'no-continue': 'off',
    'no-plusplus': 'off',
    'no-await-in-loop': 'off',

    // Allow destructuring
    'prefer-const': ['error', { 'destructuring': 'all' }],

    // enforce license header (todo: improve plugin to support patterns for multi-lines)
    'header/header': [2, 'block', ['',
      ' * Copyright 2019 Adobe. All rights reserved.',
      ' * This file is licensed to you under the Apache License, Version 2.0 (the "License");',
      ' * you may not use this file except in compliance with the License. You may obtain a copy',
      ' * of the License at http://www.apache.org/licenses/LICENSE-2.0',
      ' *',
      ' * Unless required by applicable law or agreed to in writing, software distributed under',
      ' * the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR REPRESENTATIONS',
      ' * OF ANY KIND, either express or implied. See the License for the specific language',
      ' * governing permissions and limitations under the License.',
      ' ',
    ]]
  }
};