Hide java project setting files by default.

Signed-off-by: Yaohai Zheng <[email protected]>

package.json

@@ -89,6 +89,12 @@
           "description": "Specifies the severity of the message when the classpath is incomplete for a Java file",
           "scope": "window"
         },
+        "java.configuration.excludeProjectSettingFiles": {
+          "type": "boolean",
+          "default": true,
+          "description": "Exclude the extension generated project setting files from file explorer.",
+          "scope": "window"
+        },
         "java.configuration.updateBuildConfiguration": {
           "type": [
             "string"

src/extension.ts

@@ -14,8 +14,9 @@ SourceAttachmentRequest, SourceAttachmentResult, SourceAttachmentAttribute } fro
 import { ExtensionAPI } from './extension.api';
 import * as buildpath from './buildpath';
 import * as net from 'net';
+import { getJavaConfiguration } from './utils';
+import {  onConfigurationChange, excludeProjectSettingFiles } from './setting';
 
-let oldConfig;
 let lastStatus;
 let languageClient: LanguageClient;
 let jdtEventEmitter = new EventEmitter<Uri>();
@@ -82,7 +83,6 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 				item.command = Commands.OPEN_OUTPUT;
 				let progressBar = window.createStatusBarItem(StatusBarAlignment.Left, Number.MIN_VALUE+1);
 
-				oldConfig = getJavaConfiguration();
 				let serverOptions;
 				let port = process.env['SERVER_PORT'];
 				if (!port) {
@@ -301,6 +301,11 @@ export function activate(context: ExtensionContext): Promise<ExtensionAPI> {
 						}
 					};
 					workspace.registerTextDocumentContentProvider('jdt', provider);
+					if (workspace.workspaceFolders) {
+						workspace.workspaceFolders.map((folder) => {
+							excludeProjectSettingFiles(folder.uri);
+						});
+					}
 				});
 
 				let cleanWorkspaceExists = fs.existsSync( path.join(workspacePath,  cleanWorkspaceFileName));
@@ -435,34 +440,6 @@ function isJavaConfigFile(path: String) {
 	return path.endsWith('pom.xml') || path.endsWith('.gradle');
 }
 
-function onConfigurationChange() {
-	return workspace.onDidChangeConfiguration(params => {
-		let newConfig = getJavaConfiguration();
-		if (hasJavaConfigChanged(oldConfig, newConfig)) {
-			let msg = 'Java Language Server configuration changed, please restart VS Code.';
-			let action = 'Restart Now';
-			let restartId = Commands.RELOAD_WINDOW;
-			oldConfig = newConfig;
-			window.showWarningMessage(msg, action).then((selection) => {
-				if (action === selection) {
-					commands.executeCommand(restartId);
-				}
-			});
-		}
-	});
-}
-
-function hasJavaConfigChanged(oldConfig, newConfig) {
-	return hasConfigKeyChanged('home', oldConfig, newConfig)
-		|| hasConfigKeyChanged('jdt.ls.vmargs', oldConfig, newConfig)
-		|| hasConfigKeyChanged('progressReports.enabled', oldConfig, newConfig);
-}
-
-function hasConfigKeyChanged(key, oldConfig, newConfig) {
-	return oldConfig.get(key) !== newConfig.get(key);
-}
-
-
 function getTempWorkspace() {
 	return path.resolve(os.tmpdir(), 'vscodesws_' + makeRandomHexString(5));
 }
@@ -477,9 +454,6 @@ function makeRandomHexString(length) {
 	return result;
 }
 
-function getJavaConfiguration(): WorkspaceConfiguration {
-	return workspace.getConfiguration('java');
-}
 
 async function cleanWorkspace(workspacePath) {
 	const doIt = 'Restart and delete';
@@ -746,4 +720,4 @@ function isPrefix(parentPath: string, childPath: string): boolean {
 	}
 	const relative = path.relative(parentPath, childPath);
 	return !!relative && !relative.startsWith('..') && !path.isAbsolute(relative);
-}
+}

src/setting.ts

@@ -0,0 +1,53 @@
+'use strict';
+
+import { window, Uri, workspace, WorkspaceConfiguration, commands } from 'vscode';
+import { LanguageClient } from 'vscode-languageclient';
+import { Commands } from './commands';
+import { getJavaConfiguration } from './utils';
+
+
+const DEFAULT_HIIDEN_FILES: string[] = ['**/.classpath', '**/.project', '**/.settings'];
+
+let oldConfig = getJavaConfiguration();
+
+export function onConfigurationChange() {
+	return workspace.onDidChangeConfiguration(params => {
+		let newConfig = getJavaConfiguration();
+		if (hasJavaConfigChanged(oldConfig, newConfig)) {
+			let msg = 'Java Language Server configuration changed, please restart VS Code.';
+			let action = 'Restart Now';
+			let restartId = Commands.RELOAD_WINDOW;
+			oldConfig = newConfig;
+			window.showWarningMessage(msg, action).then((selection) => {
+				if (action === selection) {
+					commands.executeCommand(restartId);
+				}
+			});
+		}
+	});
+}
+
+export function excludeProjectSettingFiles(workspaceUri: Uri) {
+	if (getJavaConfiguration().get<Boolean>('configuration.excludeProjectSettingFiles')) {
+		const config = workspace.getConfiguration('files', workspaceUri);
+		const excludeValue: Object = config.get('exclude');
+
+		for (const hiddenFiles of DEFAULT_HIIDEN_FILES) {
+			if (!excludeValue.hasOwnProperty(hiddenFiles)) {
+				excludeValue[hiddenFiles] = true;
+			}
+
+		}
+		config.update('exclude', excludeValue);
+	}
+}
+
+function hasJavaConfigChanged(oldConfig, newConfig) {
+	return hasConfigKeyChanged('home', oldConfig, newConfig)
+		|| hasConfigKeyChanged('jdt.ls.vmargs', oldConfig, newConfig)
+		|| hasConfigKeyChanged('progressReports.enabled', oldConfig, newConfig);
+}
+
+function hasConfigKeyChanged(key, oldConfig, newConfig) {
+	return oldConfig.get(key) !== newConfig.get(key);
+}

src/utils.ts

@@ -0,0 +1,7 @@
+'use strict';
+
+import { workspace, WorkspaceConfiguration } from 'vscode';
+
+export function getJavaConfiguration(): WorkspaceConfiguration {
+	return workspace.getConfiguration('java');
+}