Skip to content

EnergySage/eslint-config-energysage

Repository files navigation

eslint-config-energysage

An ESLint/Prettier/Stylelint Shareable Config For EnergySage Projects

This package provides EnergySage's base ESLint, Prettier & Stylelint rule bases.

Usage

  • Install the correct versions of each peer package, which are listed by the command:
npm info "eslint-config-energysage@latest" peerDependencies

And they can be installed using this command:

npx install-peerdeps --dev eslint-config-energysage
  • Install the latest version of our package
npm install --dev eslint-config-energysage@latest
  • Update/Create your .eslintrc.js file, ensure there are no duplicate plugin/config entries
    module.exports = {
        extends: ['eslint-config-energysage'],
        rules: {
            // Disable/Enable any custom rules for your project
        },
    };
  • Update your package.json file, ensure there is no .prettierrc file
    "prettier": "eslint-config-energysage/prettier",
    "scripts": {}
  • Update/Create your stylelint.config.js file, ensure there are no duplicate plugin/config entries
    module.exports = {
        extends: ['eslint-config-energysage/stylelint'],
        rules: {
            // Disable/Enable any custom rules for your project
        },
    };