npm package: @lumston/eslint-config-lumston
Description: Shared configurations for cleancode to lumston
Author: jsalazar
Latest version: 1.1.0

<p align="center">
  <a href="" rel="noopener">
 <img width=200px height=200px src="assets/lumston_logo.jpeg" alt="Project logo"></a>
</p>

<h3 align="center">Lumston clean code</h3>

<div align="center">

[![Status](https://img.shields.io/badge/status-active-success.svg)]()
[![GitHub Issues](https://img.shields.io/github/issues/kylelobo/The-Documentation-Compendium.svg)](https://github.com/lumston-cleancode-javascript-backend/issues)
[![GitHub Pull Requests](https://img.shields.io/github/issues-pr/kylelobo/The-Documentation-Compendium.svg)](https://github.com/lumston-cleancode-javascript-backend/pulls)
[![License](https://img.shields.io/badge/license-MIT-blue.svg)](/LICENSE)

</div>

---

<p align="center"> Lumston es una empresa de desarrollo de software enfocada en entregar software mexicano de clase mundial
    <br> 
</p>

## 📝 Tabla de contenidos

- [Acerca de](#about)
- [Empezando](#getting_started)
- [Despliegue](#deployment)
- [Uso](#usage)
- [Construido usando](#built_using)
- [contribuyentes](../CONTRIBUTING.md)
- [Autores](#authors)
- [Reconocimientos](#acknowledgement)

## 🧐 Acerca de <a name = "about"></a>
Este proyecto busca mejorar las practicas de nuestros desarrolladores y empujarlos a desarrollar codigo de calidad y con las mejores practicas.
## 🏁 Empezando <a name = "getting_started"></a>

Estas instrucciones te ayudaran a configurar las reglas definidas por lumston para cumplir con nuestros estandares de clean code.

### Prerequisitos

Tener instalado eslint y configurado para tu proyecto de typescript.
Este es un ejemplo del archivo: eslintrc.js, que debe de estar en la carpeta raiz y su configuracion recomendada.

```js
module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: 'tsconfig.json',
    tsconfigRootDir: __dirname,
    sourceType: 'module',
  },
  plugins: ['@typescript-eslint/eslint-plugin'],
  extends: [
    'plugin:@typescript-eslint/recommended',
    'plugin:prettier/recommended',
  ],
  root: true,
  env: {
    node: true,
    jest: true,
  },
  ignorePatterns: ['.eslintrc.js'],
  rules: {
    
  }
};

```

### 👨🏻‍💻 Instalacion
```sh
npm i @lumston/eslint-config-lumston
```

En nuestro archivo eslintrc.js, en nuestra key extends agregamos el nombre del paquete

```js
'@lumston/eslint-config-lumston'
```

## 🎈 Uso <a name="usage"></a>

Este es un ejemplo, de como deberia de quedar configurado el archivo

```js
module.exports = {
  parser: '@typescript-eslint/parser',
  parserOptions: {
    project: 'tsconfig.json',
    tsconfigRootDir: __dirname,
    sourceType: 'module',
  },
  plugins: ['@typescript-eslint/eslint-plugin'],
  extends: [
    'plugin:@typescript-eslint/recommended',
    'plugin:prettier/recommended',
   '@lumston/eslint-config-lumston'
  ],
  root: true,
  env: {
    node: true,
    jest: true,
  },
  ignorePatterns: ['.eslintrc.js'],
  rules: {
    
  }
};
```

## ⛏️ Construido usando <a name = "built_using"></a>

- [Eslint](https://eslint.org/) - Libreria

## ✍️ Autores <a name = "authors"></a>

- [jsalazar@lumston.com](https://github.com/javiersalazardev) - Idea y trabajo inicial
- [otorres@lumston.com](https://github.com/otorresls) - Idea e implementación 
- [olizarraga@lumston.com](https://github.com/olizarrarga-lumston) - Idea e implementación


Tambien puedes revisar la lista de contribuyentes [contribuyentes](https://github.com/lumston-cleancode-javascript-backend/contributors) que participaron en el proyecto.

## 🎉 Reconocimientos <a name = "acknowledgement"></a>

- https://eslint.org/docs/latest/extend/shareable-configs