0.0.0 • Published 5 years ago

@eigi/eslint-config v0.0.0

Weekly downloads
-
License
MIT
Repository
-
Last release
5 years ago

@eigi/eslint-config

A customizable ESLint configuration for EIGI apps

About ESLint

For information on ESLint, please see their documentation.

Installation

With global Verdaccio registry

# for consumption outside of `uaf-main`, you can get ESLint config from our Verdaccio registry
yarn set registry http://verdaccio.dev.provo1.unifiedlayer.com

yarn add @eigi/eslint-config --dev

With Lerna

# if you are in the `uaf-main` mono-repo, use lerna to install it in your scoped package
lerna add @eigi/eslint-config --dev --scope=my-pkg

Installation with .yarnrc

For consumption outside of uaf-main, you can get ESLint config from our Verdaccio registry. Add the following to your root .yarnrc configuration file:

registry "https://registry.npmjs.org"
"@eigi:registry" "http://verdaccio.dev.provo1.unifiedlayer.com"
yarn add @eigi/eslint-config --dev

Usage

As is

To consume the config as is, you can reference the config as is in your package's package.json file as follows:

{
  ...,
  "eslintConfig": {
    "extends": "@eigi/eslint-config"
  },
  ...
}

Customizing

To customize, we will export a modified varation of the config in .eslint.config.js:

const config = require('@eigi/eslint-config');
module.exports = {
  // extend config as is
  ...config,

  // extends an additional config
  extends: [...config.extends, 'airbnb'],
};

Support

This package is maintained by Team 418.