Add watchOptions to tsconfig and allow supplying them on command line as well #35615

sheetalkamat · 2019-12-10T21:03:52Z

This adds watchOptions as entry parallel to compilerOptions in tsconfig to specify watch specific options. Eg. watchFile strategy etc. It would also allow us to set ignores for watches or some such options in future, or allowing delayed project watches in the server and others.
Currently watchOptions has watchFile strategy to watch files, watchDirectory strategy to watch individual directory on the OS that don't support native recursive watching and fallbackPolling method to poll when fs related watching fails.
This also adds the delayed update to child watches when the recursive directory watches are invoked. It can be disabled by setting synchronousWatchDirectory in watchOptions
Fixes 100% CPU when installing node_modules while a file is open #30208, VSCode and intellisense are broken and unstable #32033, Code Helper high CPU (electron_node tsserver.js) #34401

typescript-bot · 2019-12-10T21:03:55Z

Thanks for the PR! It looks like you've changed the TSServer protocol in some way. Please ensure that any changes here don't break consumers of the current TSServer API. For some extra review, we'll ping @sheetalkamat, @amcasey, @mjbvz, @minestarks for you. Feel free to loop in other consumers/maintainers if necessary

sheetalkamat · 2019-12-10T21:05:04Z

@typescript-bot pack this

typescript-bot · 2019-12-10T21:05:09Z

Heya @sheetalkamat, I've started to run the tarball bundle task on this PR at 11d7f4f. You can monitor the build here. It should now contribute to this PR's status checks.

typescript-bot · 2019-12-10T21:20:42Z

Hey @sheetalkamat, I've packed this into an installable tgz. You can install it for testing by referencing it in your package.json like so:

{
    "devDependencies": {
        "typescript": "https://typescript.visualstudio.com/cf7ac146-d525-443c-b23c-0d58337efebc/_apis/build/builds/57410/artifacts?artifactName=tgz&fileId=C56D34170AE2E201F9C6006F088E430E6DCD20FE710334CDAA4E0AA14B6BCD2A02&fileName=/typescript-3.8.0-insiders.20191210.tgz"
    }
}

and then running npm install.

There is also a playground for this build.

aranhaagency · 2019-12-13T04:10:57Z

Nice work!

andreialecu · 2019-12-31T10:54:41Z

Should this help with #33335 ? If so, are there any aditional steps necessary? I've installed the latest nightly and selected it in VS Code but it doesn't seem to have helped.

Info 0    [12:52:10.97] Starting TS Server
Info 1    [12:52:10.98] Version: 3.8.0-dev.20191231

DanielRosenwasser · 2020-01-07T18:53:28Z

src/testRunner/unittests/tscWatch/consoleClearing.ts

