@alsanium/eslint-config-babel

Alsanium's Babel shareable config for ESLint.


Keywords
eslint, eslintconfig, eslint-config, shareable config, lint, jshint, jslint, code checker, code linter, code standards, code style, style checker, style linter, javascript, ecmascript, es6, es2015, es7, es2016, babel
License
Unlicense
Install
npm install @alsanium/eslint-config-babel@1.0.0-alpha.6

Documentation

@alsanium/eslint-config-babel

NPM version Dependencies status Dev dependencies status Peer dependencies status Travis CI status

It provides Alsanium's Babel rules for ESLint as a shareabale configuration by following the upstream versions of ESLint and eslint-plugin-babel and by setting an idiomatic value for each available rule.

Usage

Basic

  • Create a .eslintrc.yml configuration file at the base of your project directory

    root: true
    
    extends:
      - "@alsanium/babel"
  • Invoke ESLint to lint your JavaScript files

    ./node_modules/.bin/eslint --no-inline-config .

Advanced

  • The rules.yml file contains the provided rules divided into several categories to help you better understand their value. For more information on how to override them, please see the rules documentation of ESLint.
  • See also npm-scripts to create a lint target in your package.json.
  • See also Gulp and the gulp-eslint plugin to create a more streamlined linting process.

Installation

  • Install peer dependencies

    npm install --save-dev \
      eslint@1.10.3 \
      @alsanium/eslint-config-base@^1.0.0-alpha \
      babel-eslint@5.0.0-beta4 \
      eslint-plugin-babel@3.0.0
  • Install @alsanium/eslint-config-babel

    npm install --save-dev @alsanium/eslint-config-babel@^1.0.0-alpha

Peer dependencies

Name Version
eslint 1.10.3
@alsanium/eslint-config-base 1.0.0-alpha
babel-eslint 5.0.0-beta6
eslint-plugin-babel 3.0.0

With npm version 3 and later, peerDependencies are no longer installed automatically.

Help

  • The User Guide documentation of ESLint discusses the specifics of all instructions to use in a .eslintrc.yml file along with an extensive help on how to install, configure and use ESlint.

  • If you have any problems with, or questions about this package, please contact us through a GitHub issue.

Contributing

You are invited to contribute new features, fixes, or updates, large or small; we are always thrilled to receive pull requests, and do our best to process them as fast as we can.

Before you start to code, we recommend discussing your plans through a GitHub issue, especially for more ambitious contributions. This gives other contributors a chance to point you in the right direction, give you feedback on your design, and help you find out if someone else is working on the same thing.

Thank you, contributors!

License

This is free and unencumbered software released into the public domain.

You can check out the full license here or here.

About

This package is created and maintained by @fsenart.
The names and logos for Alsanium are trademarks of Alsanium, S.A.S.