esbnb

    1.1.3 • Public • Published

    esbnb

    The ESLint with Airbnb configuration installer.

    Table of Contents

    Installation

    It is recommended to install esbnb globally.

    npm i -g esbnb

    Technical information

    Node.js

    • Language: JavaScript ES6/ES7
    • VM: Node.js >=8.17.0

    Tests

    Command to run all tests:

    npm test

    Linting

    ESLint with Airbnb base rules. See Airbnb JavaScript Style Guide.

    npm run test:lint

    Unit

    Mocha and Chai.

    npm run test:unit

    Usage

    ESLint can be installed with 3 configurations from Airbnb: airbnb, airbnb-base and airbnb-base/legacy.

    For more details on which packages are installed with ESlint see :

    Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ and React (default)

    At the root of your project, run:

    esbnb

    Install ESLint with the Airbnb ESLint rules, including ECMAScript 6+ (base)

    At the root of your project, run:

    esbnb base

    Install ESLint with the Airbnb ESLint rules, including ECMAScript 5 and below (legacy)

    At the root of your project, run:

    esbnb legacy

    Need basic help ?

    At the root of your project, run:

    esbnb -h||-help

    Configuration

    No configuration are required from your own.

    esbnb installs and automatically configures your .eslintrc file. It only adds the configuration name in the extends property. If some values were present that are not an Airbnb config name, the extends property will be an array with all these values plus the Airbnb one. If another Airbnb config is found, it will be replaced by the one being installed.

    Before any process, a copy of your .eslintrc is made in the case of something would go wrong. You'll find it in the esbnb package installed globally in the configs directory.

    If no .eslintrc file were found, a new one will be created with proper configuration.

    Example of a new .eslintrc file created when installing ESLint with Airbnb base configuration :

    {
      "extends": "airbnb-base"
    }

    Examples of an existing .eslintrc file already configured when installing ESLint with Airbnb base configuration :

    Before:

    {
      "extends": "my-config"
    }

    After:

    {
      "extends": [
        "my-config",
        "airbnb-base"
      ]
    }

    Before:

    {
      "extends": "airbnb-base/legacy"
    }

    After:

    {
      "extends": "airbnb-base"
    }

    Code of Conduct

    This project has a Code of Conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    Contributing

    Please have a look at our TODO for any work in progress.

    Please take also a moment to read our Contributing Guidelines if you haven't yet done so.

    Support

    Please see our Support page if you have any questions or for any help needed.

    Security

    For any security concerns or issues, please visit our Security Policy page.

    License

    MIT.

    Install

    npm i esbnb

    DownloadsWeekly Downloads

    13

    Version

    1.1.3

    License

    MIT

    Unpacked Size

    14.5 kB

    Total Files

    6

    Last publish

    Collaborators

    • adrienv1520