eslint-config-actano-base

    7.0.0 • Public • Published

    Actano Javascript Style Guide

    npm code style: actano-base

    This package provides Actano's .eslintrc.json as an extensible shared config. It extends the popular config by Airbnb and changes a few rules to fit our taste.

    Usage

    Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires eslint and eslint-plugin-import.

    Install this package and all its peer dependencies. Unfortunately, they cannot be normal dependencies. Please consult the package.json for correct version information of the peer dependencies.

    yarn add --dev eslint eslint-config-actano-base eslint-plugin-import

    Create an .eslintrc.yml with this content:

    extends: actano-base

    You might need enable the mocha context and allow having no-unused-expression in your test files by configuring this in a separate .eslintrc.yml inside your test directory:

    env:
        mocha: true
    rules:
        no-unused-expressions: off

    Deviations from Airbnb

    We are adopting most of the rules from Airbnb. Please check out their styleguide to get the full picture.

    We do have different opinions on these topics:

    Semicolons

    They are not needed and code looks better without them. eslint: semi

    Function names

    Allow function expressions without a name. eslint: func-names

    Underscores in function names

    We use leading underscores to express that a function is private. eslint: no-underscore-dangle

    Constant conditions

    When using generators, while (true) loops make sense. eslint: no-constant-condition

    Iterators

    We want to use generators. eslint: no-iterator

    ForOfStatement

    for .. of loops provide an easy way to iterate through iterators. eslint: no-restricted-syntax

    Arrow functions

    We want to not be forced how are writing our arrow function bodies. eslint: implicit-arrow-linebreak

    Install

    npm i eslint-config-actano-base

    DownloadsWeekly Downloads

    656

    Version

    7.0.0

    License

    MIT

    Unpacked Size

    3.98 kB

    Total Files

    3

    Last publish

    Collaborators

    • cvitz.xpure
    • rplan-ci
    • trucker