ctrl+shift+p filters: :st2 :st3 :win :osx :linux
Browse

LSP-file-watcher-chokidar

by sublimelsp ST4

Chokidar-based file watcher implementation for LSP

Details

Installs

  • Total 3K
  • Win 838
  • Mac 849
  • Linux 928
Feb 4 Feb 3 Feb 2 Feb 1 Jan 31 Jan 30 Jan 29 Jan 28 Jan 27 Jan 26 Jan 25 Jan 24 Jan 23 Jan 22 Jan 21 Jan 20 Jan 19 Jan 18 Jan 17 Jan 16 Jan 15 Jan 14 Jan 13 Jan 12 Jan 11 Jan 10 Jan 9 Jan 8 Jan 7 Jan 6 Jan 5 Jan 4 Jan 3 Jan 2 Jan 1 Dec 31 Dec 30 Dec 29 Dec 28 Dec 27 Dec 26 Dec 25 Dec 24 Dec 23 Dec 22 Dec 21
Windows 0 4 2 1 4 2 1 6 3 1 2 2 7 5 0 3 5 3 4 5 4 2 7 0 11 1 1 3 0 6 3 4 3 5 2 2 1 1 5 0 3 2 1 2 7 2
Mac 1 3 1 5 1 5 3 3 3 1 3 4 1 3 3 4 3 2 5 6 4 2 2 2 4 3 2 1 4 2 2 3 3 5 15 0 3 1 2 3 3 0 1 2 2 2
Linux 2 4 4 0 3 2 2 0 2 1 3 4 0 1 2 3 2 8 3 6 10 1 2 1 3 7 2 1 4 5 5 4 5 3 3 2 4 3 2 1 1 5 1 4 2 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-chokidar from 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.