feat(yeoman-ui): implement generator progress notifications - #576
Open
korotkovao wants to merge 25 commits into
Open
feat(yeoman-ui): implement generator progress notifications#576korotkovao wants to merge 25 commits into
korotkovao wants to merge 25 commits into
Conversation
- Add doGeneratorProgress method to YouiEvents interface to track
generator lifecycle phases (writing, install, end)
- Implement progress notification in VSCodeYouiEvents with project
name in title 'Generating {projectName}'
- Update progress messages through three phases: 'Creating project
files...', 'Installing dependencies...', 'Finalising...'
- Add artificial delays to ensure UI visibility: 2s for writing
phase, 1s for finalising phase
- Make doGeneratorDone async (returns Promise<void>) to properly
handle 1s delay before closing notification
- Add event listeners in YeomanUI.onGenInstall for method:writing,
method:install, and method:end events
- Extract project name from multiple generator state locations
(state.project.name, options.projectName, etc.)
- Include project name in success message:
'Project {projectName} has been generated.'
- Add void operators for all doGeneratorDone and doGeneratorProgress
calls to satisfy lint requirements
- Use UK English spelling ('Finalising' not 'Finalizing')
- Show continuous indeterminate spinner (no progress bar increments)
Fixes #38263
- Add .js extensions to relative imports in vscode-youi-events.spec.ts - Required for ESM module resolution (moduleResolution: node16) - Fixes CI build errors: TS2835 relative import paths need explicit file extensions
- Add .js extension to @sap-devx/webview-rpc import path - Required for ESM module resolution with external packages
- Remove console.log statements from onGenInstall method - These were used during development for debugging
- Add test for doGeneratorInstall with project name parameter - Add 5 new tests for doGeneratorDone with project name in messages - Test all workspace scenarios: add to workspace, open in new workspace, save for future use - Test different artifact types: project, module, files - Verify project name appears correctly in success messages - Improves coverage for getSuccessInfoMessage method
- Remove loggerWrapperMock declaration, setup, and verification - Remove unused loggerWrapper import - Fixes 'Cannot redefine property: getClassLogger' test error - This mock was causing beforeEach to fail when run multiple times
- Add loggerWrapper.internalApi.setLogger(testLogger) in before() hook - Add loggerWrapper.internalApi.resetLogger() in after() hook - Restore loggerWrapper import - Fixes 'Logger has not yet been initialized!' error in tests
- Change from 'import * as _ from "lodash"' to 'import lodash from "lodash"' - Update all _.set() calls to lodash.set() - Fixes 'TypeError: _.set is not a function' in tests
- Replace fsMock.expects() with sandbox.stub(fs) to avoid mock conflicts - Remove incorrect module/files type tests (those don't use project names) - Keep focused tests for three project scenarios with project name - Fixes 'Cannot redefine property: existsSync' error
- Replace all 4 remaining fsMock.expects() calls with sandbox.stub(fs) - Fixes 'Cannot redefine property: existsSync' in pre-existing tests - Stubs can be replaced between tests, mocks cannot
- Use createRequire() to import fs as CJS for proper mocking with Sinon - Move sandbox creation from before() to beforeEach() for proper cleanup - Add sandbox.restore() in afterEach() to clean up mocks between tests - Remove fs mock expectations that can't work due to ES module imports in WorkspaceFile - Make doGeneratorDone properly await showDoneMessage to fix async timing - Fixes 'Cannot redefine property: existsSync' and 'ES Modules cannot be stubbed' errors - Coverage improved: vscode-youi-events.ts 79.06% → 94.41%, overall 88.93% → 91.56%
- Add test for showDoneMessage with skipResolve=false - Add test for getSuccessInfoMessage with empty type - Coverage improved: vscode-youi-events.ts 94.41% → 95.34% - Overall coverage: 91.56% → 91.71% (0.29% short of 92% threshold)
Add fs.writeFileSync stubs to tests that create workspace files via WorkspaceFile.createWsWithPath. This prevents filesystem errors in CI where ~/projects directory doesn't exist. Fixes 3 failing tests in CI that were causing coverage to drop to 89.42%.
…rrors Instead of stubbing fs.writeFileSync (which doesn't work for ESM imports), stub WorkspaceFile.createWsWithPath and createWsWithUri directly. This prevents filesystem writes in CI where /home/runner/projects/ doesn't exist.
korotkovao
force-pushed
the
feat/yeoman-ui/generator-progress-notification
branch
from
July 30, 2026 11:30
7981be9 to
c5206df
Compare
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Summary
Implements improved generator progress notifications per internal issue 38263.
Key improvements:
Technical details:
doGeneratorProgressmethod to track generator lifecycle eventsmethod:writing,method:install,method:enddoGeneratorDonereturn type fromvoidtoThenable<any>to properly return the result ofshowDoneMessageWorkspaceFile.createWsWithPathandcreateWsWithUriin tests to prevent filesystem writes in CITest coverage: