Stop generating metadata files at project's root (#2153)

* Stop generating metadata files at project's root

Signed-off-by: Sheng Chen <sheche@microsoft.com>

Author: jdneo

README.md

@@ -197,6 +197,7 @@ The following settings are supported:
 New in 1.1.0:
  * `java.quickfix.showAt` : Show quickfixes at the problem or line level.
  * `java.configuration.workspaceCacheLimit` : The number of days (if enabled) to keep unused workspace cache data. Beyond this limit, cached workspace data may be removed.
+ * `java.import.generatesMetadataFilesAtProjectRoot` : Specify whether the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated at the project root. Defaults to `false`.
 
 
 Semantic Highlighting

document/_java.metadataFilesGeneration.md

@@ -0,0 +1,21 @@
+# Metadata Files Generation
+
+We use the setting `java.import.generatesMetadataFilesAtProjectRoot` to control where the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated:
+- `true`: Metadata files will be generated at the project's root.
+- `false`: Metadata files will be generated at the workspace storage. To be specifc, the path will be: `<WORKSPACE_STORAGE_PATH>/redhat.java/jdt_ws/.metadata/.plugins/org.eclipse.core.resources/.projects/<PROJECT_NAME>/`.
+
+By default, the setting is set to `false`.
+
+> If the metadata files exist in both the project root and the workspace storage, the extension will pick the files in the project root.
+
+## Change the setting value
+
+Depending on how you change the setting, some extra steps need to be taken to make the change take effect.
+
+### Change from `false` to `true`
+You need to restart the client.
+
+### Change from `true` to `false`
+1. Close the client.
+2. Remove the metadata files in the project by your own.
+3. Open the client.

package.json

@@ -44,7 +44,8 @@
     "workspaceContains:build.gradle.kts",
     "workspaceContains:settings.gradle.kts",
     "workspaceContains:.classpath",
-    "onCommand:_java.templateVariables"
+    "onCommand:_java.templateVariables",
+    "onCommand:_java.metadataFilesGeneration"
   ],
   "main": "./dist/extension",
   "contributes": {
@@ -376,6 +377,12 @@
           ],
           "scope": "window"
         },
+        "java.import.generatesMetadataFilesAtProjectRoot": {
+          "type": "boolean",
+          "markdownDescription": "Specify whether the project metadata files(.project, .classpath, .factorypath, .settings/) will be generated at the project root. Click [HERE](command:_java.metadataFilesGeneration) to learn how to change the setting to make it take effect.",
+          "default": false,
+          "scope": "window"
+        },
         "java.project.referencedLibraries": {
           "type": [
             "array",

src/commands.ts

@@ -241,5 +241,7 @@ export namespace Commands {
 
     export const NOT_COVERED_EXECUTION = '_java.notCoveredExecution';
 
+    export const MEATDATA_FILES_GENERATION = '_java.metadataFilesGeneration';
+
     export const RUNTIME_VALIDATION_OPEN = 'java.runtimeValidation.open';
 }

src/extension.ts

@@ -31,11 +31,12 @@ import * as chokidar from 'chokidar';
 const syntaxClient: SyntaxLanguageClient = new SyntaxLanguageClient();
 const standardClient: StandardLanguageClient = new StandardLanguageClient();
 const jdtEventEmitter = new EventEmitter<Uri>();
-const cleanWorkspaceFileName = '.cleanWorkspace';
 const extensionName = 'Language Support for Java';
 let storagePath: string;
 let clientLogFile: string;
 
+export const cleanWorkspaceFileName = '.cleanWorkspace';
+
 export class ClientErrorHandler implements ErrorHandler {
 	private restarts: number[];
 
@@ -162,6 +163,9 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 	}));
 
 	storagePath = context.storagePath;
+	context.subscriptions.push(commands.registerCommand(Commands.MEATDATA_FILES_GENERATION, async () => {
+		markdownPreviewProvider.show(context.asAbsolutePath(path.join('document', `_java.metadataFilesGeneration.md`)), 'Metadata Files Generation', "", context);
+	}));
 	if (!storagePath) {
 		storagePath = getTempWorkspace();
 	}
@@ -365,7 +369,7 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 
 			context.subscriptions.push(commands.registerCommand(Commands.CLEAN_WORKSPACE, () => cleanWorkspace(workspacePath)));
 
-			context.subscriptions.push(onConfigurationChange());
+			context.subscriptions.push(onConfigurationChange(workspacePath));
 
 			/**
 			 * Command to switch the server mode. Currently it only supports switch from lightweight to standard.

src/javaServerStarter.ts

@@ -73,6 +73,10 @@ function prepareParams(requirements: RequirementsData, javaConfiguration, worksp
 	if (DEBUG) {
 		params.push('-Dlog.level=ALL');
 	}
+	const metadataLocation = workspace.getConfiguration().get('java.import.generatesMetadataFilesAtProjectRoot');
+	if (metadataLocation !== undefined) {
+		params.push(`-Djava.import.generatesMetadataFilesAtProjectRoot=${metadataLocation}`);
+	}
 	let vmargsCheck = workspace.getConfiguration().inspect('java.jdt.ls.vmargs').workspaceValue;
 	if (vmargsCheck !== undefined) {
 		const isWorkspaceTrusted = (workspace as any).isTrusted; // keep compatibility for old engines < 1.56.0

src/settings.ts

@@ -1,9 +1,11 @@
 'use strict';
 
+import * as fs from 'fs';
 import * as path from 'path';
 import { window, Uri, workspace, WorkspaceConfiguration, commands, ConfigurationTarget, env, ExtensionContext, TextEditor, Range, Disposable, WorkspaceFolder } from 'vscode';
 import { Commands } from './commands';
-import { getJavaConfiguration } from './utils';
+import { cleanWorkspaceFileName } from './extension';
+import { ensureExists, getJavaConfiguration } from './utils';
 
 const DEFAULT_HIDDEN_FILES: string[] = ['**/.classpath', '**/.project', '**/.settings', '**/.factorypath'];
 export const IS_WORKSPACE_JDK_ALLOWED = "java.ls.isJdkAllowed";
@@ -23,7 +25,7 @@ export const ORGANIZE_IMPORTS_ON_PASTE = 'actionsOnPaste.organizeImports'; // ja
 let oldConfig: WorkspaceConfiguration = getJavaConfiguration();
 const gradleWrapperPromptDialogs = [];
 
-export function onConfigurationChange() {
+export function onConfigurationChange(workspacePath: string) {
 	return workspace.onDidChangeConfiguration(params => {
 		if (!params.affectsConfiguration('java')) {
 			return;
@@ -32,7 +34,15 @@ export function onConfigurationChange() {
 		if (newConfig.get(EXCLUDE_FILE_CONFIG)) {
 			excludeProjectSettingsFiles();
 		}
-		if (hasJavaConfigChanged(oldConfig, newConfig)) {
+
+		const isFsModeChanged: boolean = hasConfigKeyChanged('import.generatesMetadataFilesAtProjectRoot', oldConfig, newConfig);
+		if (isFsModeChanged) {
+			// Changing the FS mode needs a clean restart.
+			ensureExists(workspacePath);
+			const file = path.join(workspacePath, cleanWorkspaceFileName);
+			fs.closeSync(fs.openSync(file, 'w'));
+		}
+		if (isFsModeChanged || hasJavaConfigChanged(oldConfig, newConfig)) {
 			const msg = `Java Language Server configuration changed, please restart ${env.appName}.`;
 			const action = 'Restart Now';
 			const restartId = Commands.RELOAD_WINDOW;