#atom

Documented conventions for writing consistent, maintainable code

Core Idea: Code style guides are established conventions and standards that define how code should be written within a team or project, ensuring consistency, readability, and maintainability across the codebase.

Key Elements

• Core Components:

  • Formatting rules (spacing, indentation, line length)
  • Naming conventions (variables, functions, classes)
  • Code organization practices
  • Documentation requirements
  • Architectural patterns
  • Forbidden practices and anti-patterns

• Common JavaScript Style Guides:

  • Airbnb: Comprehensive, strict, and widely adopted
  • Google: Emphasizes clarity and maintainability
  • StandardJS: No configuration, auto-fixing, minimal punctuation
  • Idiomatic.js: Focus on readability and team consistency

• Implementation Methods:

  • Written documentation (markdown, wiki, etc.)
  • Linter configurations (ESLint, TSLint, etc.)
  • Editor settings (.editorconfig)
  • Formatting tools (Prettier)
  • Code review checklists
  • Example repositories

• Benefits:

  • Reduces cognitive load when reading code
  • Eliminates debates about trivial style choices
  • Improves onboarding experience for new developers
  • Makes code reviews focus on substance rather than style
  • Increases long-term code maintainability
  • Creates predictable patterns across the codebase

• Example Style Guide Excerpt:

  // Airbnb Style Guide examples
  
  // Prefer const over let when variable won't be reassigned
  const count = 5;
  
  // Use camelCase for variables and functions
  function calculateTotal(itemCount) {
    return itemCount * pricePerItem;
  }
  
  // Use PascalCase for classes and React components
  class UserProfile {
    constructor(username) {
      this.username = username;
    }
  }
  
  // Use descriptive names, avoid single letters except in loops
  const userData = getUserData();  // Good
  const x = getUserData();         // Bad
  
  // Use template strings instead of concatenation
  const greeting = `Hello, ${username}!`;
  

## Connections

- **Related Concepts**: ESLint (tool for enforcing style), ESLint Configurations (technical implementation of style guides)
- **Broader Context**: Software Engineering Best Practices (includes coding standards)
- **Applications**: Code Reviews (where style violations are often caught)
- **Components**: Linting Tools (enforce style programmatically), Formatting Tools (automate style compliance)

## References

1. Airbnb JavaScript Style Guide: https://github.com/airbnb/javascript
2. Google JavaScript Style Guide: https://google.github.io/styleguide/jsguide.html
3. "Clean Code: A Handbook of Agile Software Craftsmanship" by Robert C. Martin
4. "The Art of Readable Code" by Dustin Boswell & Trevor Foucher

#code-quality #standards #style-guide #best-practices #programming

---
**Connections:**
- 
---
**Sources:**
- From: Syntax - Lint como un desarrollador senior con eslint + husky + lint staged + acciones de github