Angular Best Practices

alfredoperez/angular-best-practices/skills/angular-best-practices

作者 alfredopereza499a4786182097a500dd2fb6ddc2489caee3854无许可证37 个星标收录于 2026年10月9日更新于 2026年10月9日仓库6个月前更新

Modern Angular best practices for building performant, maintainable Angular 17+ applications. Covers Signals, RxJS, components, templates, styles, performance, SSR, testing, forms, routing, accessibility, and architecture — with code examples and impact ratings for every rule. Use this skill whenever the user is working on Angular code of any kind: components, services, templates, stylesheets, routes, tests, or configuration. This applies to editing .component.ts, .service.ts, .html templates, .scss/.css styles, .spec.ts tests, .routes.ts files, store files, and any general .ts file in an Angular project. Look for angular.json, nx.json, or @angular/core imports as project indicators. Do not use for AngularJS (1.x), React, Vue, or non-Angular TypeScript projects.

AI 生成的概览

提供 Angular 17+ 现代最佳实践指南,涵盖信号、模板、RxJS、性能、SSR、测试与无障碍。

功能
该技能提供一套包含 112 条规则的 Angular 最佳实践,按组件与信号、模板与样式、服务与 RxJS、性能与 SSR、测试、架构与路由、TypeScript 基础以及无障碍等主题组织。每条规则以简短要点呈现,并配有速查对照表和代码示例,例如信号输入输出、新控制流语法以及基于信号的异步资源。它还指引查阅技能目录中的 AGENTS.md 参考文件以获取边界情况与更多示例,并列出 NgRx、SignalStore、TanStack Query、Angular Material、PrimeNG、Spartan UI 和 Transloco 等可选配套技能。
适用场景
适用于处理任何 Angular 17+ 代码的场景,包括组件、服务、模板、样式表、路由、测试或配置,例如 .component.ts、.service.ts、.html、.scss/.css、.spec.ts、.routes.ts 及 store 文件。适用于通过 angular.json、nx.json 或 @angular/core 导入识别的项目。不适用于 AngularJS 1.x、React、Vue 或非 Angular 的 TypeScript 项目。
运行要求
无需脚本或额外工具,仅为指令型技能。它会引用技能目录中的 AGENTS.md 文件以获取更多示例,并提及需另行安装的可选配套库技能。

Modern Angular Best Practices

A comprehensive set of 112 rules covering TypeScript strictness, signal-based reactivity, component architecture, template optimization, RxJS patterns, SSR hydration, bundle optimization, accessibility, routing, forms, testing, and styling — so every component, service, template, and route you build is fast, accessible, tested, and maintainable.

Below are the key patterns organized by what you're working on. For edge cases or when you need specific code examples beyond what's listed here, consult the AGENTS.md reference file in this skill directory.

Components & Signals

Components are the building blocks. Modern Angular uses signals for reactivity, which changes how you write everything from state to templates.

  • Use standalone components with ChangeDetectionStrategy.OnPush
  • Use input(), output(), model() signal functions instead of decorators
  • Use inject() instead of constructor injection
  • Use signal() for local state, computed() for derived state
  • Use linkedSignal() when state should reset when a source changes
  • Use resource() / httpResource() for async data with built-in loading states
  • Use effect() only for side effects — never for state synchronization
  • Use toSignal() to bridge RxJS observables into signal-based templates
  • Use viewChild() / contentChild() signal queries instead of decorators
  • Use the host property instead of @HostBinding / @HostListener

Templates & Styles

Templates and styles work together — accessibility, layout, and performance cross both concerns.

  • Use @if, @for, @switch control flow instead of structural directives
  • Use @defer for heavy below-fold content
  • Always provide track with @for loops
  • Use NgOptimizedImage with priority for above-fold images
  • Use pure pipes instead of method calls in templates
  • Use CdkVirtualScrollViewport for large lists
  • Use [class.active] bindings instead of [ngClass]
  • Define theme values as CSS custom properties
  • Use prefers-reduced-motion to respect motion preferences

Services & RxJS

