ryanmcdermott/clean-code-javascript

clean-code-javascript is a long article, kept as a markdown document in this repository, that translates the ideas from Robert C. Martin's book Clean Code into examples written in JavaScript. The book is a well-known guide on how to write code that other people, including your future self, can comfortably read, change, and reuse. Because the original examples in the book are in Java, the author of this repo went through the principles and rewrote them with JavaScript-style examples so JavaScript developers can apply the same advice in their own work. The README is structured as a table of contents covering naming variables, designing functions, organising objects and classes, the SOLID set of object-oriented design principles, testing, concurrency, error handling, formatting, and comments. Each section explains a single guideline in plain language and shows a Bad version of a small piece of JavaScript followed by a Good version that follows the rule. Examples cover ideas such as using meaningful names, keeping functions small and focused, avoiding magic numbers, using default parameters, limiting how many arguments a function takes, and not repeating context that is already implied by the surrounding object. The author is clear that this is not a strict style guide and that not every rule has to be followed in every situation, the document is meant as a reference to discuss code quality with teammates and to assess your own JavaScript. Someone might use it while reviewing pull requests, learning to refactor, onboarding into a team that values readable code, or studying object-oriented design with concrete examples.