@theia/filesystem 1.45.1 → 1.46.0-next.72

package/src/common/filesystem-utils.ts

@@ -1,64 +1,64 @@
-// *****************************************************************************
-// Copyright (C) 2018 Ericsson 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
-// *****************************************************************************
-
-import { FileStat } from '../common/files';
-import URI from '@theia/core/lib/common/uri';
-
-export namespace FileSystemUtils {
-    export const FILE_NAME_SEPARATOR = ' ';
-
-    /**
-     * Generate unique URI for a given parent which does not collide
-     *
-     * @param parent the `FileStat` of the parent
-     * @param targetUri the initial URI
-     * @param isDirectory indicates whether the given targetUri represents a directory
-     * @param suffix an optional string to append to the file name, in case of collision (e.g. `copy`)
-     */
-    export function generateUniqueResourceURI(parent: FileStat, targetUri: URI, isDirectory: boolean, suffix?: string): URI {
-        const children = !parent.children ? [] : parent.children!.map(child => child.resource);
-        let name = targetUri.path.name;
-        let extension = targetUri.path.ext;
-        if (!name) {
-            // special case for dotfiles (e.g. '.foobar'): use the extension as the name
-            name = targetUri.path.ext;
-            extension = '';
-        }
-        // we want the path base for directories with the source path `foo.bar` to be generated as `foo.bar copy` and not `foo copy.bar` as we do for files
-        if (isDirectory) {
-            name = name + extension;
-            extension = '';
-        }
-
-        let base = name + extension;
-        // test if the name already contains the suffix or the suffix + index, so we don't add it again
-        const nameRegex = RegExp(`.*${FileSystemUtils.FILE_NAME_SEPARATOR}${suffix}(${FileSystemUtils.FILE_NAME_SEPARATOR}[0-9]*)?$`);
-        if (suffix && !nameRegex.test(name) && children.some(child => child.path.base === base)) {
-            name = name + FILE_NAME_SEPARATOR + suffix;
-            base = name + extension;
-        }
-        if (suffix && nameRegex.test(name)) {
-            // remove the existing index from the name, so we can generate a new one
-            name = name.replace(RegExp(`${FILE_NAME_SEPARATOR}[0-9]*$`), '');
-        }
-        let index = 0;
-        while (children.some(child => child.path.base === base)) {
-            index = index + 1;
-            base = name + FILE_NAME_SEPARATOR + index + extension;
-        }
-        return parent.resource.resolve(base);
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2018 Ericsson 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
+// *****************************************************************************
+
+import { FileStat } from '../common/files';
+import URI from '@theia/core/lib/common/uri';
+
+export namespace FileSystemUtils {
+    export const FILE_NAME_SEPARATOR = ' ';
+
+    /**
+     * Generate unique URI for a given parent which does not collide
+     *
+     * @param parent the `FileStat` of the parent
+     * @param targetUri the initial URI
+     * @param isDirectory indicates whether the given targetUri represents a directory
+     * @param suffix an optional string to append to the file name, in case of collision (e.g. `copy`)
+     */
+    export function generateUniqueResourceURI(parent: FileStat, targetUri: URI, isDirectory: boolean, suffix?: string): URI {
+        const children = !parent.children ? [] : parent.children!.map(child => child.resource);
+        let name = targetUri.path.name;
+        let extension = targetUri.path.ext;
+        if (!name) {
+            // special case for dotfiles (e.g. '.foobar'): use the extension as the name
+            name = targetUri.path.ext;
+            extension = '';
+        }
+        // we want the path base for directories with the source path `foo.bar` to be generated as `foo.bar copy` and not `foo copy.bar` as we do for files
+        if (isDirectory) {
+            name = name + extension;
+            extension = '';
+        }
+
+        let base = name + extension;
+        // test if the name already contains the suffix or the suffix + index, so we don't add it again
+        const nameRegex = RegExp(`.*${FileSystemUtils.FILE_NAME_SEPARATOR}${suffix}(${FileSystemUtils.FILE_NAME_SEPARATOR}[0-9]*)?$`);
+        if (suffix && !nameRegex.test(name) && children.some(child => child.path.base === base)) {
+            name = name + FILE_NAME_SEPARATOR + suffix;
+            base = name + extension;
+        }
+        if (suffix && nameRegex.test(name)) {
+            // remove the existing index from the name, so we can generate a new one
+            name = name.replace(RegExp(`${FILE_NAME_SEPARATOR}[0-9]*$`), '');
+        }
+        let index = 0;
+        while (children.some(child => child.path.base === base)) {
+            index = index + 1;
+            base = name + FILE_NAME_SEPARATOR + index + extension;
+        }
+        return parent.resource.resolve(base);
+    }
+}

package/src/common/filesystem-watcher-protocol.ts

@@ -1,96 +1,96 @@
-// *****************************************************************************
-// Copyright (C) 2017 TypeFox 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
-// *****************************************************************************
-
-import { RpcServer } from '@theia/core';
-import { FileChangeType } from './files';
-export { FileChangeType };
-
-export const FileSystemWatcherService = Symbol('FileSystemWatcherServer2');
-/**
- * Singleton implementation of the watch server.
- *
- * Since multiple clients all make requests to this service, we need to track those individually via a `clientId`.
- */
-export interface FileSystemWatcherService extends RpcServer<FileSystemWatcherServiceClient> {
-    /**
-     * @param clientId arbitrary id used to identify a client.
-     * @param uri the path to watch.
-     * @param options optional parameters.
-     * @returns promise to a unique `number` handle for this request.
-     */
-    watchFileChanges(clientId: number, uri: string, options?: WatchOptions): Promise<number>;
-    /**
-     * @param watcherId handle mapping to a previous `watchFileChanges` request.
-     */
-    unwatchFileChanges(watcherId: number): Promise<void>;
-}
-
-export interface FileSystemWatcherServiceClient {
-    /** Listen for change events emitted by the watcher. */
-    onDidFilesChanged(event: DidFilesChangedParams): void;
-    /** The watcher can crash in certain conditions. */
-    onError(event: FileSystemWatcherErrorParams): void;
-}
-
-export interface DidFilesChangedParams {
-    /** Clients to route the events to. */
-    clients?: number[];
-    /** FileSystem changes that occurred. */
-    changes: FileChange[];
-}
-
-export interface FileSystemWatcherErrorParams {
-    /** Clients to route the events to. */
-    clients: number[];
-    /** The uri that originated the error. */
-    uri: string;
-}
-
-export const FileSystemWatcherServer = Symbol('FileSystemWatcherServer');
-export interface FileSystemWatcherServer extends RpcServer<FileSystemWatcherClient> {
-    /**
-     * Start file watching for the given param.
-     * Resolve when watching is started.
-     * Return a watcher id.
-     */
-    watchFileChanges(uri: string, options?: WatchOptions): Promise<number>;
-
-    /**
-     * Stop file watching for the given id.
-     * Resolve when watching is stopped.
-     */
-    unwatchFileChanges(watcherId: number): Promise<void>;
-}
-
-export interface FileSystemWatcherClient {
-    /**
-     * Notify when files under watched uris are changed.
-     */
-    onDidFilesChanged(event: DidFilesChangedParams): void;
-
-    /**
-     * Notify when unable to watch files because of Linux handle limit.
-     */
-    onError(): void;
-}
-
-export interface WatchOptions {
-    ignored: string[];
-}
-export interface FileChange {
-    uri: string;
-    type: FileChangeType;
-}
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox 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
+// *****************************************************************************
+
+import { RpcServer } from '@theia/core';
+import { FileChangeType } from './files';
+export { FileChangeType };
+
+export const FileSystemWatcherService = Symbol('FileSystemWatcherServer2');
+/**
+ * Singleton implementation of the watch server.
+ *
+ * Since multiple clients all make requests to this service, we need to track those individually via a `clientId`.
+ */
+export interface FileSystemWatcherService extends RpcServer<FileSystemWatcherServiceClient> {
+    /**
+     * @param clientId arbitrary id used to identify a client.
+     * @param uri the path to watch.
+     * @param options optional parameters.
+     * @returns promise to a unique `number` handle for this request.
+     */
+    watchFileChanges(clientId: number, uri: string, options?: WatchOptions): Promise<number>;
+    /**
+     * @param watcherId handle mapping to a previous `watchFileChanges` request.
+     */
+    unwatchFileChanges(watcherId: number): Promise<void>;
+}
+
+export interface FileSystemWatcherServiceClient {
+    /** Listen for change events emitted by the watcher. */
+    onDidFilesChanged(event: DidFilesChangedParams): void;
+    /** The watcher can crash in certain conditions. */
+    onError(event: FileSystemWatcherErrorParams): void;
+}
+
+export interface DidFilesChangedParams {
+    /** Clients to route the events to. */
+    clients?: number[];
+    /** FileSystem changes that occurred. */
+    changes: FileChange[];
+}
+
+export interface FileSystemWatcherErrorParams {
+    /** Clients to route the events to. */
+    clients: number[];
+    /** The uri that originated the error. */
+    uri: string;
+}
+
+export const FileSystemWatcherServer = Symbol('FileSystemWatcherServer');
+export interface FileSystemWatcherServer extends RpcServer<FileSystemWatcherClient> {
+    /**
+     * Start file watching for the given param.
+     * Resolve when watching is started.
+     * Return a watcher id.
+     */
+    watchFileChanges(uri: string, options?: WatchOptions): Promise<number>;
+
+    /**
+     * Stop file watching for the given id.
+     * Resolve when watching is stopped.
+     */
+    unwatchFileChanges(watcherId: number): Promise<void>;
+}
+
+export interface FileSystemWatcherClient {
+    /**
+     * Notify when files under watched uris are changed.
+     */
+    onDidFilesChanged(event: DidFilesChangedParams): void;
+
+    /**
+     * Notify when unable to watch files because of Linux handle limit.
+     */
+    onError(): void;
+}
+
+export interface WatchOptions {
+    ignored: string[];
+}
+export interface FileChange {
+    uri: string;
+    type: FileChangeType;
+}

package/src/common/filesystem.ts

@@ -1,43 +1,43 @@
-// *****************************************************************************
-// Copyright (C) 2017 TypeFox 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
-// *****************************************************************************
-
-export namespace FileAccess {
-
-    export namespace Constants {
-
-        /**
-         * Flag indicating that the file is visible to the calling process.
-         * This is useful for determining if a file exists, but says nothing about rwx permissions. Default if no mode is specified.
-         */
-        export const F_OK: number = 0;
-
-        /**
-         * Flag indicating that the file can be read by the calling process.
-         */
-        export const R_OK: number = 4;
-
-        /**
-         * Flag indicating that the file can be written by the calling process.
-         */
-        export const W_OK: number = 2;
-
-        /**
-         * Flag indicating that the file can be executed by the calling process.
-         * This has no effect on Windows (will behave like `FileAccess.F_OK`).
-         */
-        export const X_OK: number = 1;
-    }
-}
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox 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
+// *****************************************************************************
+
+export namespace FileAccess {
+
+    export namespace Constants {
+
+        /**
+         * Flag indicating that the file is visible to the calling process.
+         * This is useful for determining if a file exists, but says nothing about rwx permissions. Default if no mode is specified.
+         */
+        export const F_OK: number = 0;
+
+        /**
+         * Flag indicating that the file can be read by the calling process.
+         */
+        export const R_OK: number = 4;
+
+        /**
+         * Flag indicating that the file can be written by the calling process.
+         */
+        export const W_OK: number = 2;
+
+        /**
+         * Flag indicating that the file can be executed by the calling process.
+         * This has no effect on Windows (will behave like `FileAccess.F_OK`).
+         */
+        export const X_OK: number = 1;
+    }
+}

package/src/common/index.ts

@@ -1,18 +1,18 @@
-// *****************************************************************************
-// Copyright (C) 2017 TypeFox 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
-// *****************************************************************************
-
-export * from './filesystem';
-export * from './filesystem-utils';
+// *****************************************************************************
+// Copyright (C) 2017 TypeFox 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
+// *****************************************************************************
+
+export * from './filesystem';
+export * from './filesystem-utils';