@theia/plugin 1.55.0-next.25 → 1.55.0-next.37

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@theia/plugin",
-  "version": "1.55.0-next.25+2be612f8a",
+  "version": "1.55.0-next.37+4e7843ca5",
   "description": "Theia - Plugin API",
   "types": "./src/theia.d.ts",
   "publishConfig": {
@@ -32,5 +32,5 @@
   "nyc": {
     "extends": "../../configs/nyc.json"
   },
-  "gitHead": "2be612f8a7efb90c1183ba47f0897040925b304a"
+  "gitHead": "4e7843ca5ce4625e3b4823b9a87debd805906fba"
 }

package/src/theia.d.ts

@@ -23,6 +23,7 @@
 
 import './theia-extra';
 import './theia.proposed.canonicalUriProvider';
+import './theia.proposed.createFileSystemWatcher';
 import './theia.proposed.customEditorMove';
 import './theia.proposed.debugVisualization';
 import './theia.proposed.diffCommand';

package/src/theia.proposed.createFileSystemWatcher.ts

@@ -0,0 +1,65 @@
+// *****************************************************************************
+// Copyright (C) 2024 STMicroelectronics and others.
+//
+// This program and the accompanying materials are made available under the
+// terms of the Eclipse Public License v. 2.0 which is available at
+// http://www.eclipse.org/legal/epl-2.0.
+//
+// This Source Code may also be made available under the following Secondary
+// Licenses when the conditions for such availability set forth in the Eclipse
+// Public License v. 2.0 are satisfied: GNU General Public License, version 2
+// with the GNU Classpath Exception which is available at
+// https://www.gnu.org/software/classpath/license.html.
+//
+// SPDX-License-Identifier: EPL-2.0 OR GPL-2.0-only WITH Classpath-exception-2.0
+// *****************************************************************************
+/*---------------------------------------------------------------------------------------------
+ *  Copyright (c) Microsoft Corporation. All rights reserved.
+ *  Licensed under the MIT License. See License.txt in the project root for license information.
+ *--------------------------------------------------------------------------------------------*/
+// code copied and modified from https://github.com/microsoft/vscode/blob/release/1.93/src/vscode-dts/vscode.proposed.createFileSystemWatcher.d.ts
+
+declare module '@theia/plugin' {
+
+    export interface FileSystemWatcherOptions {
+
+        /**
+         * Ignore when files have been created.
+         */
+        readonly ignoreCreateEvents?: boolean;
+
+        /**
+         * Ignore when files have been changed.
+         */
+        readonly ignoreChangeEvents?: boolean;
+
+        /**
+         * Ignore when files have been deleted.
+         */
+        readonly ignoreDeleteEvents?: boolean;
+
+        /**
+         * An optional set of glob patterns to exclude from watching.
+         * Glob patterns are always matched relative to the watched folder.
+         */
+        readonly excludes: string[];
+    }
+
+    export namespace workspace {
+
+        /**
+         * A variant of {@link workspace.createFileSystemWatcher} that optionally allows to specify
+         * a set of glob patterns to exclude from watching.
+         *
+         * It provides the following advantages over the other {@link workspace.createFileSystemWatcher}
+         * method:
+         * - the configured excludes from `files.watcherExclude` setting are NOT applied
+         * - requests for recursive file watchers inside the opened workspace are NOT ignored
+         * - the watcher is ONLY notified for events from this request and not from any other watcher
+         *
+         * As such, this method is prefered in cases where you want full control over the watcher behavior
+         * without being impacted by settings or other watchers that are installed.
+         */
+        export function createFileSystemWatcher(pattern: RelativePattern, options?: FileSystemWatcherOptions): FileSystemWatcher;
+    }
+}