♻️ Use LSP based file watcher

docs/user/config.adoc

@@ -42,8 +42,7 @@ There's no support for multiple config files or inheriting/overriding config fil
 		"language": "Default",
 		"permissionLevel": 2,
 		"plugins": [],
-		"mcmetaSummaryOverrides": {},
-		"useFilePolling": false
+		"mcmetaSummaryOverrides": {}
 	},
 	"format": {
 		"blockStateBracketSpacing": { "inside": 0 },

package.json

@@ -17,8 +17,8 @@
 		"docs:start": "cd docs && (bundle exec jekyll serve --incremental || true) && cd ..",
 		"fmt": "dprint fmt",
 		"fmt:check": "dprint check",
-		"lint": "eslint --cache --max-warnings=0 packages/*/{src,test}/**/*.{cts,mts,ts}",
-		"lint:fix": "eslint --cache --max-warnings=0 --fix packages/*/{src,test}/**/*.{cts,mts,ts}",
+		"lint": "eslint --cache --max-warnings=0 \"packages/*/{src,test}/**/*.{cts,mts,ts}\"",
+		"lint:fix": "eslint --cache --max-warnings=0 --fix \"packages/*/{src,test}/**/*.{cts,mts,ts}\"",
 		"release": "ts-node scripts/release.ts",
 		"release:dry": "ts-node scripts/release.ts --dry-run",
 		"set-tsconfig-references": "ts-node scripts/set_tsconfig_references",

packages/core/package.json

@@ -16,7 +16,6 @@
   "dependencies": {
     "base64-arraybuffer": "^1.0.2",
     "binary-search": "^1.3.6",
-    "chokidar": "^3.5.2",
     "decompress": "^4.2.1",
     "follow-redirects": "^1.14.8",
     "micromatch": "^4.0.8",

packages/core/src/common/externals/BrowserExternals.ts

@@ -6,13 +6,7 @@ import type {
 	ExternalDownloaderOptions,
 	RemoteUriString,
 } from './downloader.js'
-import type {
-	ExternalEventEmitter,
-	ExternalFileSystem,
-	Externals,
-	FsLocation,
-	FsWatcher,
-} from './index.js'
+import type { ExternalEventEmitter, ExternalFileSystem, Externals, FsLocation } from './index.js'
 
 type Listener = (...args: unknown[]) => unknown
 export class BrowserEventEmitter implements ExternalEventEmitter {
@@ -71,24 +65,6 @@ class BrowserExternalDownloader implements ExternalDownloader {
 	}
 }
 
-class BrowserFsWatcher implements FsWatcher {
-	on(event: string, listener: (...args: any[]) => unknown): this {
-		if (event === 'ready') {
-			listener()
-		}
-		return this
-	}
-
-	once(event: unknown, listener: (...args: any[]) => unknown): this {
-		if (event === 'ready') {
-			listener()
-		}
-		return this
-	}
-
-	async close(): Promise<void> {}
-}
-
 class BrowserFileSystem implements ExternalFileSystem {
 	private static readonly LocalStorageKey = 'spyglassmc-browser-fs'
 	private states: Record<string, { type: 'file'; content: string } | { type: 'directory' }>
@@ -149,9 +125,6 @@ class BrowserFileSystem implements ExternalFileSystem {
 		delete this.states[location]
 		this.saveStates()
 	}
-	watch(_locations: FsLocation[]): FsWatcher {
-		return new BrowserFsWatcher()
-	}
 	async writeFile(
 		location: FsLocation,
 		data: string | Uint8Array,

packages/core/src/common/externals/NodeJsExternals.ts

@@ -1,5 +1,4 @@
 // https://github.com/DefinitelyTyped/DefinitelyTyped/discussions/60592
-import chokidar from 'chokidar'
 import decompress from 'decompress'
 import followRedirects from 'follow-redirects'
 import { Buffer } from 'node:buffer'
@@ -19,7 +18,7 @@ import type {
 	ExternalDownloaderOptions,
 	RemoteUriString,
 } from './downloader.js'
-import type { Externals, FsLocation, FsWatcher } from './index.js'
+import type { Externals, FsLocation } from './index.js'
 
 const { http, https } = followRedirects
 const gunzip = promisify(zlib.gunzip)
@@ -114,14 +113,6 @@ export const NodeJsExternals: Externals = {
 		unlink(location) {
 			return fsp.unlink(toFsPathLike(location))
 		},
-		watch(locations, { usePolling = false } = {}) {
-			return new ChokidarWatcherWrapper(
-				chokidar.watch(locations.map(toPath), {
-					usePolling,
-					disableGlobbing: true,
-				}),
-			)
-		},
 		writeFile(location, data, options) {
 			return fsp.writeFile(toFsPathLike(location), data, options)
 		},
@@ -154,22 +145,3 @@ function toPath(path: FsLocation): string {
 
 const uriToPath = (uri: string | Uri) =>
 	url.fileURLToPath(uri instanceof Uri ? new url.URL(uri.toString()) : uri)
-const uriFromPath = (path: string) => url.pathToFileURL(path).toString()
-
-class ChokidarWatcherWrapper extends EventEmitter implements FsWatcher {
-	readonly #watcher: chokidar.FSWatcher
-
-	constructor(watcher: chokidar.FSWatcher) {
-		super()
-		this.#watcher = watcher
-			.on('ready', () => this.emit('ready'))
-			.on('add', (path) => this.emit('add', uriFromPath(path)))
-			.on('change', (path) => this.emit('change', uriFromPath(path)))
-			.on('unlink', (path) => this.emit('unlink', uriFromPath(path)))
-			.on('error', (e) => this.emit('error', e))
-	}
-
-	close(): Promise<void> {
-		return this.#watcher.close()
-	}
-}

packages/core/src/common/externals/index.ts

@@ -72,7 +72,6 @@ export interface ExternalFileSystem {
 	showFile(path: FsLocation): Promise<void>
 	stat(location: FsLocation): Promise<{ isDirectory(): boolean; isFile(): boolean }>
 	unlink(location: FsLocation): Promise<void>
-	watch(locations: FsLocation[], options: { usePolling?: boolean }): FsWatcher
 	/**
 	 * @param options `mode` - File mode bit mask (e.g. `0o775`).
 	 */
@@ -87,22 +86,3 @@ export interface ExternalFileSystem {
  * A file URI string or a URI object.
  */
 export type FsLocation = string | Uri
-
-export interface FsWatcher {
-	on(eventName: 'ready', listener: () => unknown): this
-	once(eventName: 'ready', listener: () => unknown): this
-
-	on(eventName: 'add', listener: (uri: string) => unknown): this
-	once(eventName: 'add', listener: (uri: string) => unknown): this
-
-	on(eventName: 'change', listener: (uri: string) => unknown): this
-	once(eventName: 'change', listener: (uri: string) => unknown): this
-
-	on(eventName: 'unlink', listener: (uri: string) => unknown): this
-	once(eventName: 'unlink', listener: (uri: string) => unknown): this
-
-	on(eventName: 'error', listener: (error: Error) => unknown): this
-	once(eventName: 'error', listener: (error: Error) => unknown): this
-
-	close(): Promise<void>
-}

packages/core/src/service/Config.ts

@@ -121,16 +121,6 @@ export interface EnvConfig {
 	 * May become corrupt after changing game versions, so this is currently disabled by default.
 	 */
 	enableMcdocCaching: boolean
-	/**
-	 * Makes the file-watcher use polling to watch for file changes.
-	 * Comes at a performance cost for very large datapacks.
-	 *
-	 * On Windows, enabling this can fix file-lock issues when Spyglass is running.
-	 * See: https://github.com/SpyglassMC/Spyglass/issues/1414
-	 *
-	 * **You should only consider enabling this for Windows machines.**
-	 */
-	useFilePolling: boolean
 }
 
 export type LinterSeverity = 'hint' | 'information' | 'warning' | 'error'
@@ -369,7 +359,6 @@ export const VanillaConfig: Config = {
 		plugins: [],
 		mcmetaSummaryOverrides: {},
 		enableMcdocCaching: false,
-		useFilePolling: false,
 	},
 	format: {
 		blockStateBracketSpacing: { inside: 0 },