@theia/workspace 1.34.2 → 1.34.3

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (105) hide show
  1. package/LICENSE +641 -641
  2. package/README.md +30 -30
  3. package/lib/browser/diff-service.d.ts +10 -10
  4. package/lib/browser/diff-service.js +85 -85
  5. package/lib/browser/index.d.ts +6 -6
  6. package/lib/browser/index.js +33 -33
  7. package/lib/browser/quick-open-workspace.d.ts +25 -25
  8. package/lib/browser/quick-open-workspace.js +137 -137
  9. package/lib/browser/untitled-workspace-exit-dialog.d.ts +19 -19
  10. package/lib/browser/untitled-workspace-exit-dialog.js +74 -74
  11. package/lib/browser/workspace-breadcrumbs-contribution.d.ts +10 -10
  12. package/lib/browser/workspace-breadcrumbs-contribution.js +66 -66
  13. package/lib/browser/workspace-commands.d.ts +117 -117
  14. package/lib/browser/workspace-commands.js +593 -593
  15. package/lib/browser/workspace-commands.spec.d.ts +1 -1
  16. package/lib/browser/workspace-commands.spec.js +127 -127
  17. package/lib/browser/workspace-compare-handler.d.ts +26 -26
  18. package/lib/browser/workspace-compare-handler.js +66 -66
  19. package/lib/browser/workspace-delete-handler.d.ts +75 -75
  20. package/lib/browser/workspace-delete-handler.js +214 -214
  21. package/lib/browser/workspace-duplicate-handler.d.ts +30 -30
  22. package/lib/browser/workspace-duplicate-handler.js +86 -86
  23. package/lib/browser/workspace-frontend-contribution.d.ts +135 -135
  24. package/lib/browser/workspace-frontend-contribution.js +568 -568
  25. package/lib/browser/workspace-frontend-contribution.spec.d.ts +1 -1
  26. package/lib/browser/workspace-frontend-contribution.spec.js +53 -53
  27. package/lib/browser/workspace-frontend-module.d.ts +3 -3
  28. package/lib/browser/workspace-frontend-module.js +88 -88
  29. package/lib/browser/workspace-input-dialog.d.ts +19 -19
  30. package/lib/browser/workspace-input-dialog.js +73 -73
  31. package/lib/browser/workspace-preferences.d.ts +11 -11
  32. package/lib/browser/workspace-preferences.js +46 -46
  33. package/lib/browser/workspace-schema-updater.d.ts +32 -32
  34. package/lib/browser/workspace-schema-updater.js +148 -148
  35. package/lib/browser/workspace-service.d.ts +182 -182
  36. package/lib/browser/workspace-service.js +729 -729
  37. package/lib/browser/workspace-storage-service.d.ts +15 -15
  38. package/lib/browser/workspace-storage-service.js +80 -80
  39. package/lib/browser/workspace-trust-preferences.d.ts +21 -21
  40. package/lib/browser/workspace-trust-preferences.js +65 -65
  41. package/lib/browser/workspace-trust-service.d.ts +26 -26
  42. package/lib/browser/workspace-trust-service.js +149 -149
  43. package/lib/browser/workspace-uri-contribution.d.ts +20 -20
  44. package/lib/browser/workspace-uri-contribution.js +113 -113
  45. package/lib/browser/workspace-uri-contribution.spec.d.ts +1 -1
  46. package/lib/browser/workspace-uri-contribution.spec.js +169 -169
  47. package/lib/browser/workspace-user-working-directory-provider.d.ts +12 -12
  48. package/lib/browser/workspace-user-working-directory-provider.js +62 -62
  49. package/lib/browser/workspace-utils.d.ts +15 -15
  50. package/lib/browser/workspace-utils.js +54 -54
  51. package/lib/browser/workspace-variable-contribution.d.ts +23 -23
  52. package/lib/browser/workspace-variable-contribution.js +237 -237
  53. package/lib/browser/workspace-window-title-updater.d.ts +7 -7
  54. package/lib/browser/workspace-window-title-updater.js +57 -57
  55. package/lib/common/index.d.ts +2 -2
  56. package/lib/common/index.js +29 -29
  57. package/lib/common/test/mock-workspace-server.d.ts +7 -7
  58. package/lib/common/test/mock-workspace-server.js +35 -35
  59. package/lib/common/utils.d.ts +21 -21
  60. package/lib/common/utils.js +73 -73
  61. package/lib/common/workspace-protocol.d.ts +26 -26
  62. package/lib/common/workspace-protocol.js +23 -23
  63. package/lib/node/default-workspace-server.d.ts +64 -64
  64. package/lib/node/default-workspace-server.js +248 -248
  65. package/lib/node/default-workspace-server.spec.d.ts +1 -1
  66. package/lib/node/default-workspace-server.spec.js +84 -84
  67. package/lib/node/index.d.ts +2 -2
  68. package/lib/node/index.js +29 -29
  69. package/lib/node/workspace-backend-module.d.ts +3 -3
  70. package/lib/node/workspace-backend-module.js +32 -32
  71. package/package.json +6 -6
  72. package/src/browser/diff-service.ts +62 -62
  73. package/src/browser/index.ts +22 -22
  74. package/src/browser/quick-open-workspace.ts +112 -112
  75. package/src/browser/untitled-workspace-exit-dialog.ts +70 -70
  76. package/src/browser/workspace-breadcrumbs-contribution.ts +56 -56
  77. package/src/browser/workspace-commands.spec.ts +153 -153
  78. package/src/browser/workspace-commands.ts +586 -586
  79. package/src/browser/workspace-compare-handler.ts +56 -56
  80. package/src/browser/workspace-delete-handler.ts +212 -212
  81. package/src/browser/workspace-duplicate-handler.ts +75 -75
  82. package/src/browser/workspace-frontend-contribution.spec.ts +63 -63
  83. package/src/browser/workspace-frontend-contribution.ts +558 -558
  84. package/src/browser/workspace-frontend-module.ts +115 -115
  85. package/src/browser/workspace-input-dialog.ts +60 -60
  86. package/src/browser/workspace-preferences.ts +58 -58
  87. package/src/browser/workspace-schema-updater.ts +148 -148
  88. package/src/browser/workspace-service.ts +772 -772
  89. package/src/browser/workspace-storage-service.ts +67 -67
  90. package/src/browser/workspace-trust-preferences.ts +76 -76
  91. package/src/browser/workspace-trust-service.ts +143 -143
  92. package/src/browser/workspace-uri-contribution.spec.ts +191 -191
  93. package/src/browser/workspace-uri-contribution.ts +97 -97
  94. package/src/browser/workspace-user-working-directory-provider.ts +48 -48
  95. package/src/browser/workspace-utils.ts +45 -45
  96. package/src/browser/workspace-variable-contribution.ts +222 -222
  97. package/src/browser/workspace-window-title-updater.ts +45 -45
  98. package/src/common/index.ts +18 -18
  99. package/src/common/test/mock-workspace-server.ts +29 -29
  100. package/src/common/utils.ts +69 -69
  101. package/src/common/workspace-protocol.ts +47 -47
  102. package/src/node/default-workspace-server.spec.ts +99 -99
  103. package/src/node/default-workspace-server.ts +242 -242
  104. package/src/node/index.ts +18 -18
  105. package/src/node/workspace-backend-module.ts +37 -37
