Angular Style Guide

Naming conventions, file structure, and coding standards for Angular projects.

majiayu000 af1141a 2 files · 2.0 KB Updated 567 repo stars

File contents

Angular Style Guide

Priority: P0 (CRITICAL)

Principles

  • Single Responsibility: One component/service per file. Small functions (< 75 lines).
  • Size Limits: Keep files under 400 lines. Refactor if larger.
  • Strict Naming: feature.type.ts (e.g., hero-list.component.ts).
  • Barrels: Use index.ts only for public APIs of specific features/libraries. Avoid deep barrel imports within the same feature.
  • LIFT: Locate, Identify, Flat structure, Try DRY.

Naming Standards

  • Files: kebab-case.type.ts
  • Classes: PascalCase + Type suffix (HeroListComponent)
  • Directives: camelCase selector (appHighlight)
  • Pipes: camelCase name (truncate)
  • Services: PascalCase + Service suffix (HeroService)

Anti-Patterns

  • Logic in Templates: Move complex logic to the component class or a computed signal.
  • Deep Nesting: Avoid $>3$ levels of folder nesting.
  • Prefixing interfaces: No IUser. Use User.

References

  • Naming Conventions

majiayu000/claude-skill-registry-data/tree/main/development/style-guide-hoangnguyen0403-agent-skills-standar commit af1141aeac

Frequently asked questions

npx skillmds add majiayu000/angular-style-guide