-
Notifications
You must be signed in to change notification settings - Fork 160
Add build, test, lint skills + reference them in agents #17092
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.
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
Open
ivanvpetrov
wants to merge
11
commits into
master
Choose a base branch
from
ipetrov/add-skills-build-test-lint
base: master
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+242
−12
Open
Changes from all commits
Commits
Show all changes
11 commits
Select commit
Hold shift + click to select a range
bd77bd5
feat(skills): add skils for run build, test, lint
ivanvpetrov d0fd8d9
feat(skills): add skill reference to agents
ivanvpetrov 507c251
Apply suggestions from code review
ivanvpetrov 23a5a9d
docs(skills): fix inaccuracies in build and testing skill quick-refer…
ivanvpetrov f41ce05
docs(skills): moved skills as internal one
ivanvpetrov 18624c5
Merge branch 'master' into ipetrov/add-skills-build-test-lint
ivanvpetrov 9c4b85a
Merge branch 'master' into ipetrov/add-skills-build-test-lint
georgianastasov 5215e47
docs(agents): refine skill reference
ivanvpetrov 60d5a8a
docs(agents): refine agents and skill guidance
georgianastasov c4c6f32
Merge branch 'master' into ipetrov/add-skills-build-test-lint
georgianastasov 4539be6
fix(skills): address comments fo schematics and perf test instruction…
georgianastasov File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,75 @@ | ||
| --- | ||
| name: igniteui-angular-build | ||
| description: "Quick-reference for building the core Ignite UI for Angular library and related packages. Covers the full production build (`build:lib`), individual partial builds (styles, extras, migrations, schematics, i18n, elements), and the combined build-all command. Use when an agent needs to compile the library, produce a dist output, or verify that code changes compile cleanly. Do NOT use for running tests — use igniteui-angular-testing instead. Do NOT use for linting — use igniteui-angular-linting instead." | ||
| user-invocable: true | ||
| --- | ||
|
|
||
| # Ignite UI for Angular — Build | ||
|
|
||
| Quick-reference card for the core library and related build commands in this repository. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Run `npm install` at the repo root before any build command. | ||
|
|
||
| ## Full Build | ||
|
|
||
| ```bash | ||
| npm run build | ||
| ``` | ||
|
|
||
| Runs all sub-builds in sequence (library, elements, schematics, migrations, i18n, extras). Use this when you need a complete publishable output or before running the full CI pipeline locally. Check `package.json` for the exact sequence. | ||
|
|
||
| ## Library Build (most common) | ||
|
|
||
| ```bash | ||
| npm run build:lib | ||
| ``` | ||
|
|
||
| This is the primary build command. It does two things: | ||
|
|
||
| 1. `ng build igniteui-angular --configuration production` — compiles the library with ng-packagr using Angular Package Format. Uses `ng-package.prod.json` (production config). | ||
| 2. `npm run build:styles` — runs `node scripts/build-styles.mjs` to compile and bundle Sass themes into distributable CSS. | ||
|
|
||
| **Output**: `dist/igniteui-angular/` | ||
|
|
||
| ### When to use `build:lib` | ||
|
|
||
| - After implementing a feature or fix, to verify the code compiles. | ||
| - Before checking that new public symbols are correctly exported. | ||
| - When another project needs to consume a local build of the library. | ||
|
|
||
| ## Partial Builds | ||
|
|
||
| | Command | What it does | | ||
| |---|---| | ||
| | `npm run build:styles` | Compiles Sass themes only (`scripts/build-styles.mjs`). Already included in `build:lib`. | | ||
| | `npm run build:extras` | Builds the extras package and then runs extras migrations. | | ||
| | `npm run build:schematics` | Copies and compiles `ng add` schematics (`projects/igniteui-angular/schematics/`). | | ||
| | `npm run build:migrations` | Copies and compiles `ng update` migration schematics (`projects/igniteui-angular/migrations/`). | | ||
| | `npm run build:i18n` | Compiles the i18n package (`projects/igniteui-angular-i18n/`). | | ||
| | `npm run build:elements` | Builds the Angular Elements package + bundling + style copy. | | ||
| | `npm run build:docs` | Generates TypeDoc + SassDoc documentation. | | ||
|
|
||
| ### When to use partial builds | ||
|
|
||
| - **`build:schematics`** — after editing files under `projects/igniteui-angular/schematics/`. | ||
| - **`build:migrations`** — after editing files under `projects/igniteui-angular/migrations/`. Required before running `test:schematics`. | ||
| - **`build:extras`** — after editing the extras package or when validating the full root `build` flow. | ||
| - **`build:i18n`** — after changing i18n resource strings. | ||
| - **`build:elements`** — when working on the Angular Elements wrapper. | ||
|
|
||
| ## Key Paths | ||
|
|
||
| | Path | Purpose | | ||
| |---|---| | ||
| | `projects/igniteui-angular/` | Library source root | | ||
| | `projects/igniteui-angular/ng-package.prod.json` | Production ng-packagr config | | ||
| | `projects/igniteui-angular/ng-package.json` | Dev ng-packagr config (preserves dest) | | ||
| | `dist/igniteui-angular/` | Build output | | ||
| | `scripts/build-styles.mjs` | Sass theme compilation script | | ||
|
|
||
| ## Related Skills | ||
|
|
||
| - [`igniteui-angular-testing`](../igniteui-angular-testing/SKILL.md) — Running tests | ||
| - [`igniteui-angular-linting`](../igniteui-angular-linting/SKILL.md) — Linting code and styles |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| --- | ||
| name: igniteui-angular-linting | ||
| description: "Quick-reference for linting the core Ignite UI for Angular library. Covers the combined lint command (`lint:lib`), ESLint for TypeScript and templates, and Stylelint for Sass/SCSS styles. Use when an agent needs to run the main linters, fix lint errors, or understand the primary lint configuration. Do NOT use for building — use igniteui-angular-build instead. Do NOT use for running tests — use igniteui-angular-testing instead." | ||
| user-invocable: true | ||
| --- | ||
|
|
||
| # Ignite UI for Angular — Linting | ||
|
|
||
| Quick-reference card for the core lint commands for the main library in this repository. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Run `npm install` at the repo root. | ||
|
|
||
| ## Commands | ||
|
|
||
| | Command | What it runs | | ||
| |---|---| | ||
| | `npm run lint:lib` | ESLint **+** Stylelint (both — use this as the default) | | ||
| | `npm run lint:styles` | Stylelint only (Sass/SCSS files) | | ||
| | `npm run lint` | `ng lint` — ESLint only (TypeScript + templates) | | ||
|
|
||
| ### `lint:lib` (recommended) | ||
|
|
||
| ```bash | ||
| npm run lint:lib | ||
| ``` | ||
|
|
||
| This is the combined command and the one agents should run before considering work complete. It executes: | ||
|
|
||
| 1. `ng lint` — ESLint on TypeScript source and Angular templates, using the config at `projects/igniteui-angular/eslint.config.mjs`. | ||
| 2. `npm run lint:styles` — Stylelint on Sass files under `projects/igniteui-angular/core/src/core/styles`. | ||
|
|
||
| ### Lint Styles Only | ||
|
|
||
| ```bash | ||
| npm run lint:styles | ||
| ``` | ||
|
|
||
| Runs `stylelint "projects/igniteui-angular/core/src/core/styles"`. Use when you only changed SCSS/Sass and want a faster check. | ||
|
|
||
| ## Configuration Files | ||
|
|
||
| | File | Purpose | | ||
| |---|---| | ||
| | `eslint.config.mjs` (repo root) | Root ESLint config | | ||
| | `projects/igniteui-angular/eslint.config.mjs` | Library-specific ESLint config (referenced in `angular.json`) | | ||
| | `.stylelintrc.json` (repo root) | Root Stylelint config used by `npm run lint:styles` | | ||
|
|
||
| ## Agent Rules | ||
|
|
||
| - **Always run `npm run lint:lib` before marking work complete** — this is a requirement from [AGENTS.md](../../../AGENTS.md). | ||
| - Fix all lint errors before committing. Do not disable rules without justification. | ||
| - If a lint rule conflicts with the intended change, investigate whether the rule is correct before suppressing it. | ||
|
|
||
| ## Related Skills | ||
|
|
||
| - [`igniteui-angular-build`](../igniteui-angular-build/SKILL.md) — Building the library | ||
| - [`igniteui-angular-testing`](../igniteui-angular-testing/SKILL.md) — Running tests |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,76 @@ | ||
| --- | ||
| name: igniteui-angular-testing | ||
| description: "Quick-reference for running Ignite UI for Angular test suites. Covers the full test run (`test:lib`), grid-specific suites (grid, tree-grid, hierarchical-grid, pivot-grid), non-grid tests, watch mode, and auxiliary test suites (schematics, styles, i18n). Use when an agent needs to run, select, or understand the test infrastructure. Do NOT use for building — use igniteui-angular-build instead. Do NOT use for linting — use igniteui-angular-linting instead." | ||
| user-invocable: true | ||
| --- | ||
|
|
||
| # Ignite UI for Angular — Testing | ||
|
|
||
| Quick-reference card for the core test commands for the main igniteui-angular library plus schematics, styles, and i18n suites. | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Run `npm install` at the repo root. | ||
| - Schematics tests normally run from source and do not require a build first. Only run `npm run build:schematics` and `npm run build:migrations` when you specifically want to validate the compiled schematics or migrations output. | ||
| - For performance tests: run `npm run build:lib` first, or at minimum `npm run build:styles`, because `test:lib:perf` loads `dist/igniteui-angular/styles/igniteui-angular.css`. | ||
|
|
||
| ## Test Runner | ||
|
|
||
| - **Karma + Jasmine** for all library unit tests. | ||
| - Karma configs live in `projects/igniteui-angular/karma*.conf.js`. | ||
| - Coverage reports are written to `coverage/`. | ||
|
|
||
| ## Choosing the Right Command | ||
|
|
||
| | Scenario | Command | | ||
| |---|---| | ||
| | **All library tests** (slow — runs everything) | `npm run test:lib` | | ||
| | **Flat grid tests** only | `npm run test:lib:grid` | | ||
| | **Tree grid tests** only | `npm run test:lib:tgrid` | | ||
| | **Hierarchical grid tests** only | `npm run test:lib:hgrid` | | ||
| | **Pivot grid tests** only | `npm run test:lib:pgrid` | | ||
| | **All non-grid tests** (components, directives, services) | `npm run test:lib:others` | | ||
| | **Watch mode** (re-runs on file changes, for dev loop) | `npm run test:lib:watch` | | ||
| | **Performance tests** | `npm run test:lib:perf` | | ||
| | **Schematics + migrations** | `npm run test:schematics` | | ||
| | **Sass/style logic** | `npm run test:styles` | | ||
georgianastasov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
| | **i18n resource validation** | `npm run test:i18n` | | ||
ivanvpetrov marked this conversation as resolved.
Show resolved
Hide resolved
|
||
|
|
||
| ### Decision Guide | ||
|
|
||
| 1. **Working on a grid component?** → Use the matching grid command (`test:lib:grid`, `test:lib:tgrid`, `test:lib:hgrid`, or `test:lib:pgrid`). | ||
| 2. **Working on a non-grid component or directive?** → Use `test:lib:others`. | ||
| 3. **Iterating quickly during development?** → Use `test:lib:watch`. | ||
| 4. **Edited a migration or schematic?** → Use `test:schematics`. Build first only if you also need to validate compiled output. | ||
| 5. **Running performance tests?** → Build first (`build:lib` or at least `build:styles`), then use `test:lib:perf`. | ||
| 6. **Changed Sass theme logic?** → Use `test:styles`. | ||
| 7. **Changed i18n resource strings?** → Use `test:i18n`. | ||
| 8. **Final verification before marking work complete?** → Use `test:lib` (full suite). | ||
|
|
||
| ## Karma Configs | ||
|
|
||
| | Config file | Used by | | ||
| |---|---| | ||
| | `karma.conf.js` | `test:lib` (all tests) | | ||
| | `karma.grid.conf.js` | `test:lib:grid` | | ||
| | `karma.tree-grid.conf.js` | `test:lib:tgrid` | | ||
| | `karma.hierarchical-grid.conf.js` | `test:lib:hgrid` | | ||
| | `karma.pivot-grid.conf.js` | `test:lib:pgrid` | | ||
| | `karma.non-grid.conf.js` | `test:lib:others` | | ||
| | `karma.watch.conf.js` | `test:lib:watch` | | ||
| | `karma.test-perf.conf.js` | `test:lib:perf` (performance) | | ||
|
|
||
| All configs are in `projects/igniteui-angular/`. | ||
|
|
||
| ## Key Paths | ||
|
|
||
| | Path | Purpose | | ||
| |---|---| | ||
| | `projects/igniteui-angular/test-utils/` | Shared test helpers and utilities | | ||
| | `projects/igniteui-angular/src/test.ts` | Karma test entry point | | ||
| | `coverage/` | Code coverage output | | ||
|
|
||
| ## Related Skills | ||
|
|
||
| - [`igniteui-angular-build`](../igniteui-angular-build/SKILL.md) — Building the library | ||
| - [`igniteui-angular-linting`](../igniteui-angular-linting/SKILL.md) — Linting code and styles | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.