@@ -1,242 +1,242 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import * as path from 'path';
18
- import * as yargs from '@theia/core/shared/yargs';
19
- import * as fs from '@theia/core/shared/fs-extra';
20
- import * as jsoncparser from 'jsonc-parser';
21
- import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
22
- import { FileUri, BackendApplicationContribution } from '@theia/core/lib/node';
23
- import { CliContribution } from '@theia/core/lib/node/cli';
24
- import { Deferred } from '@theia/core/lib/common/promise-util';
25
- import { WorkspaceServer, CommonWorkspaceUtils } from '../common';
26
- import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
27
- import URI from '@theia/core/lib/common/uri';
28
-
29
- @injectable()
30
- export class WorkspaceCliContribution implements CliContribution {
31
-
32
- @inject(EnvVariablesServer) protected readonly envVariablesServer: EnvVariablesServer;
33
- @inject(CommonWorkspaceUtils) protected readonly workspaceUtils: CommonWorkspaceUtils;
34
-
35
- workspaceRoot = new Deferred<string | undefined>();
36
-
37
- configure(conf: yargs.Argv): void {
38
- conf.usage('$0 [workspace-directories] [options]');
39
- conf.option('root-dir', {
40
- description: 'DEPRECATED: Sets the workspace directory.',
41
- });
42
- }
43
-
44
- async setArguments(args: yargs.Arguments): Promise<void> {
45
- const workspaceArguments = args._.slice(2).map(probablyAlreadyString => String(probablyAlreadyString));
46
- if (workspaceArguments.length === 0 && args['root-dir']) {
47
- workspaceArguments.push(String(args['root-dir']));
48
- }
49
- if (workspaceArguments.length === 0) {
50
- this.workspaceRoot.resolve(undefined);
51
- } else if (workspaceArguments.length === 1) {
52
- this.workspaceRoot.resolve(this.normalizeWorkspaceArg(workspaceArguments[0]));
53
- } else {
54
- this.workspaceRoot.resolve(this.buildWorkspaceForMultipleArguments(workspaceArguments));
55
- }
56
- }
57
-
58
- protected normalizeWorkspaceArg(raw: string): string {
59
- return path.resolve(raw).replace(/\/$/, '');
60
- }
61
-
62
- protected async buildWorkspaceForMultipleArguments(workspaceArguments: string[]): Promise<string | undefined> {
63
- try {
64
- const dirs = await Promise.all(workspaceArguments.map(async maybeDir => (await fs.stat(maybeDir).catch(() => undefined))?.isDirectory()));
65
- const folders = workspaceArguments.filter((_, index) => dirs[index]).map(dir => ({ path: this.normalizeWorkspaceArg(dir) }));
66
- if (folders.length < 2) {
67
- return folders[0]?.path;
68
- }
69
- const untitledWorkspaceUri = await this.workspaceUtils.getUntitledWorkspaceUri(
70
- new URI(await this.envVariablesServer.getConfigDirUri()),
71
- async uri => !await fs.pathExists(uri.path.fsPath()),
72
- );
73
- const untitledWorkspacePath = untitledWorkspaceUri.path.fsPath();
74
-
75
- await fs.ensureDir(path.dirname(untitledWorkspacePath));
76
- await fs.writeFile(untitledWorkspacePath, JSON.stringify({ folders }, undefined, 4));
77
- return untitledWorkspacePath;
78
- } catch {
79
- return undefined;
80
- }
81
- }
82
- }
83
-
84
- @injectable()
85
- export class DefaultWorkspaceServer implements WorkspaceServer, BackendApplicationContribution {
86
-
87
- protected root: Deferred<string | undefined> = new Deferred();
88
- /**
89
- * Untitled workspaces that are not among the most recent N workspaces will be deleted on start. Increase this number to keep older files,
90
- * lower it to delete stale untitled workspaces more aggressively.
91
- */
92
- protected untitledWorkspaceStaleThreshold = 10;
93
-
94
- @inject(WorkspaceCliContribution)
95
- protected readonly cliParams: WorkspaceCliContribution;
96
-
97
- @inject(EnvVariablesServer)
98
- protected readonly envServer: EnvVariablesServer;
99
-
100
- @inject(CommonWorkspaceUtils)
101
- protected readonly utils: CommonWorkspaceUtils;
102
-
103
- @postConstruct()
104
- protected async init(): Promise<void> {
105
- const root = await this.getRoot();
106
- this.root.resolve(root);
107
- }
108
-
109
- async onStart(): Promise<void> {
110
- await this.removeOldUntitledWorkspaces();
111
- }
112
-
113
- protected async getRoot(): Promise<string | undefined> {
114
- let root = await this.getWorkspaceURIFromCli();
115
- if (!root) {
116
- const data = await this.readRecentWorkspacePathsFromUserHome();
117
- if (data && data.recentRoots) {
118
- root = data.recentRoots[0];
119
- }
120
- }
121
- return root;
122
- }
123
-
124
- getMostRecentlyUsedWorkspace(): Promise<string | undefined> {
125
- return this.root.promise;
126
- }
127
-
128
- async setMostRecentlyUsedWorkspace(rawUri: string): Promise<void> {
129
- const uri = rawUri && new URI(rawUri).toString(); // the empty string is used as a signal from the frontend not to load a workspace.
130
- this.root = new Deferred();
131
- this.root.resolve(uri);
132
- const recentRoots = Array.from(new Set([uri, ...await this.getRecentWorkspaces()]));
133
- this.writeToUserHome({ recentRoots });
134
- }
135
-
136
- async removeRecentWorkspace(rawUri: string): Promise<void> {
137
- const uri = rawUri && new URI(rawUri).toString(); // the empty string is used as a signal from the frontend not to load a workspace.
138
- const recentRoots = await this.getRecentWorkspaces();
139
- const index = recentRoots.indexOf(uri);
140
- if (index !== -1) {
141
- recentRoots.splice(index, 1);
142
- this.writeToUserHome({
143
- recentRoots
144
- });
145
- }
146
- }
147
-
148
- async getRecentWorkspaces(): Promise<string[]> {
149
- const listUri: string[] = [];
150
- const data = await this.readRecentWorkspacePathsFromUserHome();
151
- if (data && data.recentRoots) {
152
- data.recentRoots.forEach(element => {
153
- if (element.length > 0) {
154
- if (this.workspaceStillExist(element)) {
155
- listUri.push(element);
156
- }
157
- }
158
- });
159
- }
160
- return listUri;
161
- }
162
-
163
- protected workspaceStillExist(workspaceRootUri: string): boolean {
164
- return fs.pathExistsSync(FileUri.fsPath(workspaceRootUri));
165
- }
166
-
167
- protected async getWorkspaceURIFromCli(): Promise<string | undefined> {
168
- const arg = await this.cliParams.workspaceRoot.promise;
169
- return arg !== undefined ? FileUri.create(arg).toString() : undefined;
170
- }
171
-
172
- /**
173
- * Writes the given uri as the most recently used workspace root to the user's home directory.
174
- * @param uri most recently used uri
175
- */
176
- protected async writeToUserHome(data: RecentWorkspacePathsData): Promise<void> {
177
- const file = await this.getUserStoragePath();
178
- await this.writeToFile(file, data);
179
- }
180
-
181
- protected async writeToFile(fsPath: string, data: object): Promise<void> {
182
- if (!await fs.pathExists(fsPath)) {
183
- await fs.mkdirs(path.resolve(fsPath, '..'));
184
- }
185
- await fs.writeJson(fsPath, data);
186
- }
187
-
188
- /**
189
- * Reads the most recently used workspace root from the user's home directory.
190
- */
191
- protected async readRecentWorkspacePathsFromUserHome(): Promise<RecentWorkspacePathsData | undefined> {
192
- const fsPath = await this.getUserStoragePath();
193
- const data = await this.readJsonFromFile(fsPath);
194
- return RecentWorkspacePathsData.create(data);
195
- }
196
-
197
- protected async readJsonFromFile(fsPath: string): Promise<object | undefined> {
198
- if (await fs.pathExists(fsPath)) {
199
- const rawContent = await fs.readFile(fsPath, 'utf-8');
200
- const strippedContent = jsoncparser.stripComments(rawContent);
201
- return jsoncparser.parse(strippedContent);
202
- }
203
- }
204
-
205
- protected async getUserStoragePath(): Promise<string> {
206
- const configDirUri = await this.envServer.getConfigDirUri();
207
- return path.resolve(FileUri.fsPath(configDirUri), 'recentworkspace.json');
208
- }
209
-
210
- /**
211
- * Removes untitled workspaces that are not among the most recently used workspaces.
212
- * Use the `untitledWorkspaceStaleThreshold` to configure when to delete workspaces.
213
- */
214
- protected async removeOldUntitledWorkspaces(): Promise<void> {
215
- const recents = (await this.getRecentWorkspaces()).map(FileUri.fsPath);
216
- const olderUntitledWorkspaces = recents.slice(this.untitledWorkspaceStaleThreshold).filter(workspace => this.utils.isUntitledWorkspace(FileUri.create(workspace)));
217
- await Promise.all(olderUntitledWorkspaces.map(workspace => fs.promises.unlink(FileUri.fsPath(workspace)).catch(() => { })));
218
- if (olderUntitledWorkspaces.length > 0) {
219
- await this.writeToUserHome({ recentRoots: await this.getRecentWorkspaces() });
220
- }
221
- }
222
- }
223
-
224
- export interface RecentWorkspacePathsData {
225
- recentRoots: string[];
226
- }
227
-
228
- export namespace RecentWorkspacePathsData {
229
- /**
230
- * Parses `data` as `RecentWorkspacePathsData` but removes any non-string array entry.
231
- *
232
- * Returns undefined if the given `data` does not contain a `recentRoots` array property.
233
- */
234
- export function create(data: unknown): RecentWorkspacePathsData | undefined {
235
- if (typeof data !== 'object' || !data || !Array.isArray((data as RecentWorkspacePathsData).recentRoots)) {
236
- return;
237
- }
238
- return {
239
- recentRoots: (data as RecentWorkspacePathsData).recentRoots.filter(root => typeof root === 'string')
240
- };
241
- }
242
- }
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import * as path from 'path';
18
+ import * as yargs from '@theia/core/shared/yargs';
19
+ import * as fs from '@theia/core/shared/fs-extra';
20
+ import * as jsoncparser from 'jsonc-parser';
21
+ import { injectable, inject, postConstruct } from '@theia/core/shared/inversify';
22
+ import { FileUri, BackendApplicationContribution } from '@theia/core/lib/node';
23
+ import { CliContribution } from '@theia/core/lib/node/cli';
24
+ import { Deferred } from '@theia/core/lib/common/promise-util';
25
+ import { WorkspaceServer, CommonWorkspaceUtils } from '../common';
26
+ import { EnvVariablesServer } from '@theia/core/lib/common/env-variables';
27
+ import URI from '@theia/core/lib/common/uri';
28
+
29
+ @injectable()
30
+ export class WorkspaceCliContribution implements CliContribution {
31
+
32
+ @inject(EnvVariablesServer) protected readonly envVariablesServer: EnvVariablesServer;
33
+ @inject(CommonWorkspaceUtils) protected readonly workspaceUtils: CommonWorkspaceUtils;
34
+
35
+ workspaceRoot = new Deferred<string | undefined>();
36
+
37
+ configure(conf: yargs.Argv): void {
38
+ conf.usage('$0 [workspace-directories] [options]');
39
+ conf.option('root-dir', {
40
+ description: 'DEPRECATED: Sets the workspace directory.',
41
+ });
42
+ }
43
+
44
+ async setArguments(args: yargs.Arguments): Promise<void> {
45
+ const workspaceArguments = args._.slice(2).map(probablyAlreadyString => String(probablyAlreadyString));
46
+ if (workspaceArguments.length === 0 && args['root-dir']) {
47
+ workspaceArguments.push(String(args['root-dir']));
48
+ }
49
+ if (workspaceArguments.length === 0) {
50
+ this.workspaceRoot.resolve(undefined);
51
+ } else if (workspaceArguments.length === 1) {
52
+ this.workspaceRoot.resolve(this.normalizeWorkspaceArg(workspaceArguments[0]));
53
+ } else {
54
+ this.workspaceRoot.resolve(this.buildWorkspaceForMultipleArguments(workspaceArguments));
55
+ }
56
+ }
57
+
58
+ protected normalizeWorkspaceArg(raw: string): string {
59
+ return path.resolve(raw).replace(/\/$/, '');
60
+ }
61
+
62
+ protected async buildWorkspaceForMultipleArguments(workspaceArguments: string[]): Promise<string | undefined> {
63
+ try {
64
+ const dirs = await Promise.all(workspaceArguments.map(async maybeDir => (await fs.stat(maybeDir).catch(() => undefined))?.isDirectory()));
65
+ const folders = workspaceArguments.filter((_, index) => dirs[index]).map(dir => ({ path: this.normalizeWorkspaceArg(dir) }));
66
+ if (folders.length < 2) {
67
+ return folders[0]?.path;
68
+ }
69
+ const untitledWorkspaceUri = await this.workspaceUtils.getUntitledWorkspaceUri(
70
+ new URI(await this.envVariablesServer.getConfigDirUri()),
71
+ async uri => !await fs.pathExists(uri.path.fsPath()),
72
+ );
73
+ const untitledWorkspacePath = untitledWorkspaceUri.path.fsPath();
74
+
75
+ await fs.ensureDir(path.dirname(untitledWorkspacePath));
76
+ await fs.writeFile(untitledWorkspacePath, JSON.stringify({ folders }, undefined, 4));
77
+ return untitledWorkspacePath;
78
+ } catch {
79
+ return undefined;
80
+ }
81
+ }
82
+ }
83
+
84
+ @injectable()
85
+ export class DefaultWorkspaceServer implements WorkspaceServer, BackendApplicationContribution {
86
+
87
+ protected root: Deferred<string | undefined> = new Deferred();
88
+ /**
89
+ * Untitled workspaces that are not among the most recent N workspaces will be deleted on start. Increase this number to keep older files,
90
+ * lower it to delete stale untitled workspaces more aggressively.
91
+ */
92
+ protected untitledWorkspaceStaleThreshold = 10;
93
+
94
+ @inject(WorkspaceCliContribution)
95
+ protected readonly cliParams: WorkspaceCliContribution;
96
+
97
+ @inject(EnvVariablesServer)
98
+ protected readonly envServer: EnvVariablesServer;
99
+
100
+ @inject(CommonWorkspaceUtils)
101
+ protected readonly utils: CommonWorkspaceUtils;
102
+
103
+ @postConstruct()
104
+ protected async init(): Promise<void> {
105
+ const root = await this.getRoot();
106
+ this.root.resolve(root);
107
+ }
108
+
109
+ async onStart(): Promise<void> {
110
+ await this.removeOldUntitledWorkspaces();
111
+ }
112
+
113
+ protected async getRoot(): Promise<string | undefined> {
114
+ let root = await this.getWorkspaceURIFromCli();
115
+ if (!root) {
116
+ const data = await this.readRecentWorkspacePathsFromUserHome();
117
+ if (data && data.recentRoots) {
118
+ root = data.recentRoots[0];
119
+ }
120
+ }
121
+ return root;
122
+ }
123
+
124
+ getMostRecentlyUsedWorkspace(): Promise<string | undefined> {
125
+ return this.root.promise;
126
+ }
127
+
128
+ async setMostRecentlyUsedWorkspace(rawUri: string): Promise<void> {
129
+ const uri = rawUri && new URI(rawUri).toString(); // the empty string is used as a signal from the frontend not to load a workspace.
130
+ this.root = new Deferred();
131
+ this.root.resolve(uri);
132
+ const recentRoots = Array.from(new Set([uri, ...await this.getRecentWorkspaces()]));
133
+ this.writeToUserHome({ recentRoots });
134
+ }
135
+
136
+ async removeRecentWorkspace(rawUri: string): Promise<void> {
137
+ const uri = rawUri && new URI(rawUri).toString(); // the empty string is used as a signal from the frontend not to load a workspace.
138
+ const recentRoots = await this.getRecentWorkspaces();
139
+ const index = recentRoots.indexOf(uri);
140
+ if (index !== -1) {
141
+ recentRoots.splice(index, 1);
142
+ this.writeToUserHome({
143
+ recentRoots
144
+ });
145
+ }
146
+ }
147
+
148
+ async getRecentWorkspaces(): Promise<string[]> {
149
+ const listUri: string[] = [];
150
+ const data = await this.readRecentWorkspacePathsFromUserHome();
151
+ if (data && data.recentRoots) {
152
+ data.recentRoots.forEach(element => {
153
+ if (element.length > 0) {
154
+ if (this.workspaceStillExist(element)) {
155
+ listUri.push(element);
156
+ }
157
+ }
158
+ });
159
+ }
160
+ return listUri;
161
+ }
162
+
163
+ protected workspaceStillExist(workspaceRootUri: string): boolean {
164
+ return fs.pathExistsSync(FileUri.fsPath(workspaceRootUri));
165
+ }
166
+
167
+ protected async getWorkspaceURIFromCli(): Promise<string | undefined> {
168
+ const arg = await this.cliParams.workspaceRoot.promise;
169
+ return arg !== undefined ? FileUri.create(arg).toString() : undefined;
170
+ }
171
+
172
+ /**
173
+ * Writes the given uri as the most recently used workspace root to the user's home directory.
174
+ * @param uri most recently used uri
175
+ */
176
+ protected async writeToUserHome(data: RecentWorkspacePathsData): Promise<void> {
177
+ const file = await this.getUserStoragePath();
178
+ await this.writeToFile(file, data);
179
+ }
180
+
181
+ protected async writeToFile(fsPath: string, data: object): Promise<void> {
182
+ if (!await fs.pathExists(fsPath)) {
183
+ await fs.mkdirs(path.resolve(fsPath, '..'));
184
+ }
185
+ await fs.writeJson(fsPath, data);
186
+ }
187
+
188
+ /**
189
+ * Reads the most recently used workspace root from the user's home directory.
190
+ */
191
+ protected async readRecentWorkspacePathsFromUserHome(): Promise<RecentWorkspacePathsData | undefined> {
192
+ const fsPath = await this.getUserStoragePath();
193
+ const data = await this.readJsonFromFile(fsPath);
194
+ return RecentWorkspacePathsData.create(data);
195
+ }
196
+
197
+ protected async readJsonFromFile(fsPath: string): Promise<object | undefined> {
198
+ if (await fs.pathExists(fsPath)) {
199
+ const rawContent = await fs.readFile(fsPath, 'utf-8');
200
+ const strippedContent = jsoncparser.stripComments(rawContent);
201
+ return jsoncparser.parse(strippedContent);
202
+ }
203
+ }
204
+
205
+ protected async getUserStoragePath(): Promise<string> {
206
+ const configDirUri = await this.envServer.getConfigDirUri();
207
+ return path.resolve(FileUri.fsPath(configDirUri), 'recentworkspace.json');
208
+ }
209
+
210
+ /**
211
+ * Removes untitled workspaces that are not among the most recently used workspaces.
212
+ * Use the `untitledWorkspaceStaleThreshold` to configure when to delete workspaces.
213
+ */
214
+ protected async removeOldUntitledWorkspaces(): Promise<void> {
215
+ const recents = (await this.getRecentWorkspaces()).map(FileUri.fsPath);
216
+ const olderUntitledWorkspaces = recents.slice(this.untitledWorkspaceStaleThreshold).filter(workspace => this.utils.isUntitledWorkspace(FileUri.create(workspace)));
217
+ await Promise.all(olderUntitledWorkspaces.map(workspace => fs.promises.unlink(FileUri.fsPath(workspace)).catch(() => { })));
218
+ if (olderUntitledWorkspaces.length > 0) {
219
+ await this.writeToUserHome({ recentRoots: await this.getRecentWorkspaces() });
220
+ }
221
+ }
222
+ }
223
+
224
+ export interface RecentWorkspacePathsData {
225
+ recentRoots: string[];
226
+ }
227
+
228
+ export namespace RecentWorkspacePathsData {
229
+ /**
230
+ * Parses `data` as `RecentWorkspacePathsData` but removes any non-string array entry.
231
+ *
232
+ * Returns undefined if the given `data` does not contain a `recentRoots` array property.
233
+ */
234
+ export function create(data: unknown): RecentWorkspacePathsData | undefined {
235
+ if (typeof data !== 'object' || !data || !Array.isArray((data as RecentWorkspacePathsData).recentRoots)) {
236
+ return;
237
+ }
238
+ return {
239
+ recentRoots: (data as RecentWorkspacePathsData).recentRoots.filter(root => typeof root === 'string')
240
+ };
241
+ }
242
+ }
package/src/node/index.ts CHANGED
@@ -1,18 +1,18 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- export * from './default-workspace-server';
18
- export * from './workspace-backend-module';
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ export * from './default-workspace-server';
18
+ export * from './workspace-backend-module';
@@ -1,37 +1,37 @@
1
- // *****************************************************************************
2
- // Copyright (C) 2017 TypeFox and others.
3
- //
4
- // This program and the accompanying materials are made available under the
5
- // terms of the Eclipse Public License v. 2.0 which is available at
6
- // http://www.eclipse.org/legal/epl-2.0.
7
- //
8
- // This Source Code may also be made available under the following Secondary
9
- // Licenses when the conditions for such availability set forth in the Eclipse
10
- // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
- // with the GNU Classpath Exception which is available at
12
- // https://www.gnu.org/software/classpath/license.html.
13
- //
14
- // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
- // *****************************************************************************
16
-
17
- import { ContainerModule } from '@theia/core/shared/inversify';
18
- import { ConnectionHandler, JsonRpcConnectionHandler } from '@theia/core/lib/common';
19
- import { WorkspaceServer, workspacePath, CommonWorkspaceUtils } from '../common';
20
- import { DefaultWorkspaceServer, WorkspaceCliContribution } from './default-workspace-server';
21
- import { CliContribution } from '@theia/core/lib/node/cli';
22
- import { BackendApplicationContribution } from '@theia/core/lib/node';
23
-
24
- export default new ContainerModule(bind => {
25
- bind(WorkspaceCliContribution).toSelf().inSingletonScope();
26
- bind(CliContribution).toService(WorkspaceCliContribution);
27
- bind(DefaultWorkspaceServer).toSelf().inSingletonScope();
28
- bind(WorkspaceServer).toService(DefaultWorkspaceServer);
29
- bind(BackendApplicationContribution).toService(WorkspaceServer);
30
- bind(CommonWorkspaceUtils).toSelf().inSingletonScope();
31
-
32
- bind(ConnectionHandler).toDynamicValue(ctx =>
33
- new JsonRpcConnectionHandler(workspacePath, () =>
34
- ctx.container.get(WorkspaceServer)
35
- )
36
- ).inSingletonScope();
37
- });
1
+ // *****************************************************************************
2
+ // Copyright (C) 2017 TypeFox and others.
3
+ //
4
+ // This program and the accompanying materials are made available under the
5
+ // terms of the Eclipse Public License v. 2.0 which is available at
6
+ // http://www.eclipse.org/legal/epl-2.0.
7
+ //
8
+ // This Source Code may also be made available under the following Secondary
9
+ // Licenses when the conditions for such availability set forth in the Eclipse
10
+ // Public License v. 2.0 are satisfied: GNU General Public License, version 2
11
+ // with the GNU Classpath Exception which is available at
12
+ // https://www.gnu.org/software/classpath/license.html.
13
+ //
14
+ // SPDX-License-Identifier: EPL-2.0 OR GPL-2.0 WITH Classpath-exception-2.0
15
+ // *****************************************************************************
16
+
17
+ import { ContainerModule } from '@theia/core/shared/inversify';
18
+ import { ConnectionHandler, JsonRpcConnectionHandler } from '@theia/core/lib/common';
19
+ import { WorkspaceServer, workspacePath, CommonWorkspaceUtils } from '../common';
20
+ import { DefaultWorkspaceServer, WorkspaceCliContribution } from './default-workspace-server';
21
+ import { CliContribution } from '@theia/core/lib/node/cli';
22
+ import { BackendApplicationContribution } from '@theia/core/lib/node';
23
+
24
+ export default new ContainerModule(bind => {
25
+ bind(WorkspaceCliContribution).toSelf().inSingletonScope();
26
+ bind(CliContribution).toService(WorkspaceCliContribution);
27
+ bind(DefaultWorkspaceServer).toSelf().inSingletonScope();
28
+ bind(WorkspaceServer).toService(DefaultWorkspaceServer);
29
+ bind(BackendApplicationContribution).toService(WorkspaceServer);
30
+ bind(CommonWorkspaceUtils).toSelf().inSingletonScope();
31
+
32
+ bind(ConnectionHandler).toDynamicValue(ctx =>
33
+ new JsonRpcConnectionHandler(workspacePath, () =>
34
+ ctx.container.get(WorkspaceServer)
35
+ )
36
+ ).inSingletonScope();
37
+ });