eslint-config-trybe

ESLint shared configs used by projects from the Fundamentals and Back-end modules

Installation

Instructions should be the same for all three packages, with the only difference being the package names.

These are the package names for each module:

• Fundamentals: eslint-config-trybe-fundamentals
• Back-end: eslint-config-trybe-backend

Once you've chosen a package, install it with:

$ npm i eslint-config-trybe-fundamentals

Usage

Extend the chosen config on the .eslintrc.json of the project:

{
  "extends": "trybe-fundamentals"
}

Rules

Each package defines a set of ESLint rules judged appropriate for the given module. To see the rules defined by each package, go to the packages folder and, inside the folder for the desired package, open config.json

Creating new packages

To create a new package, create its folder inside the packages folder and create a new NodeJS package (using plain old npm init) inside it.

The config file should be named config.json, and this should be the entrypoint of the package.

The folder name should be everything that comes after eslint-config-trybe in the package name. So, for eslint-config-trybe-new-module, the package folder should be called new-module.

Publishing

This is a monorepo managed by Lerna. You should read Lerna's docs before publishing.

The versioning mode is independent.

To publish changed packages:

1. Make shure you're logged in npm:

npm login

If you're not in our organization, reach us at #curriculo-suporte:

2. Install the packages

npm i

3. Publish:

$ npx lerna publish