(feat) make prettier/emmet config updateable (#709)

dummdidumm · web-flow · commit a847c15b4390 · 2020-12-11T10:47:53.000+01:00
Move prettier/emmet config into LSConfigManager to make it updateable and to have config in one place
diff --git a/packages/language-server/src/ls-config.ts b/packages/language-server/src/ls-config.ts
@@ -1,5 +1,6 @@
 import { merge, get } from 'lodash';
 import { UserPreferences } from 'typescript';
+import { EmmetConfiguration } from 'vscode-emmet-helper';
 
 /**
  * Default config for the language server.
@@ -91,7 +92,7 @@ export interface LSTypescriptConfig {
     };
     signatureHelp: {
         enable: boolean;
-    }
+    };
 }
 
 export interface LSCSSConfig {
@@ -188,7 +189,9 @@ export class LSConfigManager {
     private tsUserPreferences: Record<TsUserConfigLang, UserPreferences> = {
         typescript: {},
         javascript: {}
-    }
+    };
+    private prettierConfig: any = {};
+    private emmetConfig: EmmetConfiguration = {};
 
     /**
      * Updates config.
@@ -237,13 +240,43 @@ export class LSConfigManager {
         this.listeners.push(callback);
     }
 
-    updateTsUserPreferences(lang: TsUserConfigLang, config: TsUserPreferencesConfig) {
+    updateEmmetConfig(config: EmmetConfiguration): void {
+        this.emmetConfig = config || {};
+    }
+
+    getEmmetConfig(): EmmetConfiguration {
+        return this.emmetConfig;
+    }
+
+    updatePrettierConfig(config: any): void {
+        this.prettierConfig = config || {};
+    }
+
+    getPrettierConfig(): any {
+        return this.prettierConfig;
+    }
+
+    updateTsJsUserPreferences(
+        config: Record<
+            TsUserConfigLang,
+            {
+                preferences: TsUserPreferencesConfig;
+            }
+        >
+    ): void {
+        (['typescript', 'javascript'] as const).forEach((lang) => {
+            if (config[lang]?.preferences) {
+                this._updateTsUserPreferences(lang, config[lang].preferences);
+            }
+        });
+    }
+
+    private _updateTsUserPreferences(lang: TsUserConfigLang, config: TsUserPreferencesConfig) {
         this.tsUserPreferences[lang] = Object.assign(this.tsUserPreferences[lang], {
             importModuleSpecifierPreference: config.importModuleSpecifier,
             importModuleSpecifierEnding: config.importModuleSpecifierEnding,
             includePackageJsonAutoImports: config.includePackageJsonAutoImports,
             quotePreference: config.quoteStyle
-
         } as UserPreferences);
     }
 
diff --git a/packages/language-server/src/plugins/PluginHost.ts b/packages/language-server/src/plugins/PluginHost.ts
@@ -5,38 +5,37 @@ import {
     Color,
     ColorInformation,
     ColorPresentation,
+    CompletionContext,
+    CompletionItem,
     CompletionList,
     DefinitionLink,
     Diagnostic,
+    FormattingOptions,
     Hover,
+    Location,
     Position,
     Range,
-    SymbolInformation,
-    TextDocumentIdentifier,
-    TextEdit,
-    CompletionItem,
-    CompletionContext,
-    WorkspaceEdit,
-    FormattingOptions,
     ReferenceContext,
-    Location,
     SelectionRange,
     SignatureHelp,
-    SignatureHelpContext
+    SignatureHelpContext,
+    SymbolInformation,
+    TextDocumentIdentifier,
+    TextEdit,
+    WorkspaceEdit
 } from 'vscode-languageserver';
-import { LSConfig, LSConfigManager, TsUserConfigLang, TsUserPreferencesConfig } from '../ls-config';
 import { DocumentManager } from '../lib/documents';
+import { Logger } from '../logger';
+import { regexLastIndexOf } from '../utils';
 import {
-    LSProvider,
-    Plugin,
-    OnWatchFileChanges,
     AppCompletionItem,
     FileRename,
     LSPProviderConfig,
-    OnWatchFileChangesPara
+    LSProvider,
+    OnWatchFileChanges,
+    OnWatchFileChangesPara,
+    Plugin
 } from './interfaces';
-import { Logger } from '../logger';
-import { regexLastIndexOf } from '../utils';
 
 enum ExecuteMode {
     None,
@@ -51,7 +50,7 @@ export class PluginHost implements LSProvider, OnWatchFileChanges {
         definitionLinkSupport: false
     };
 
-    constructor(private documentsManager: DocumentManager, private config: LSConfigManager) { }
+    constructor(private documentsManager: DocumentManager) {}
 
     initialize(pluginHostConfig: LSPProviderConfig) {
         this.pluginHostConfig = pluginHostConfig;
@@ -61,20 +60,6 @@ export class PluginHost implements LSProvider, OnWatchFileChanges {
         this.plugins.push(plugin);
     }
 
-    updateConfig(config: LSConfig) {
-        this.config.update(config);
-    }
-
-    updateTsUserPreferences(config: Record<TsUserConfigLang, {
-        preferences: TsUserPreferencesConfig
-    }>) {
-        (['typescript', 'javascript'] as const).forEach((lang) => {
-            if (config[lang]?.preferences) {
-                this.config.updateTsUserPreferences(lang, config[lang].preferences);
-            }
-        });
-    }
-
     async getDiagnostics(textDocument: TextDocumentIdentifier): Promise<Diagnostic[]> {
         const document = this.getDocument(textDocument.uri);
         if (!document) {
@@ -397,16 +382,18 @@ export class PluginHost implements LSProvider, OnWatchFileChanges {
         }
 
         try {
-            return Promise.all(positions.map(async (position) => {
-                for (const plugin of this.plugins) {
-                    const range = await plugin.getSelectionRange?.(document, position);
-
-                    if (range) {
-                        return range;
+            return Promise.all(
+                positions.map(async (position) => {
+                    for (const plugin of this.plugins) {
+                        const range = await plugin.getSelectionRange?.(document, position);
+
+                        if (range) {
+                            return range;
+                        }
                     }
-                }
-                return SelectionRange.create(Range.create(position, position));
-            }));
+                    return SelectionRange.create(Range.create(position, position));
+                })
+            );
         } catch (error) {
             Logger.error(error);
             return null;
diff --git a/packages/language-server/src/plugins/css/CSSPlugin.ts b/packages/language-server/src/plugins/css/CSSPlugin.ts
@@ -1,8 +1,4 @@
-import {
-    getEmmetCompletionParticipants,
-    doComplete as doEmmetComplete,
-    EmmetConfiguration
-} from 'vscode-emmet-helper';
+import { getEmmetCompletionParticipants, doComplete as doEmmetComplete } from 'vscode-emmet-helper';
 import {
     Color,
     ColorInformation,
@@ -28,7 +24,8 @@ import {
     mapSymbolInformationToOriginal,
     mapObjWithRangeToOriginal,
     mapHoverToParent,
-    mapSelectionRangeToParent, isInTag
+    mapSelectionRangeToParent,
+    isInTag
 } from '../../lib/documents';
 import { LSConfigManager, LSCSSConfig } from '../../ls-config';
 import {
@@ -58,11 +55,7 @@ export class CSSPlugin
     private triggerCharacters = ['.', ':', '-', '/'];
     private globalVars = new GlobalVars();
 
-    constructor(
-        docManager: DocumentManager,
-        configManager: LSConfigManager,
-        private emmetConfig?: EmmetConfiguration
-    ) {
+    constructor(docManager: DocumentManager, configManager: LSConfigManager) {
         this.configManager = configManager;
 
         this.globalVars.watchFiles(this.configManager.get('css.globals'));
@@ -81,12 +74,11 @@ export class CSSPlugin
         }
 
         const cssDocument = this.getCSSDoc(document);
-        const [range] = getLanguageService(extractLanguage(cssDocument))
-            .getSelectionRanges(
-                cssDocument,
-                [cssDocument.getGeneratedPosition(position)],
-                cssDocument.stylesheet
-            );
+        const [range] = getLanguageService(extractLanguage(cssDocument)).getSelectionRanges(
+            cssDocument,
+            [cssDocument.getGeneratedPosition(position)],
+            cssDocument.stylesheet
+        );
 
         if (!range) {
             return null;
@@ -160,7 +152,7 @@ export class CSSPlugin
         if (isSASS(cssDocument)) {
             // the css language service does not support sass, still we can use
             // the emmet helper directly to at least get emmet completions
-            return doEmmetComplete(document, position, 'sass', this.emmetConfig || {});
+            return doEmmetComplete(document, position, 'sass', this.configManager.getEmmetConfig());
         }
 
         const type = extractLanguage(cssDocument);
@@ -178,7 +170,7 @@ export class CSSPlugin
                 cssDocument,
                 cssDocument.getGeneratedPosition(position),
                 getLanguage(type),
-                this.emmetConfig || {},
+                this.configManager.getEmmetConfig(),
                 emmetResults
             )
         ]);
diff --git a/packages/language-server/src/plugins/html/HTMLPlugin.ts b/packages/language-server/src/plugins/html/HTMLPlugin.ts
@@ -1,4 +1,4 @@
-import { EmmetConfiguration, getEmmetCompletionParticipants } from 'vscode-emmet-helper';
+import { getEmmetCompletionParticipants } from 'vscode-emmet-helper';
 import {
     getLanguageService,
     HTMLDocument,
@@ -33,11 +33,7 @@ export class HTMLPlugin implements HoverProvider, CompletionsProvider {
     private documents = new WeakMap<Document, HTMLDocument>();
     private styleScriptTemplate = new Set(['template', 'style', 'script']);
 
-    constructor(
-        docManager: DocumentManager,
-        configManager: LSConfigManager,
-        private emmetConfig?: EmmetConfiguration
-    ) {
+    constructor(docManager: DocumentManager, configManager: LSConfigManager) {
         this.configManager = configManager;
         docManager.on('documentChange', (document) => {
             this.documents.set(document, document.html);
@@ -84,7 +80,7 @@ export class HTMLPlugin implements HoverProvider, CompletionsProvider {
                 document,
                 position,
                 'html',
-                this.emmetConfig || {},
+                this.configManager.getEmmetConfig(),
                 emmetResults
             )
         ]);
diff --git a/packages/language-server/src/plugins/svelte/SveltePlugin.ts b/packages/language-server/src/plugins/svelte/SveltePlugin.ts
@@ -40,7 +40,7 @@ export class SveltePlugin
         SelectionRangeProvider {
     private docManager = new Map<Document, SvelteDocument>();
 
-    constructor(private configManager: LSConfigManager, private prettierConfig?: any) {}
+    constructor(private configManager: LSConfigManager) {}
 
     async getDiagnostics(document: Document): Promise<Diagnostic[]> {
         if (!this.featureEnabled('diagnostics')) {
@@ -73,15 +73,15 @@ export class SveltePlugin
         // Try resolving the config through prettier and fall back to possible editor config
         const config =
             returnObjectIfHasKeys(await prettier.resolveConfig(filePath, { editorconfig: true })) ||
-            returnObjectIfHasKeys(this.prettierConfig) ||
+            returnObjectIfHasKeys(this.configManager.getPrettierConfig()) ||
             // Be defensive here because IDEs other than VSCode might not have these settings
             (options && {
                 tabWidth: options.tabSize,
                 useTabs: !options.insertSpaces
             });
         // Take .prettierignore into account
         const fileInfo = await prettier.getFileInfo(filePath, {
-            ignorePath: this.prettierConfig?.ignorePath ?? '.prettierignore',
+            ignorePath: this.configManager.getPrettierConfig()?.ignorePath ?? '.prettierignore',
             // Sapper places stuff within src/node_modules, we want to format that, too
             withNodeModules: true
         });
diff --git a/packages/language-server/src/server.ts b/packages/language-server/src/server.ts
@@ -83,7 +83,7 @@ export function startServer(options?: LSOptions) {
         (textDocument) => new Document(textDocument.uri, textDocument.text)
     );
     const configManager = new LSConfigManager();
-    const pluginHost = new PluginHost(docManager, configManager);
+    const pluginHost = new PluginHost(docManager);
     let sveltePlugin: SveltePlugin = undefined as any;
 
     connection.onInitialize((evt) => {
@@ -95,25 +95,19 @@ export function startServer(options?: LSOptions) {
             Logger.error('No workspace path set');
         }
 
+        configManager.update(evt.initializationOptions?.config || {});
+        configManager.updateTsJsUserPreferences(evt.initializationOptions?.typescriptConfig || {});
+        configManager.updateEmmetConfig(evt.initializationOptions?.emmetConfig || {});
+        configManager.updatePrettierConfig(evt.initializationOptions?.prettierConfig || {});
+
         pluginHost.initialize({
             filterIncompleteCompletions: !evt.initializationOptions
                 ?.dontFilterIncompleteCompletions,
             definitionLinkSupport: !!evt.capabilities.textDocument?.definition?.linkSupport
         });
-        pluginHost.updateConfig(evt.initializationOptions?.config || {});
-        pluginHost.updateTsUserPreferences(evt.initializationOptions?.typescriptConfig || {});
-        pluginHost.register(
-            (sveltePlugin = new SveltePlugin(
-                configManager,
-                evt.initializationOptions?.prettierConfig
-            ))
-        );
-        pluginHost.register(
-            new HTMLPlugin(docManager, configManager, evt.initializationOptions?.emmetConfig)
-        );
-        pluginHost.register(
-            new CSSPlugin(docManager, configManager, evt.initializationOptions?.emmetConfig)
-        );
+        pluginHost.register((sveltePlugin = new SveltePlugin(configManager)));
+        pluginHost.register(new HTMLPlugin(docManager, configManager));
+        pluginHost.register(new CSSPlugin(docManager, configManager));
         pluginHost.register(new TypeScriptPlugin(docManager, configManager, workspaceUris));
 
         const clientSupportApplyEditCommand = !!evt.capabilities.workspace?.applyEdit;
@@ -206,8 +200,10 @@ export function startServer(options?: LSOptions) {
     connection.onPrepareRename((req) => pluginHost.prepareRename(req.textDocument, req.position));
 
     connection.onDidChangeConfiguration(({ settings }) => {
-        pluginHost.updateConfig(settings.svelte?.plugin);
-        pluginHost.updateTsUserPreferences(settings);
+        configManager.update(settings.svelte?.plugin);
+        configManager.updateTsJsUserPreferences(settings);
+        configManager.updateEmmetConfig(settings.emmet);
+        configManager.updatePrettierConfig(settings.prettier);
     });
 
     connection.onDidOpenTextDocument((evt) => {
@@ -284,10 +280,12 @@ export function startServer(options?: LSOptions) {
     );
 
     connection.onDidChangeWatchedFiles((para) => {
-        const onWatchFileChangesParas = para.changes.map((change) => ({
-            fileName: urlToPath(change.uri),
-            changeType: change.type
-        })).filter((change): change is OnWatchFileChangesPara => !!change.fileName);
+        const onWatchFileChangesParas = para.changes
+            .map((change) => ({
+                fileName: urlToPath(change.uri),
+                changeType: change.type
+            }))
+            .filter((change): change is OnWatchFileChangesPara => !!change.fileName);
 
         pluginHost.onWatchFileChanges(onWatchFileChangesParas);
 
diff --git a/packages/language-server/src/svelte-check.ts b/packages/language-server/src/svelte-check.ts
@@ -21,7 +21,7 @@ export class SvelteCheck {
         (textDocument) => new Document(textDocument.uri, textDocument.text)
     );
     private configManager = new LSConfigManager();
-    private pluginHost = new PluginHost(this.docManager, this.configManager);
+    private pluginHost = new PluginHost(this.docManager);
 
     constructor(workspacePath: string, options: SvelteCheckOptions = {}) {
         Logger.setLogErrorsOnly(true);
@@ -36,7 +36,7 @@ export class SvelteCheck {
         });
         // No HTMLPlugin, it does not provide diagnostics
         if (shouldRegister('svelte')) {
-            this.pluginHost.register(new SveltePlugin(this.configManager, {}));
+            this.pluginHost.register(new SveltePlugin(this.configManager));
         }
         if (shouldRegister('css')) {
             this.pluginHost.register(new CSSPlugin(this.docManager, this.configManager));
diff --git a/packages/language-server/test/plugins/PluginHost.test.ts b/packages/language-server/test/plugins/PluginHost.test.ts
diff --git a/packages/language-server/test/plugins/svelte/SveltePlugin.test.ts b/packages/language-server/test/plugins/svelte/SveltePlugin.test.ts
diff --git a/packages/language-server/test/plugins/typescript/features/preferences.test.ts b/packages/language-server/test/plugins/typescript/features/preferences.test.ts
