LSP-file-watcher-chokidar
Chokidar-based file watcher implementation for LSP
Details
Installs
- Total 8K
- Win 3K
- Mac 2K
- Linux 3K
| Nov 21 | Nov 20 | Nov 19 | Nov 18 | Nov 17 | Nov 16 | Nov 15 | Nov 14 | Nov 13 | Nov 12 | Nov 11 | Nov 10 | Nov 9 | Nov 8 | Nov 7 | Nov 6 | Nov 5 | Nov 4 | Nov 3 | Nov 2 | Nov 1 | Oct 31 | Oct 30 | Oct 29 | Oct 28 | Oct 27 | Oct 26 | Oct 25 | Oct 24 | Oct 23 | Oct 22 | Oct 21 | Oct 20 | Oct 19 | Oct 18 | Oct 17 | Oct 16 | Oct 15 | Oct 14 | Oct 13 | Oct 12 | Oct 11 | Oct 10 | Oct 9 | Oct 8 | Oct 7 | |
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| Windows | 1 | 1 | 1 | 3 | 2 | 1 | 2 | 0 | 0 | 1 | 6 | 3 | 4 | 3 | 3 | 1 | 2 | 1 | 3 | 3 | 4 | 5 | 5 | 6 | 2 | 1 | 2 | 5 | 4 | 9 | 5 | 2 | 4 | 4 | 0 | 6 | 6 | 3 | 4 | 6 | 4 | 4 | 3 | 4 | 6 | 2 |
| Mac | 1 | 3 | 0 | 1 | 4 | 2 | 5 | 0 | 0 | 0 | 6 | 2 | 3 | 4 | 2 | 4 | 2 | 4 | 2 | 2 | 4 | 3 | 0 | 2 | 2 | 1 | 1 | 2 | 1 | 2 | 1 | 4 | 2 | 1 | 4 | 1 | 1 | 2 | 1 | 3 | 2 | 2 | 2 | 1 | 6 | 3 |
| Linux | 1 | 1 | 1 | 0 | 2 | 1 | 1 | 0 | 0 | 2 | 6 | 12 | 2 | 3 | 2 | 2 | 1 | 5 | 5 | 0 | 3 | 1 | 0 | 3 | 3 | 4 | 3 | 2 | 2 | 5 | 1 | 5 | 3 | 1 | 2 | 2 | 3 | 6 | 7 | 8 | 2 | 2 | 2 | 3 | 3 | 2 |
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.