>_ DevTrendsit

Lingua

Home

Linguaggi

Sezioni

Frontend Backend Mobile DevOps AI / ML GameDev Blockchain Embedded Sicurezza
JavaScript

Clean Code JavaScript - Come Scrivere Codice di cui Non Ti Vergogni Davanti ai Colleghi

94.452 stelle

Conosci quella sensazione quando apri del codice vecchio e non capisci cosa volevi dire? O quando un collega ti chiede aiuto con il suo script e passi ore cercando di decifrarlo? Il repository Clean Code JavaScript è una raccolta di regole pratiche che ti aiuteranno a rendere il tuo codice comprensibile, manutenibile e professionale.

Perché il codice pulito è così importante?

In oltre 15 anni di lavoro con JavaScript, ho visto centinaia di progetti. E il problema principale della maggior parte di essi non è la complessità algoritmica, ma l'illeggibilità del codice. Passiamo 10 volte più tempo a leggere il codice che a scriverlo. Clean Code JavaScript è un adattamento del famoso libro di Robert Martin "Clean Code" per il mondo JavaScript.

Come dice l'autore del repository Ryan McDermott:

"Ogni pezzo di codice inizia come una bozza grezza, come l'argilla umida che prende la sua forma finale. Scaviamo le imperfezioni quando lo revisioniamo con i colleghi."

5 principi chiave dal repository

1. Nomi di variabili significativi

Il primo passo per un codice pulito è la denominazione corretta. Dovrebbero essere:

  • Pronunciabili
  • Cercabili (così puoi trovarli tramite Ctrl+F)
  • Non richiedere traduzione mentale

Male:

const yyyymmdstr = moment().format('YYYY/MM/DD');

Bene:

const currentDate = moment().format('YYYY/MM/DD');

2. Le funzioni dovrebbero fare una sola cosa

Questo errore appare nel 90% dei progetti. Una funzione non è un romanzo, ma una poesia breve.

Male:

function emailClients(clients) {
  clients.forEach(client => {
    const record = database.lookup(client);
    if (record.isActive()) email(client);
  });
}

Bene:

function emailActiveClients(clients) {
  clients.filter(isActiveClient).forEach(email);
}

function isActiveClient(client) {
  const record = database.lookup(client);
  return record.isActive();
}

3. Evita gli effetti collaterali

Una funzione non dovrebbe modificare nulla al di fuori della sua area di responsabilità. Questo è particolarmente importante quando si lavora con array e oggetti.

Male:

const addItemToCart = (cart, item) => {
  cart.push({ item, date: Date.now() });
};

Bene:

const addItemToCart = (cart, item) => {
  return [...cart, { item, date: Date.now() }];
};

4. SOLID per JavaScript

I principi SOLID funzionano non solo in Java e C#. Ecco come appare l'Inversione delle Dipendenze in JS:

Male:

class InventoryTracker {
  constructor(items) {
    this.items = items;
    this.requester = new InventoryRequester();
  }
}

Bene:

class InventoryTracker {
  constructor(items, requester) {
    this.items = items;
    this.requester = requester;
  }
}

5. Testabilità

Il codice pulito è codice testabile. Ogni funzione dovrebbe avere una singola responsabilità e un risultato prevedibile.

Male:

describe('MomentJS', () => {
  it('handles all cases', () => {
    // 20 строк теста разных сценариев
  });
});

Bene:

describe('MomentJS', () => {
  it('handles 30-day months', () => {
    // один четкий сценарий
  });
  
  it('handles leap year', () => {
    // другой сценарий
  });
});

Chi trarrà beneficio da questo repository?

  • Sviluppatori Junior: Capirai la differenza tra codice che funziona e codice buono
  • Team Lead: Puoi usare questi principi per la code review
  • Istruttori: Otterrai eccellenti esempi per i corsi di JavaScript
  • Freelancer: I clienti apprezzano il codice pulito e manutenibile

Esperienza personale di implementazione

Nella mia pratica, c'era un progetto con 50 file di 500+ righe di codice ciascuno. Dopo aver implementato i principi del Clean Code:

  • Il tempo per aggiungere nuove funzionalità è diminuito del 40%
  • Il numero di bug in produzione è sceso di 3 volte
  • I nuovi sviluppatori si sono integrati 2 volte più velocemente

Come iniziare a usarli?

  1. Salva il repository nei preferiti
  2. Scegli 2-3 regole che violi più spesso
  3. Inizia ad applicarle nel nuovo codice
  4. Rifattorizza gradualmente le sezioni vecchie

Come dice l'autore: "Queste regole non sono dogma, ma una guida. La nostra professione è giovane, e stiamo ancora imparando."

Link:

Progetti correlati