chage(cli): rename completeAndRun to complete and install and update…#1733
chage(cli): rename completeAndRun to complete and install and update…#1733Marina-L-Stoyanova wants to merge 2 commits into
Conversation
|
coverage: 87.877% (+0.09%) from 87.785% — mstoyanova/wizard-steps-update into master |
There was a problem hiding this comment.
Pull request overview
This PR updates the step-by-step (ig wizard) completion flow by removing the “run” step, renaming the internal completion hook from completeAndRun to complete, and printing “Next Steps” guidance after installation to avoid confusion about the user’s shell working directory.
Changes:
- Replace the wizard’s “Complete & Run” action with “Complete and Install packages” and stop invoking
start. - Rename
BasePromptSession.completeAndRun()toBasePromptSession.complete()and update CLI + schematics implementations accordingly. - Add
showNextSteps()output after completion and adjust unit tests to match the new flow.
Reviewed changes
Copilot reviewed 4 out of 4 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| spec/unit/PromptSession-spec.ts | Updates wizard-flow tests to use the new completion action and assert install + “Next Steps” behavior (no start). |
| packages/ng-schematics/src/prompt/SchematicsPromptSession.ts | Renames the completion hook to complete() to match the core prompt base API. |
| packages/core/prompt/BasePromptSession.ts | Introduces _newProjectName, renames completion API, updates action choice strings, and adds showNextSteps() after completion. |
| packages/cli/lib/PromptSession.ts | Implements complete() to install and flush packages without starting the app. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
| private showNextSteps() { | ||
| Util.log(""); | ||
| Util.log("Next Steps:"); | ||
| if (this._newProjectName) { | ||
| Util.log(` cd ${this._newProjectName}`); | ||
| } | ||
| Util.log(" ig add start guided mode for adding views to the app"); | ||
| Util.log(" ig start starts a web server and opens the app in the default browser"); | ||
| } |
| } | ||
|
|
||
| protected completeAndRun(_port?: number) { | ||
| protected async complete() { |
There was a problem hiding this comment.
Maybe we should get rid of this no-op method. It seems it's a dead end for 7 years now
There was a problem hiding this comment.
Removing it would cause a TypeScript compile error. The empty body is the intentional no-op implementation for the schematics context.
|
There are still traces of 'Complete & Run' in several E.g.
|
…rify no-op in complete method
Marina-L-Stoyanova
added
💥 status: in-test
and removed
🛠️ status: in-development
labels
… related logic
Description
Removing the Run step from the Step-by-step guide and updating withe Next steps.
Related Issue
Closes #1728
Type of Change
Affected Packages
igniteui-cli(packages/cli)@igniteui/cli-core(packages/core)@igniteui/angular-templates(packages/igx-templates)@igniteui/angular-schematics(packages/ng-schematics)@igniteui/mcp-server(packages/igniteui-mcp)Checklist
npm run test)npm run build)npm run lint)Additional Context