Skip to content

tzeikob/eslint-config-aargh

Repository files navigation

eslint-config-aargh

npm version

This package provides an extensible ESLint base configuration for general purposes.

How to install

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires the eslint package along with the following eslint plugins,

  • eslint-plugin-import,
  • eslint-plugin-node,
  • eslint-plugin-promise

Install the correct versions of each package, which are listed by the following command.

npm info "eslint-config-aargh@latest" peerDependencies

If you are using npm 5+, use can use the following shortcut instead.

npx install-peerdeps --dev eslint-config-aargh

In case you are using npm < 5 you can run the following command.

(
  export PKG=eslint-config-aargh;
  npm info "$PKG@latest" peerDependencies --json | command sed 's/[\{\},]//g ; s/: /@/g' | xargs npm install --save-dev "$PKG@latest"
)

Which produces and runs a command as the following.

  npm install --save-dev eslint-config-aargh eslint@^#.#.# eslint-plugin-import@^#.#.# eslint-plugin-node@^#.#.# eslint-plugin-promise@^#.#.#

How to use

Create an .eslintrc file under the root folder of your project and add the following lines.

{
  "extends": "aargh",
  "rules": {}
}

Add rules into the rules property to override any default rules set by this configuration.

About

A strongly opinionated eslint configuration for seriously taken cartoonish javascript development.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published