@@ -2,8 +2,8 @@ namespace ts.tscWatch {
    describe("unittests:: tsc-watch:: console clearing", () => {
        const currentDirectoryLog = "Current directory: / CaseSensitiveFileNames: false\n";
        const fileWatcherAddedLog = [
-            "FileWatcher:: Added:: WatchInfo: /f.ts 250 Source file\n",
-            "FileWatcher:: Added:: WatchInfo: /a/lib/lib.d.ts 250 Source file\n"
+            "FileWatcher:: Added:: WatchInfo: /f.ts 250 undefined Source file\n",


What does undefined refer to here?

undefined is watchOptions passed to the file watcher

DanielRosenwasser · 2020-01-07T20:13:21Z

src/compiler/commandLineParser.ts

+            name: "synchronousWatchDirectory",
+            type: "boolean",
+            category: Diagnostics.Advanced_Options,
+            description: Diagnostics.Synchronously_call_callbacks_and_update_the_state_of_directory_watchers_on_platforms_that_don_t_support_recursive_watching_natively,


As a user, is this relevant to me? What do I need to know? It's not clear to me what this option does.

Also, what's the default?

default is false and setting this to true would get you behaviour in 3.7.. This is new flag that when not set, on recursive directory watching doesnt update the watcher status right away but instead sets a timeout to update the watches for recursive structure.. (eg. when say removing or creating node_modules folder, while npm install is going, the recursive watchers aren't updated right away but on timeout so we aren't eg adding watches on directories that will anyways be deleted or recreated..)

Who would you say would use this feature? Here's how I'm describing it.

Disable deferred watching on directories. Deferred watching is useful when lots of file changes might occur at once (e.g. a change in node_modules from running npm install), but you might want to disable it with this flag for some atypical setups.

This is kind of backup flag that can disable this behavior if changes aren't reflected correctly/sooner.

DanielRosenwasser · 2020-01-07T20:51:32Z

src/compiler/commandLineParser.ts

+            description: Diagnostics.Specify_strategy_for_watching_directory_on_platforms_that_don_t_support_recursive_watching_natively_Colon_UseFsEvents_default_FixedPollingInterval_DynamicPriorityPolling,
+        },
+        {
+            name: "fallbackPolling",


Is this polling for files, directories, or both?

Its for both.. Any fallback when filesystem native fails uses this method

sheetalkamat added 7 commits December 10, 2019 11:37

Create different watch options in compiler options

f69e166

Thread through the new watch options

d5aa608

Actually use the options passed through for watch strategy

06d21a3

Support delay on updating child directory watches

d26fd7d

Make watchOptions separate from compilerOptions

909f458

Support passing watch options from command line

985a9b6

Handle displaying of watchOptions

11d7f4f

sheetalkamat requested review from weswigham, orta, sandersn, amcasey, andrewbranch, elibarzilay, rbuckton and RyanCavanaugh December 10, 2019 21:04

RyanCavanaugh approved these changes Dec 11, 2019

View reviewed changes

Merge branch 'master' into watchOptions

600bc04

sheetalkamat merged commit 236012e into master Dec 11, 2019

sheetalkamat deleted the watchOptions branch December 11, 2019 21:26

andreialecu mentioned this pull request Dec 31, 2019

Initializing js/ts language features extremely slow on WSL2 microsoft/vscode#87921

Closed

DanielRosenwasser reviewed Jan 7, 2020

View reviewed changes

This was referenced Jan 24, 2020

tsserver.js/typingsInstaller.js is watching ignored directories (causing CPU load) #36394

Closed

Add a way to exclude file or directory watching #36035

Closed

This was referenced May 21, 2020

False positive error messages after file rename #38684

Closed

Typescript recompile app two times in watch mode with non recursive watching on os like linux #37994

Closed

mntnoe mentioned this pull request Jun 8, 2020

Newly added files not registered as belonging to composite projects #38976

Closed

github-actions bot mentioned this pull request Aug 14, 2022

Remove span tag in title and unnecessary TOC in Ko microsoft/TypeScript-Website-Localizations#164

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add watchOptions to tsconfig and allow supplying them on command line as well #35615

Add watchOptions to tsconfig and allow supplying them on command line as well #35615

sheetalkamat commented Dec 10, 2019 •

edited

Loading

typescript-bot commented Dec 10, 2019

sheetalkamat commented Dec 10, 2019

typescript-bot commented Dec 10, 2019 •

edited

Loading

typescript-bot commented Dec 10, 2019 •

edited

Loading

aranhaagency commented Dec 13, 2019

andreialecu commented Dec 31, 2019

DanielRosenwasser Jan 7, 2020

sheetalkamat Jan 7, 2020

DanielRosenwasser Jan 7, 2020

DanielRosenwasser Jan 7, 2020

sheetalkamat Jan 7, 2020

DanielRosenwasser Jan 7, 2020 •

edited

Loading

sheetalkamat Jan 8, 2020

DanielRosenwasser Jan 7, 2020

sheetalkamat Jan 7, 2020

Add watchOptions to tsconfig and allow supplying them on command line as well #35615

Add watchOptions to tsconfig and allow supplying them on command line as well #35615

Conversation

sheetalkamat commented Dec 10, 2019 • edited Loading

typescript-bot commented Dec 10, 2019

sheetalkamat commented Dec 10, 2019

typescript-bot commented Dec 10, 2019 • edited Loading

typescript-bot commented Dec 10, 2019 • edited Loading

aranhaagency commented Dec 13, 2019

andreialecu commented Dec 31, 2019

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

DanielRosenwasser Jan 7, 2020 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

sheetalkamat commented Dec 10, 2019 •

edited

Loading

typescript-bot commented Dec 10, 2019 •

edited

Loading

typescript-bot commented Dec 10, 2019 •

edited

Loading

DanielRosenwasser Jan 7, 2020 •

edited

Loading