Set My Lints

Herramienta para la rápida configuración de Git Hooks, Linters y Prettier.

Basta responder unas cuantas preguntas de preferencias y se instalará esLint, junton con los archivos de configuración y plugins necesarios; así como Husky junto con un gancho de pre-commit; lint-staged con un script de ejecución y, opcionalmente, Prettier configurado también para ejecución en commit y con archivos de configuración para evitar errores de formato al coexistir con el lint.

Install/Execute

Desde tu archivo raíz de proyecto, ejecuta el siguiente comando:

npx set-my-lints

Después de ejecutar el comando, deberás responder unas cuantas preguntas.

¿Qué incluye y cómo modificar?

Por defecto, todo funciona out of the box, pero si te interesa conocer qué hay detrás de la magia o cómo personalizar algo, te comparto una lista de recursos que puedes consultar:

eslint

Puedes visitar el sitio oficial de eslint para ver la lista de plugins y configuraciones disponibles, o puedes revisar directamente su documentación.

Dependiendo de tus respuestas, es posible que adicionalmente se instalen algunos de los siguientes plugins/configs:

• plugin-import
• plugin-jsx-a11y
• plugin-react
• plugin-react-hooks
• plugin-promise
• plugin-n
• plugin-vue
• plugin-typescript
• parser-typescript
• config-airbnb
• config-google
• config-standard
• config-prettier

prettier

Prettier es un formateador de código que permite que los códigos sean más legibles y mantenga el formato de código original. Puedes visitar el sitio oficial de prettier para ver la lista de configuraciones disponibles, o puedes revisar directamente su documentación.

lint-staged

Lint-staged es un plugin que permite ejecutar un script de linting en cada archivo que se agrega, modifica o elimina en el repositorio. De modo que antes realizar commit se revisa que los archivos cumplan con los requisitos de linting para evitar errores en tu repo.

Puedes visitar el repo oficial en github.

husky

Husky es un plugin que permite configurar ganchos de git (Git Hooks) para realizar distintas acciones en las distintas etapas de un commit. Set-my-lints inicializa un gancho de pre-commit de modo que antes de que se registre tu commit se ejecute lint-staged y se revise el formato de tu código a través de esLint y Prettier.

Puedes visitar su sitio web para ver la lista de ganchos disponibles y sus configuraciones.

TODO:

• [ ] Añadir Yarn como método de instalación