Sobes.tech
Middle

Hogyan ellenőrzöd a kódstílus betartását a projektedben?

sobes.tech MI

Válasz az MI-től

Az egységes kódstílus fenntartása érdekében a következő eszközöket és folyamatokat használom:

  1. ESLint: Beállítom a kód formázási és minőségi szabályokat (pl. Airbnb vagy Standard). Az ESLint segít szintaktikai hibák, behúzási problémák, nem használt változók stb. felismerésében.

    // Példa .eslintrc.js
    module.exports = {
      extends: 'airbnb-base', // Vagy más kiválasztott stílus
      rules: {
        // Felülírni vagy hozzáadni szabályokat
        'semi': ['error', 'always'],
        'quotes': ['error', 'single']
      }
    };
    
  2. Prettier: Beépítem a Prettier-t az automatikus kódformázáshoz. Foglalkozik a szóközökkel, sortörésekkel, pontosvesszőkkel és más formázási részletekkel, együttműködve az ESLint-tel (pluginokon keresztül).

    // Példa .prettierrc.json
    {
      "semi": true,
      "singleQuote": true,
      "printWidth": 100
    }
    
  3. Husky és lint-staged: Beállítom a pre-commit hookokat Husky-val. A lint-staged segítségével csak a módosított (staged) fájlokon futtatok ESLint-et és Prettier-t. Ez garantálja, hogy csak formázott és ellenőrzött kód kerül a repository-ba.

    // Példa package.json (rész)
    {
      "husky": {
        "hooks": {
          "pre-commit": "lint-staged"
        }
      },
      "lint-staged": {
        "*.{js,jsx,ts,tsx}": [
          "eslint --fix",
          "prettier --write"
        ],
        "*.{css,scss,less}": [
          "stylelint --fix", // Ha Stylelint-et használok
          "prettier --write"
        ],
        "*.{html,vue,svelte}": [
          "prettier --write"
        ]
      }
    }
    
  4. Kód áttekintése: A kód áttekintése során figyelek arra, hogy betartsák-e a meghatározott kódstílus szabályokat, még akkor is, ha az automatikus eszközök valamit kihagytak vagy vannak olyan finomságok, amelyeket nem fednek le a szabályok.

  5. Dokumentáció: Fenntartok egy minimális dokumentációt az elfogadott kódstílusról a projektben (pl. README vagy CONTRIBUTING.md), hogy az új csapattagok gyorsan megismerkedjenek a szabályokkal.

  6. Integráció az IDE-be: Beállítom a szerkesztőket (VS Code, WebStorm stb.), hogy automatikusan formázzanak mentéskor, és az ESLint hibákat közvetlenül a szerkesztőben jelenítse meg.