Send include cleanup editorconfig preferences

Author: Colengms

Extension/src/LanguageServer/client.ts

@@ -55,6 +55,7 @@ import { CustomConfigurationProvider1, getCustomConfigProviders, isSameProviderE
 import { DataBinding } from './dataBinding';
 import { cachedEditorConfigSettings, getEditorConfigSettings } from './editorConfig';
 import { CppSourceStr, clients, configPrefix, initializeIntervalTimer, isWritingCrashCallStack, updateLanguageConfigurations, usesCrashHandler, watchForCrashes } from './extension';
+import { IncludeCleanupPreferences, getIncludeCleanupPreferences } from './includeCleanupEditorConfig';
 import { LanguageClient } from './languageClient';
 import { LocalizeStringParams, getLocaleId, getLocalizedString } from './localization';
 import { PersistentFolderState, PersistentState, PersistentWorkspaceState } from './persistentState';
@@ -511,6 +512,7 @@ interface TagParseStatus {
 interface VisibleEditorInfo {
     visibleRanges: Range[];
     originalEncoding: string;
+    includeCleanupPreferences: IncludeCleanupPreferences;
 }
 
 interface DidChangeVisibleTextEditorsParams {
@@ -1929,9 +1931,11 @@ export class DefaultClient implements Client {
             // First, we just concat all ranges for the same file.
             const uri: string = editor.document.uri.toString();
             if (!visibileEditorInfo[uri]) {
+                const editorConfigSettings: any = getEditorConfigSettings(editor.document.uri.fsPath);
                 visibileEditorInfo[uri] = {
                     visibleRanges: [],
-                    originalEncoding: editor.document.encoding
+                    originalEncoding: editor.document.encoding,
+                    includeCleanupPreferences: getIncludeCleanupPreferences(editorConfigSettings)
                 };
             }
             visibileEditorInfo[uri].visibleRanges = visibileEditorInfo[uri].visibleRanges.concat(editor.visibleRanges.map(makeLspRange));
@@ -2684,6 +2688,15 @@ export class DefaultClient implements Client {
 
     private associations_for_did_change?: Set<string>;
 
+    private refreshEditorConfigSettings(): void {
+        cachedEditorConfigSettings.clear();
+        cachedEditorConfigLookups.clear();
+        this.updateActiveDocumentTextOptions();
+
+        const cppEditors: vscode.TextEditor[] = vscode.window.visibleTextEditors.filter(editor => util.isCpp(editor.document));
+        void this.onDidChangeVisibleTextEditors(cppEditors).catch(logAndReturn.undefined);
+    }
+
     /**
      * listen for file created/deleted events under the ${workspaceFolder} folder
      */
@@ -2704,9 +2717,7 @@ export class DefaultClient implements Client {
                 }
                 const fileName: string = path.basename(uri.fsPath).toLowerCase();
                 if (fileName === ".editorconfig") {
-                    cachedEditorConfigSettings.clear();
-                    cachedEditorConfigLookups.clear();
-                    this.updateActiveDocumentTextOptions();
+                    this.refreshEditorConfigSettings();
                 }
                 if (fileName === ".clang-format" || fileName === "_clang-format") {
                     cachedEditorConfigLookups.clear();
@@ -2732,9 +2743,7 @@ export class DefaultClient implements Client {
                 const dotIndex: number = uri.fsPath.lastIndexOf('.');
                 const fileName: string = path.basename(uri.fsPath).toLowerCase();
                 if (fileName === ".editorconfig") {
-                    cachedEditorConfigSettings.clear();
-                    cachedEditorConfigLookups.clear();
-                    this.updateActiveDocumentTextOptions();
+                    this.refreshEditorConfigSettings();
                 }
                 const ext: string | undefined = dotIndex !== -1 ? uri.fsPath.substring(dotIndex + 1) : undefined;
                 const isTrackedFile: boolean = hasNativeFileTypeMappings()
@@ -2759,8 +2768,7 @@ export class DefaultClient implements Client {
                 }
                 const fileName: string = path.basename(uri.fsPath).toLowerCase();
                 if (fileName === ".editorconfig") {
-                    cachedEditorConfigSettings.clear();
-                    cachedEditorConfigLookups.clear();
+                    this.refreshEditorConfigSettings();
                 }
                 if (fileName === ".clang-format" || fileName === "_clang-format") {
                     cachedEditorConfigLookups.clear();

Extension/src/LanguageServer/includeCleanupEditorConfig.ts

@@ -0,0 +1,20 @@
+export interface IncludeCleanupPreferences {
+    alternateFiles: string;
+    excludedFiles: string;
+    replacementFiles: string;
+    requiredFiles: string;
+}
+
+function getStringSetting(settings: any, key: string): string {
+    const value: unknown = settings?.[key];
+    return typeof value === 'string' && value.toLowerCase() !== 'unset' ? value : '';
+}
+
+export function getIncludeCleanupPreferences(settings: any): IncludeCleanupPreferences {
+    return {
+        alternateFiles: getStringSetting(settings, 'cpp_include_cleanup_alternate_files'),
+        excludedFiles: getStringSetting(settings, 'cpp_include_cleanup_excluded_files'),
+        replacementFiles: getStringSetting(settings, 'cpp_include_cleanup_replacement_files'),
+        requiredFiles: getStringSetting(settings, 'cpp_include_cleanup_required_files')
+    };
+}

Extension/test/unit/includeCleanupEditorConfig.test.ts

@@ -0,0 +1,32 @@
+import { deepStrictEqual } from 'assert';
+import { describe, it } from 'mocha';
+import { getIncludeCleanupPreferences } from '../../src/LanguageServer/includeCleanupEditorConfig';
+
+describe('Include Cleanup editorconfig settings', () => {
+    it('maps semantic preference strings', () => {
+        deepStrictEqual(getIncludeCleanupPreferences({
+            cpp_include_cleanup_alternate_files: 'umbrella.h:internal.h',
+            cpp_include_cleanup_excluded_files: 'generated.h',
+            cpp_include_cleanup_replacement_files: 'stdio.h:cstdio',
+            cpp_include_cleanup_required_files: 'atlwin.h:atlbase.h'
+        }), {
+            alternateFiles: 'umbrella.h:internal.h',
+            excludedFiles: 'generated.h',
+            replacementFiles: 'stdio.h:cstdio',
+            requiredFiles: 'atlwin.h:atlbase.h'
+        });
+    });
+
+    it('ignores unset and non-string values', () => {
+        deepStrictEqual(getIncludeCleanupPreferences({
+            cpp_include_cleanup_alternate_files: 'unset',
+            cpp_include_cleanup_excluded_files: true,
+            cpp_include_cleanup_replacement_files: 42
+        }), {
+            alternateFiles: '',
+            excludedFiles: '',
+            replacementFiles: '',
+            requiredFiles: ''
+        });
+    });
+});