https://github.com/betrybe/eslint-config-trybe

ESLint shared config packages used be Trybe
https://github.com/betrybe/eslint-config-trybe

config eslint hacktoberfest shared trybe

Last synced: about 1 month ago
JSON representation

ESLint shared config packages used be Trybe

• Host: GitHub
• URL: https://github.com/betrybe/eslint-config-trybe
• Owner: betrybe
• License: gpl-3.0
• Created: 2020-12-12T14:15:57.000Z (about 4 years ago)
• Default Branch: main
• Last Pushed: 2024-01-19T14:00:11.000Z (11 months ago)
• Last Synced: 2024-04-16T19:41:14.452Z (8 months ago)
• Topics: config, eslint, hacktoberfest, shared, trybe
• Homepage: https://betrybe.com
• Size: 447 KB
• Stars: 57
• Watchers: 50
• Forks: 14
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

README

        
# 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:

```shell

$ npm i eslint-config-trybe-fundamentals

```

## Usage

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

```json

{

  "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](./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](https://github.com/lerna/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:

```shell

npm login

```

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

2. Install the packages

```shell

npm i

```

3. Publish:

```shell

$ npx lerna publish

```