Skip to content

feat: update docs with exclude patterns #26

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
Karnaukhov-kh merged 1 commit into from
Mar 17, 2026
Merged

feat: update docs with exclude patterns #26

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions docs/ds-refactoring-flow.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -65,7 +65,7 @@ This rule follows a two-step process to find violations:
### Tools used

- `report-violations` - Main MCP tool that analyzes deprecated design system CSS usage
- Parameters: `componentName`, `directory`, `groupBy` (folder/file)
- Parameters: `componentName`, `directory`, `groupBy` (folder/file), `excludePatterns` (optional glob pattern(s) to exclude files/directories)
- Returns violation data with counts and locations
- Supports both folder-level and file-level grouping

Expand Down Expand Up @@ -122,7 +122,7 @@ This rule follows a comprehensive two-step process to find all violations:
### Tools used

- `report-all-violations` - Comprehensive MCP tool that analyzes all deprecated design system CSS usage across the codebase
- Parameters: `directory`, `groupBy` (folder/file)
- Parameters: `directory`, `groupBy` (folder/file), `excludePatterns` (optional glob pattern(s) to exclude files/directories)
- Returns: Complete violation data with counts and locations across all components
- Supports both folder-level overview and file-level detailed analysis

Expand Down Expand Up @@ -386,7 +386,7 @@ The rule implements a systematic three-phase process for handling non-migratable
- Used for: Discovery phase and validation of CSS count consistency

- `report-violations` - Analyzes deprecated component usage in templates and code
- Parameters: `directory`, `componentName`
- Parameters: `directory`, `componentName`, `excludePatterns` (optional)
- Returns: List of component violations with file locations
- Used for: Validation of violation reduction after implementation

Expand Down Expand Up @@ -715,7 +715,7 @@ This rule follows a three-step analysis process:
- Scans: .scss, .sass, .less, .css files for deprecated class selectors

- `report-violations` - Analyzes deprecated component usage in templates and code
- Parameters: `directory`, `componentName`
- Parameters: `directory`, `componentName`, `excludePatterns` (optional)
- Returns: List of component violations with file locations and line numbers
- Scans: .html, .ts files for deprecated component usage in templates and inline templates

Expand Down
2 changes: 2 additions & 0 deletions docs/tools.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ This document provides comprehensive guidance for AI agents working with Angular
- `directory`: Target analysis directory (use relative paths like `./src/app`)
- `componentName`: Component class name (e.g., `DsButton`)
- `groupBy`: `"file"` or `"folder"` for result organization
- `excludePatterns`: Optional glob pattern(s) to exclude files/directories from scanning. Supports standard glob syntax (`*`, `**`, `?`). Can be a single string or array of strings (e.g., `"node_modules/**"`, `["**/dist/**", "**/*.spec.ts"]`)
- `saveAsFile`: Optional boolean - if `true`, saves report to `tmp/.angular-toolkit-mcp/violations-report/<componentName>/<directory>-violations.json`
**Output**:
- Default: Structured violation reports grouped by file or folder
Expand All @@ -25,6 +26,7 @@ This document provides comprehensive guidance for AI agents working with Angular
**Key Parameters**:
- `directory`: Target analysis directory (use relative paths like `./src/app`)
- `groupBy`: `"component"` or `"file"` for result organization (default: `"component"`)
- `excludePatterns`: Optional glob pattern(s) to exclude files/directories from scanning. Supports standard glob syntax (`*`, `**`, `?`). Can be a single string or array of strings (e.g., `"node_modules/**"`, `["**/dist/**", "**/*.spec.ts"]`)
- `saveAsFile`: Optional boolean - if `true`, saves report to `tmp/.angular-toolkit-mcp/violations-report/<directory>-violations.json`
**Output**:
- Default: Structured violation reports grouped by component or file covering all components
Expand Down
Loading