@lumston/eslint-config-lumston

Lumston clean code

Lumston es una empresa de desarrollo de software enfocada en entregar software mexicano de clase mundial

📝 Tabla de contenidos

• Acerca de
• Empezando
• Despliegue
• Uso
• Construido usando
• contribuyentes
• Autores
• Reconocimientos

🧐 Acerca de

Este proyecto busca mejorar las practicas de nuestros desarrolladores y empujarlos a desarrollar codigo de calidad y con las mejores practicas.

🏁 Empezando

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.

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

npm i @lumston/eslint-config-lumston

En nuestro archivo eslintrc.js, en nuestra key extends agregamos el nombre del paquete

'@lumston/eslint-config-lumston'

🎈 Uso

Este es un ejemplo, de como deberia de quedar configurado el archivo

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

• Eslint - Libreria

✍️ Autores

• [e-mail] - Idea y trabajo inicial
• [e-mail] - Idea e implementación
• [e-mail] - Idea e implementación

Tambien puedes revisar la lista de contribuyentes contribuyentes que participaron en el proyecto.

🎉 Reconocimientos

• https://eslint.org/docs/latest/extend/shareable-configs