LSP-file-watcher-chokidar
Chokidar-based file watcher implementation for LSP
Details
Installs
- Total 10K
- Win 4K
- Mac 3K
- Linux 3K
| Aug 29 | Aug 28 | Aug 27 | Aug 26 | Aug 25 | Aug 24 | Aug 23 | Aug 22 | Aug 21 | Aug 20 | Aug 19 | Aug 18 | Aug 17 | Aug 16 | Aug 15 | Aug 14 | Aug 13 | Aug 12 | Aug 11 | Aug 10 | Aug 9 | Aug 8 | Aug 7 | Aug 6 | Aug 5 | Aug 4 | Aug 3 | Aug 2 | Aug 1 | Jul 31 | Jul 30 | Jul 29 | Jul 28 | Jul 27 | Jul 26 | Jul 25 | Jul 24 | Jul 23 | Jul 22 | Jul 21 | Jul 20 | Jul 19 | Jul 18 | Jul 17 | Jul 16 | Jul 15 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 0 | 3 | 1 | 2 | 3 | 0 | 0 | 0 | 2 | 3 | 1 | 0 | 2 | 1 | 1 | 2 | 2 | 2 | 2 | 4 | 1 | 1 | 0 | 3 | 3 | 1 | 1 | 1 | 5 | 5 | 5 | 0 | 2 | 2 | 5 | 3 | 3 | 2 | 1 | 5 | 2 | 2 | 1 | 3 | 1 | 4 |
| Mac | 0 | 1 | 2 | 3 | 3 | 1 | 0 | 3 | 4 | 1 | 3 | 0 | 4 | 0 | 1 | 1 | 2 | 2 | 2 | 3 | 6 | 1 | 0 | 0 | 2 | 2 | 1 | 2 | 2 | 1 | 0 | 3 | 1 | 1 | 1 | 2 | 0 | 2 | 2 | 3 | 0 | 1 | 3 | 2 | 3 | 2 |
| Linux | 0 | 3 | 4 | 7 | 2 | 2 | 1 | 4 | 3 | 3 | 0 | 1 | 1 | 5 | 3 | 2 | 3 | 3 | 4 | 4 | 1 | 3 | 3 | 2 | 5 | 3 | 2 | 3 | 0 | 2 | 0 | 2 | 4 | 2 | 3 | 0 | 2 | 3 | 0 | 1 | 0 | 1 | 2 | 2 | 3 | 0 |
Readme
- Source
- raw.githubusercontent.com
LSP-file-watcher-chokidar
A non-native file watcher implementation for LSP that enables support for the workspace/didChangeWatchedFiles LSP notification.
Installation
- Install
LSP-file-watcher-chokidarfrom Package Control - Restart Sublime.
Usage
Having this package installed alongside LSP enables the workspace.didChangeWatchedFiles capability and support for the workspace/didChangeWatchedFiles notification. The servers can also dynamically register file watchers.
For LSP-* packages that are within the sublimelsp organization it should be enough to just install this package and file watching should work without any extra configuration.
In other cases, it might “just work” (if the server registers watchers dynamically) or it might require manual configuration using the the file_watcher object on the Client configuration object.
file_watcher object properties:
| Name | Optional | Description |
|---|---|---|
| patterns | No | An array of glob patterns defining which files within the workspace should be watched. The patterns are relative to the workspace root. Example: ["{**/*.js,**/*.ts,**/*.json}"]. See also supported pattern syntax. |
| events | Yes | An array with the type of events to watch. Default: ["create", "change", "delete"] (all supported types). |
| ignores | Yes | An array of glob exclude patterns. By default this includes patterns from Sublime Text's folder_exclude_patterns and file_exclude_patterns settings and additionally the '**/node_modules/**' pattern. When overriding this option the defaults are not included anymore. |
Implementation
Registering a watcher creates a new Node process behind the scenes. The current implementation creates at most one process for any number of registrations (even through different language servers).
The reason that this is implemented as a separate package, and not natively within the LSP package, is that this relies on a separate process that does the file watching and for the built-in implementation we would like to use a native API provided by Sublime Text that it doesn't provide at the moment. See the LSP issue #892 for supporting it natively within the LSP package.