Repolode
ryanmcdermott

ryanmcdermott/clean-code-javascript

Um guia que aplica os princípios de Clean Code, de Robert C. Martin, ao JavaScript, com exemplos de código ruim e bom sobre nomes, funções, classes e SOLID.

Estrelas
94,723
Forks
12,568
Issues abertas
124
Último commit
há 2 anos

O que é?

Este repositório adapta ao JavaScript os princípios de engenharia de software do livro Clean Code, de Robert C. Martin. Ele é apresentado como um conjunto de diretrizes para escrever código legível, reutilizável e fácil de refatorar, e não como um guia formal de estilo. Cada regra é ilustrada com um exemplo de código "Ruim" e outro "Bom".

O guia aborda variáveis e nomenclatura; design de funções (quantidade de argumentos, responsabilidade única, como evitar efeitos colaterais e flags); objetos e estruturas de dados; classes (classes do ES2015, composição em vez de herança e encadeamento de métodos); e os princípios SOLID. As seções posteriores tratam de testes, concorrência, tratamento de erros, formatação e comentários.

É especialmente útil para desenvolvedores que buscam exemplos concretos, no nível do código, de boas práticas de Clean Code em JavaScript, ou para equipes que queiram usá-lo como base para discussões em code reviews.

Recursos principais

  • 01Comparações entre código ruim e bom para cada princípio
  • 02Aborda nomenclatura, funções, objetos e classes
  • 03Inclui os princípios SOLID com exemplos em JavaScript
  • 04Discute como evitar efeitos colaterais e promover a imutabilidade
  • 05Orienta sobre quando preferir composição em vez de herança

Casos de uso

  • Aprender boas práticas de Clean Code como desenvolvedor JavaScript
  • Preparar material para diretrizes de code review da equipe
  • Refatorar código JavaScript legado para torná-lo mais legível e modular

Tópicos

Perguntas frequentes

O que é clean-code-javascript?
Um guia que aplica os princípios de Clean Code, de Robert C. Martin, ao JavaScript, com exemplos de código ruim e bom sobre nomes, funções, classes e SOLID. Este repositório adapta ao JavaScript os princípios de engenharia de software do livro Clean Code, de Robert C. Martin. Ele é apresentado como um conjunto de diretrizes para escrever código legível, reutilizável e fácil de refatorar, e não como um guia formal de estilo. Cada regra é ilustrada com um exemplo de código "Ruim" e outro "Bom".
clean-code-javascript é gratuito? Qual é a licença?
clean-code-javascript é open source sob a licença MIT. Confira os termos da licença antes de usá-lo em produtos comerciais.
clean-code-javascript ainda é mantido?
Sem commits há mais de 6 meses. O último commit de clean-code-javascript foi em 29 de jul. de 2024.
Para que posso usar clean-code-javascript?
Aprender boas práticas de Clean Code como desenvolvedor JavaScript Preparar material para diretrizes de code review da equipe Refatorar código JavaScript legado para torná-lo mais legível e modular
Onde consigo clean-code-javascript?
O código-fonte e as instruções de instalação estão no GitHub: https://github.com/ryanmcdermott/clean-code-javascript

Resumo gerado por IA a partir do README do projeto. As estatísticas do GitHub são atualizadas diariamente.

Projetos relacionados