Implement watch mode#278
Merged
Merged
Conversation
🦋 Changeset detectedLatest commit: 96351ee The changes in this PR will be included in the next version bump. This PR includes changesets to release 1 package
Not sure what this means? Click here to learn what changesets are. Click here if you're a maintainer who wants to add another changeset to this PR |
mizdra
force-pushed
the
implement-watch-mode
branch
4 times, most recently
from
56f6254 to
04e1b6e
Compare
Owner
Author
|
TODO: Add tests for |
mizdra
commented
Nov 3, 2025
| emitAndReportDiagnosticsTimer = setTimeout(() => { | ||
| emitAndReportDiagnosticsTimer = undefined; | ||
| emitAndReportDiagnostics().catch(logger.logError.bind(logger)); | ||
| }, 250); |
Owner
Author
There was a problem hiding this comment.
mizdra
commented
Nov 3, 2025
| * @throws {WriteDtsFileError} | ||
| */ | ||
| async function emitAndReportDiagnostics() { | ||
| logger.clearScreen(); |
Owner
Author
There was a problem hiding this comment.
Some users may not want the console cleared. We may need to add the --preserveWatchOutput option.
mizdra
commented
Nov 3, 2025
| logger.logDiagnostics(diagnostics); | ||
| } | ||
| logger.logMessage( | ||
| `Found ${diagnostics.length} error${diagnostics.length === 1 ? '' : 's'}. Watching for file changes.`, |
Owner
Author
There was a problem hiding this comment.
This is exactly the same format as tsc messages. Users may find it difficult to distinguish whether a message is from tsc or css-modules-kit...
mizdra
force-pushed
the
implement-watch-mode
branch
2 times, most recently
from
352dd22 to
615dc2c
Compare
mizdra
force-pushed
the
implement-watch-mode
branch
from
5a3b590 to
4829df7
Compare
mizdra
force-pushed
the
implement-watch-mode
branch
2 times, most recently
from
31633f2 to
e68d6d3
Compare
mizdra
force-pushed
the
implement-watch-mode
branch
5 times, most recently
from
2fa9c64 to
bbdd340
Compare
mizdra
force-pushed
the
implement-watch-mode
branch
from
9b62100 to
cba7f2e
Compare
mizdra
force-pushed
the
implement-watch-mode
branch
from
cba7f2e to
96351ee
Compare
mizdra
commented
Dec 20, 2025
Comment on lines
+199
to
+226
| // Workaround for https://github.com/nodejs/node/issues/54450 | ||
| if (platform === 'darwin') await sleep(100); | ||
|
|
||
| const loggerSpy = createLoggerSpy(); | ||
| watcher = await runCMKInWatchMode(fakeParsedArgs({ project: iff.rootDir }), loggerSpy); | ||
| // Workaround for https://github.com/nodejs/node/issues/52601 | ||
| if (platform === 'darwin') await sleep(100); | ||
|
|
||
| // Error when adding a file | ||
| vi.spyOn(watcher.project, 'addFile').mockImplementationOnce(() => { | ||
| throw new Error('test error'); | ||
| }); | ||
| await writeFile(iff.join('src/b.module.css'), '.b_1 { color: red; }'); | ||
| await vi.waitFor(() => { | ||
| expect(loggerSpy.logError).toHaveBeenCalledTimes(1); | ||
| }); | ||
|
|
||
| // Error when changing a file | ||
| vi.spyOn(watcher.project, 'updateFile').mockImplementationOnce(() => { | ||
| throw new Error('test error'); | ||
| }); | ||
| await writeFile(iff.join('src/a.module.css'), '.a_1 { color: blue; }'); | ||
| await vi.waitFor(() => { | ||
| expect(loggerSpy.logError).toHaveBeenCalledTimes(2); | ||
| }); | ||
|
|
||
| // Workaround for https://github.com/paulmillr/chokidar/issues/1399 | ||
| await sleep(100); |
Owner
Author
There was a problem hiding this comment.
I never imagined I'd hit three bugs in a single test case. File watching is a abyss :)
ref: nodejs/node#54450, nodejs/node#52601, paulmillr/chokidar#1399
To help others who dare to challenge this abyss, I've left some information behind. Good luck!
Owner
Author
|
I've been working on developing this feature since late August, and it's finally complete 🎉 |
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.
close: #178
2025-12-21.19.26.32.mov
Design Notes:
tsc --watchts.sys.watchDirectory. However, it was unclear whether this API would be provided in ts-go, so it was not adopted.runCMKInWatchModefunction.runCMKInWatchModedelegates most processing toProject.Projectis used by both therunCMKfunction for normal mode and therunCMKInWatchModefunction for watch mode. It implements the common logic for both modes.Project, CSS Module files are parsed and inspected, diagnostics are reported, and .d.ts files are emitted.Projectmaintains internal caches for the parsing, checking, and emitting stages. When notified of file changes byrunCMKInWatchMode, it discards the relevant caches.Project#276