How andersontr15/clean-code-javascript-es works
Main Components (Modules) of the Documentation
• A central “Clean Code for JavaScript” module that represents the core theme.
• Several distinct sections (or “chapters”) as components:
– Introduction (with its image and overall philosophy)
– Variables (covering naming conventions and usages)
– Functions (including topics like function parameter guidelines, levels of abstraction, single responsibility, avoiding effects, etc.)
– Objects and Data Structures (focusing on getters/setters, encapsulation, private members)
– Classes (discussing ES6 classes, composition vs. inheritance, chainable methods)
– SOLID Principles (with subcomponents for SRP, OCP, LSP, ISP, DIP)
– Testing (best practices like having discrete tests for each case)
– Concurrency (promises and async/await vs. callbacks)
– Error Handling (and reporting errors as they occur)
– Formatting (ensuring consistent naming, indenting, order, etc.)
– Comments (with guidance on when and how to comment)
Relationships and Interactions
• Optionally, if desired, group some of these sections that are conceptually related (for example, “Variables,” “Functions,” “Objects and Data Structures,” and “Classes” could be grouped under “Coding Practices”, while “SOLID” and “Error Handling” may be grouped under “Design Principles”).
Important Architectural Patterns and Design Principles
• That the “documentation” is structured as a layered guide where each section builds on fundamental design and coding principles.
• Concept that the document promotes a philosophy similar to modular design: each section stands alone yet contributes to the holistic approach in writing clean, maintainable code.
Following Elements
• Clear Labels: Each component should have a label (e.g., “Variables”, “Functions”, etc.).
• A separate note indicating that although the repository comprises no “runtime code” modules, each documentation section is conceptually analogous to a module in a larger application architecture.