josiadmin/awesome-copilot
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix typos and modernize Angular instructions (#333)

Browse Source 
- Fix missing `contentChildren()` reference
- Push instructions towards more standalone
- Update file naming conventions according to Angular's style guide
This commit is contained in:
Oskar Thornblad 2025-10-20 01:06:33 +02:00 committed by GitHub
parent f4b82c8714
commit c6ec7f0a34
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 4 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
instructions/angular.instructions.md
View File

@ -18,7 +18,7 @@ Instructions for generating high-quality Angular applications with TypeScript, u
### Architecture ### Architecture
- Use standalone components unless modules are explicitly required - Use standalone components unless modules are explicitly required
- Organize code by feature modules or domains for scalability - Organize code by standalone feature modules or domains for scalability
- Implement lazy loading for feature modules to optimize performance - Implement lazy loading for feature modules to optimize performance
- Use Angular's built-in dependency injection system effectively - Use Angular's built-in dependency injection system effectively
- Structure components with a clear separation of concerns (smart vs. presentational components) - Structure components with a clear separation of concerns (smart vs. presentational components)
@ -32,7 +32,7 @@ Instructions for generating high-quality Angular applications with TypeScript, u
### Component Design ### Component Design
- Follow Angular's component lifecycle hooks best practices - Follow Angular's component lifecycle hooks best practices
- When using Angular >= 19, Use `input()` `output()`, `viewChild()`, `viewChildren()`, `contentChild()` and `viewChildren()` functions instead of decorators; otherwise use decorators - When using Angular >= 19, Use `input()` `output()`, `viewChild()`, `viewChildren()`, `contentChild()` and `contentChildren()` functions instead of decorators; otherwise use decorators
- Leverage Angular's change detection strategy (default or `OnPush` for performance) - Leverage Angular's change detection strategy (default or `OnPush` for performance)
- Keep templates clean and logic in component classes or services - Keep templates clean and logic in component classes or services
- Use Angular directives and pipes for reusable functionality - Use Angular directives and pipes for reusable functionality
@ -78,7 +78,7 @@ Instructions for generating high-quality Angular applications with TypeScript, u
- Use Angular's `TestBed` for component testing with mocked dependencies - Use Angular's `TestBed` for component testing with mocked dependencies
- Test signal-based state updates using Angular's testing utilities - Test signal-based state updates using Angular's testing utilities
- Write end-to-end tests with Cypress or Playwright (if specified) - Write end-to-end tests with Cypress or Playwright (if specified)
- Mock HTTP requests using `HttpClientTestingModule` - Mock HTTP requests using `provideHttpClientTesting`
- Ensure high test coverage for critical functionality - Ensure high test coverage for critical functionality
## Implementation Process ## Implementation Process
@ -95,7 +95,7 @@ Instructions for generating high-quality Angular applications with TypeScript, u
11. Optimize performance and bundle size 11. Optimize performance and bundle size
## Additional Guidelines ## Additional Guidelines
- Follow Angular's naming conventions (e.g., `feature.component.ts`, `feature.service.ts`) - Follow the Angular Style Guide for file naming conventions (see https://angular.dev/style-guide), e.g., use `feature.ts` for components and `feature-service.ts` for services. For legacy codebases, maintain consistency with existing pattern.
- Use Angular CLI commands for generating boilerplate code - Use Angular CLI commands for generating boilerplate code
- Document components and services with clear JSDoc comments - Document components and services with clear JSDoc comments
- Ensure accessibility compliance (WCAG 2.1) where applicable - Ensure accessibility compliance (WCAG 2.1) where applicable