@bsara/eslint-config

ESLint shareable configs for some very reasonable JavaScript coding standards created by bsara

Stats

stars 🌟issues ⚠️updated 🛠created 🐣size 🏋️‍♀️
Minified + gzip package size for @bsara/eslint-config in KB

Readme

@bsara/eslint-config NPM Package

ISC License

ESLint shareable configs for some very reasonable JavaScript coding standards created by bsara.

Changelog

Install

Project Install

$ npm install --save-dev eslint @bsara/eslint-config

Global Install

$ npm install -g eslint @bsara/eslint-config

Usage

Create an ESLint configuration file at the root of your project called .eslintrc.yml or .eslintrc.json and add the following to file:

{
  "extends": "@bsara"
}

Your local configuration will inherit all of the settings/rules defined by @bsara/eslint-config. Any settings/rules found in your local configuration file that conflict with a setting/rule found in @bsara/eslint-config will override whatever is found in @bsara/eslint-config.

See the official ESLint documentation for more information about Shareable Configs.


Sample YAML Configuration
parserOptions:
  sourceType: module

extends:
  - @bsara
  - @bsara/node

env:
  browser: true
  node:    true

Sample JSON Configuration
{
  "parserOptions": {
    "sourceType": "module"
  },

  "extends": [
    "@bsara",
    "@bsara/node"
  ],

  "env": {
    "browser": true,
    "node":    true
  }
}

License

ISC License (ISC)

Copyright (c) 2020, Brandon D. Sara (http://bsara.dev/)

Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies.

THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.

If you find any bugs or have a feature request, please open an issue on github!

The npm package download data comes from npm's download counts api and package details come from npms.io.