Saltar a contenido

Using linters and formatters

El principio "Using linters and formatters" se refiere al uso de herramientas de software que ayudan a garantizar que el código esté escrito de manera consistente y siga las convenciones de estilo definidas. Un linter es una herramienta que analiza el código para detectar errores de sintaxis y estilo, mientras que un formatter es una herramienta que formatea automáticamente el código según un conjunto de reglas predefinidas.

Al utilizar linters y formatters, se puede mejorar la calidad del código, hacer que sea más fácil de leer y mantener, y evitar errores comunes de programación. Además, se puede garantizar que el código siga las convenciones de estilo definidas por el equipo de desarrollo, lo que puede ayudar a mantener la coherencia y la claridad en todo el código base.

En general, el uso de linters y formatters es una buena práctica de desarrollo de software en todos los lenguajes de programación, incluyendo el frontend. Las herramientas de linter y formatter más populares en el mundo frontend incluyen ESLint y Prettier para JavaScript y TypeScript, Stylelint para CSS y SCSS, y TSLint para TypeScript.

Es importante destacar que, aunque estas herramientas son útiles, no deben ser utilizadas como una solución mágica para garantizar la calidad del código. Todavía es necesario que los desarrolladores revisen el código y realicen pruebas para detectar errores y garantizar que el código esté funcionando correctamente.

Recomendaciones

  1. Seleccionar una herramienta de linter y formatter adecuada para el lenguaje y el framework utilizado en el proyecto. Algunas de las herramientas mencionadas anteriormente, como ESLint y Prettier, son compatibles con múltiples lenguajes y frameworks.

  2. Configurar las reglas de linter y formatter según las convenciones de estilo y buenas prácticas definidas por el equipo de desarrollo. Estas reglas pueden incluir la longitud máxima de línea, la indentación, la presencia de espacios en blanco y otros aspectos de estilo.

  3. Integrar la herramienta de linter y formatter en el flujo de trabajo de desarrollo, preferiblemente utilizando herramientas de automatización de tareas como Gulp o Grunt. Esto permitirá que el código sea analizado y formateado automáticamente durante el proceso de construcción.

  4. Realizar pruebas en el código para detectar y corregir errores de sintaxis y estilo, utilizando la herramienta de linter y formatter como guía.

  5. Realizar revisiones de código y discutir las reglas y convenciones de estilo con otros miembros del equipo de desarrollo para mantener la coherencia y la calidad en todo el código base.

Al seguir estos pasos, el uso de linters y formatters puede ayudar a mejorar la calidad y la consistencia del código en el proyecto de frontend.

¿Cómo aplicar el principio?

Para utilizar linters y formatters en un proyecto de ReactJS, podemos seguir los siguientes pasos:

  1. Instalar las herramientas ESLint y Prettier como dependencias de desarrollo en nuestro proyecto:
    npm install eslint prettier --save-dev
    
  2. Crear los archivos de configuración para cada herramienta. Por ejemplo, podemos crear un archivo .eslintrc.json con las reglas de ESLint:

    {
    "extends": ["eslint:recommended", "plugin:react/recommended"],
    "parserOptions": {
        "ecmaVersion": 2018,
        "sourceType": "module",
        "ecmaFeatures": {
        "jsx": true
        }
    },
    "plugins": ["react"],
    "rules": {
        "react/prop-types": "off"
    }
    }
    
    Y un archivo .prettierrc.json con las reglas de Prettier:

    {
    "singleQuote": true,
    "trailingComma": "es5"
    }
    
  3. Configurar nuestro editor de código para que utilice estas herramientas. Por ejemplo, podemos instalar una extensión de ESLint y configurarla para que utilice nuestro archivo .eslintrc.json. Y también podemos instalar una extensión de Prettier y configurarla para que utilice nuestro archivo .prettierrc.json.

  4. Ejecutar las herramientas en nuestro código para detectar errores y corregirlos. Por ejemplo, podemos utilizar el siguiente comando para ejecutar ESLint:

    npx eslint src
    
    Y utilizar el siguiente comando para ejecutar Prettier:
    npx prettier --write src
    

  5. Configurar nuestro proyecto para que las herramientas se ejecuten automáticamente en el código al guardar o al realizar un commit. Por ejemplo, podemos utilizar una herramienta como Husky para configurar un pre-commit hook que ejecute ESLint y Prettier.