eslint-plugin-unional v1.0.0

eslint-plugin-unional

A eslint config package with several styles to choose from.

Design Principles

There are several configurations available in this package. Although they are different as they are designed for different programers, here are the principles that they all follows:

• They are designed to be used by team
• Each team member can use their own IDE of choice
• The formatter available on each IDE should work with each configuration
• Code should look well and consistent on each IDE with folding
  • so that when you stop by your team member's cube, the code looks the same.
  • i.e., unfortunately, no tab
• Thrive for easy to write (with fewest keystrokes) while keeping the code clean

Installation

You'll first need to install ESLint:

npm i eslint --save-dev

Next, install eslint-plugin-unional:

npm install eslint-plugin-unional --save-dev

Note: If you installed ESLint globally (using the -g flag) then you must also install eslint-plugin-unional globally.

Usage

Add eslint-plugin-unional to the plugins section of your .eslintrc configuration file. You can omit the eslint-plugin- prefix:

{
  "extends": "plugin:unional/latest", // or other styles, e.g. "plugin:unional/default"
  "plugins": [
    "unional"
  ]
}

Note for JetBrains IDE

When cloning this project, and opening it on JetBrains IDE, you will see some errors such as process is not defined. You need to turn on NodeJS support on the IDE. Those lines are added just to keep JetBrains happy, (from no-unused-vars and no-console).

When using the config in your own project, you can get the codeStyles and inspectionProfiles. That should be sufficient.