Services handle data flow, dependency injection, and RxJS patterns. HTTP, caching, and observable lifecycle are interconnected concerns.

  • Unsubscribe via takeUntilDestroyed() or async pipe
  • Place catchError inside switchMap to keep the outer stream alive
  • Use switchMap for latest-only, exhaustMap for ignore-while-busy
  • Use shareReplay({ bufferSize: 1, refCount: true }) for shared streams
  • Use inject() with InjectionToken for configuration
  • Use HTTP interceptors for cross-cutting concerns (auth, retry, logging)
  • Map DTOs at the API boundary — don't leak backend shapes into components

Performance & SSR

Performance rules span components, templates, and infrastructure. SSR affects routing, data fetching, and hydration strategy.

  • Preload critical data with route resolvers to eliminate waterfalls
  • Lazy-load routes and @defer heavy views
  • Tree-shake imports via standalone component imports, not modules
  • Batch DOM reads/writes to avoid layout thrashing
  • Use Map/Set over plain objects/arrays for frequent lookups
  • Use incremental hydration (@defer (hydrate on ...)) for large pages
  • Use provideClientHydration(withEventReplay()) for SSR
  • Set render modes per-route: SSR for SEO, CSR for dashboards

Testing

Testing patterns apply to components, services, and templates together — isolation is important but integration context matters.

  • Use component harnesses over direct DOM queries
  • Create test object factories for consistent test data
  • Test signal state changes and template output, not implementation
  • Mock services with jasmine.createSpyObj or jest.fn()
  • Test accessibility with axe-core or jest-axe

Architecture & Routing

Architecture decisions affect every file type — routing, module boundaries, and dependency injection are structural.

  • One feature per lazy-loaded route
  • Use guards for auth, resolvers for data, canDeactivate for unsaved changes
  • Use preload strategies (QuickLinkStrategy) for likely-next routes
  • Bind route params via input() with withComponentInputBinding()
  • Avoid barrel file re-exports — import directly from source
  • Use environment-based configuration — no hardcoded URLs or API keys

TypeScript Foundations

These apply everywhere — components, services, tests, all .ts files.

  • Use strict type checking with strict: true in tsconfig
  • Avoid any; use unknown when type is uncertain, generics to narrow
  • Use import type for type-only imports
  • Add explicit return types to exported functions
  • Prefer readonly for data that should not be mutated
  • Use discriminated unions for state variants
  • Use the Result pattern for operations that can fail

Accessibility

Accessibility spans templates, styles, and components — it's not just an HTML concern.

  • Use semantic HTML elements first (<nav>, <main>, <button>)
  • Use ARIA roles and aria-live regions for dynamic content
  • Ensure all interactive elements are keyboard-accessible
  • Use cdkTrapFocus for dialogs and overlays
  • Test with screen readers and axe-core

Quick Reference

PatternUseAvoid
Signal inputsinput<T>()@Input()
Signal outputsoutput<T>()@Output()
Two-way bindingmodel<T>()input + output pair
Dependency injectioninject()Constructor injection
Control flow@if, @for, @switch*ngIf, *ngFor
Class binding[class.active][ngClass]
Change detectionOnPushDefault
Derived statecomputed()Getters
View queriesviewChild()@ViewChild()

Key Code Patterns

Signal inputs and outputs (replaces decorators):

typescript
name = input<string>();           // @Input() replacementsave = output<Data>();            // @Output() replacementvalue = model<string>();          // two-way binding

Control flow (replaces structural directives):

html
@if (user()) { <profile [user]="user()" /> }@for (item of items(); track item.id) { <card [item]="item" /> }@defer (on viewport) { <heavy-chart /> }

httpResource and resource (signal-based async):

typescript
users = httpResource<User[]>(() => `/api/users?role=${this.role()}`);data = resource({ request: () => this.id(), loader: ({request}) => fetch(request) });

Optional Library Skills

Install library-specific rules alongside this core skill:

Links

License

MIT

来源与署名

来源:alfredoperez/angular-best-practices位于skills/angular-best-practices提交a499a47

许可证: 无许可证

内容归原作者所有。SourceWeft 从公开仓库中收录这些内容。

举报或申请下架