eslint-config-zumata

eslint-config-zumata

This package provides Airbnb's .eslintrc as an extensible shared config specifically for Zumata's Node.js modules.

Use case

This ESLint config file does not aim to reinvent the wheel to suit our internal purpose in Zumata when writing a Node.js module. It basically extends and modifies the widely known Airbnb's Javascript style guide by not including dependencies such as eslint-plugin-jsx-a11y and eslint-plugin-react which are not being used in linting any of our Node.js modules so that to keep our dependencies' hierarchy clean, tidy and small as possible.

Setup

Prerequisites

Please make sure that you have the followings installed on your machine:

• node >= 6.9.1 (In Zumata, we internally use the latest LTS version (node:boron) for all our Node.js applications.)
• npm >= 3.10.8 (The minimum NPM version for node:boron.)
• eslint >= 3.8.0 (No guarantee it will work below the version specified here)
• eslint-plugin-import >= 2.0.1 (No guarantee it will work below the version specified here)
• eslint-plugin-optimize-regex >= 1.1.1 (No guarantee it will work below the version specified here)
• eslint-plugin-security >= 1.3.0 (No guarantee it will work below the version specified here)
• ESLint extension for your favorite text editor

Usage

• Create .eslintrc.json or .eslintrc (See Configuring ESLint) and add the following into the file:

  # Extend .eslintrc.json
  {
    "extends": [ "zumata" ]
  }
  

• Create .eslintignore to tell ESLint to skip linting the files inside directories. For example,

  # Ignore files to skip linting.
  dist/**
  **dist/**
  

• Then install the required dependencies to start the integration.

  # Install with NPM
  $ npm install --save-dev eslint eslint-config-zumata
  

• ESLint should be up and running in your favorite text editor with all the config files needed. Enjoy #eslinting!~

About the config

Our default export contains all of our ESLint rules, including ECMAScript 6+. It requires the followings:-

• eslint
• eslint-config-airbnb-base
• eslint-plugin-import
• eslint-plugin-optimize-regex
• eslint-plugin-security

See Airbnb's Javascript styleguide and the ESlint config docs for more information.

License

MIT License © The Zumata Team