Use protocol.UserPreferences in server to store UserPreferences

sheetalkamat · sheetalkamat · commit 03bb5d170ec7 · 2018-08-28T15:53:00.000-07:00
diff --git a/src/server/editorServices.ts b/src/server/editorServices.ts
@@ -1,9 +1,3 @@
-namespace ts {
-    export interface UserPreferences {
-        readonly lazyConfiguredProjectsFromExternalProject?: boolean;
-    }
-}
-
 namespace ts.server {
     export const maxProgramSizeForNonTsFiles = 20 * 1024 * 1024;
     /*@internal*/
@@ -224,9 +218,15 @@ namespace ts.server {
         }
     }
 
+    /*@internal*/
+    export function convertUserPreferences(preferences: protocol.UserPreferences): UserPreferences {
+        const { lazyConfiguredProjectsFromExternalProject, ...userPreferences } = preferences;
+        return userPreferences;
+    }
+
     export interface HostConfiguration {
         formatCodeOptions: FormatCodeSettings;
-        preferences: UserPreferences;
+        preferences: protocol.UserPreferences;
         hostInfo: string;
         extraFileExtensions?: FileExtensionInfo[];
     }
@@ -808,7 +808,7 @@ namespace ts.server {
             return info && info.getFormatCodeSettings() || this.hostConfiguration.formatCodeOptions;
         }
 
-        getPreferences(file: NormalizedPath): UserPreferences {
+        getPreferences(file: NormalizedPath): protocol.UserPreferences {
             const info = this.getScriptInfoForNormalizedPath(file);
             return info && info.getPreferences() || this.hostConfiguration.preferences;
         }
@@ -817,7 +817,7 @@ namespace ts.server {
             return this.hostConfiguration.formatCodeOptions;
         }
 
-        getHostPreferences(): UserPreferences {
+        getHostPreferences(): protocol.UserPreferences {
             return this.hostConfiguration.preferences;
         }
 
diff --git a/src/server/scriptInfo.ts b/src/server/scriptInfo.ts
@@ -234,7 +234,7 @@ namespace ts.server {
          */
         readonly containingProjects: Project[] = [];
         private formatSettings: FormatCodeSettings | undefined;
-        private preferences: UserPreferences | undefined;
+        private preferences: protocol.UserPreferences | undefined;
 
         /* @internal */
         fileWatcher: FileWatcher | undefined;
@@ -333,7 +333,7 @@ namespace ts.server {
         }
 
         getFormatCodeSettings(): FormatCodeSettings | undefined { return this.formatSettings; }
-        getPreferences(): UserPreferences | undefined { return this.preferences; }
+        getPreferences(): protocol.UserPreferences | undefined { return this.preferences; }
 
         attachToProject(project: Project): boolean {
             const isNew = !this.isAttached(project);
@@ -432,7 +432,7 @@ namespace ts.server {
             }
         }
 
-        setOptions(formatSettings: FormatCodeSettings, preferences: UserPreferences | undefined): void {
+        setOptions(formatSettings: FormatCodeSettings, preferences: protocol.UserPreferences | undefined): void {
             if (formatSettings) {
                 if (!this.formatSettings) {
                     this.formatSettings = getDefaultFormatCodeSettings(this.host);
diff --git a/src/server/session.ts b/src/server/session.ts
@@ -1423,7 +1423,7 @@ namespace ts.server {
             const position = this.getPosition(args, scriptInfo);
 
             const completions = project.getLanguageService().getCompletionsAtPosition(file, position, {
-                ...this.getPreferences(file),
+                ...convertUserPreferences(this.getPreferences(file)),
                 triggerCharacter: args.triggerCharacter,
                 includeExternalModuleExports: args.includeExternalModuleExports,
                 includeInsertTextCompletions: args.includeInsertTextCompletions
@@ -2352,15 +2352,15 @@ namespace ts.server {
             return this.projectService.getFormatCodeOptions(file);
         }
 
-        private getPreferences(file: NormalizedPath): UserPreferences {
+        private getPreferences(file: NormalizedPath): protocol.UserPreferences {
             return this.projectService.getPreferences(file);
         }
 
         private getHostFormatOptions(): FormatCodeSettings {
             return this.projectService.getHostFormatCodeOptions();
         }
 
-        private getHostPreferences(): UserPreferences {
+        private getHostPreferences(): protocol.UserPreferences {
             return this.projectService.getHostPreferences();
         }
     }
diff --git a/tests/baselines/reference/api/tsserverlibrary.d.ts b/tests/baselines/reference/api/tsserverlibrary.d.ts
@@ -7929,14 +7929,14 @@ declare namespace ts.server {
         getSnapshot(): IScriptSnapshot;
         private ensureRealPath;
         getFormatCodeSettings(): FormatCodeSettings | undefined;
-        getPreferences(): UserPreferences | undefined;
+        getPreferences(): protocol.UserPreferences | undefined;
         attachToProject(project: Project): boolean;
         isAttached(project: Project): boolean;
         detachFromProject(project: Project): void;
         detachAllProjects(): void;
         getDefaultProject(): Project;
         registerFileUpdate(): void;
-        setOptions(formatSettings: FormatCodeSettings, preferences: UserPreferences | undefined): void;
+        setOptions(formatSettings: FormatCodeSettings, preferences: protocol.UserPreferences | undefined): void;
         getLatestVersion(): string;
         saveTo(fileName: string): void;
         reloadFromFile(tempFileName?: NormalizedPath): boolean;
@@ -8201,11 +8201,6 @@ declare namespace ts.server {
         setTypeAcquisition(newTypeAcquisition: TypeAcquisition): void;
     }
 }
-declare namespace ts {
-    interface UserPreferences {
-        readonly lazyConfiguredProjectsFromExternalProject?: boolean;
-    }
-}
 declare namespace ts.server {
     const maxProgramSizeForNonTsFiles: number;
     const ProjectsUpdatedInBackgroundEvent = "projectsUpdatedInBackground";
@@ -8319,7 +8314,7 @@ declare namespace ts.server {
     function convertScriptKindName(scriptKindName: protocol.ScriptKindName): ScriptKind.Unknown | ScriptKind.JS | ScriptKind.JSX | ScriptKind.TS | ScriptKind.TSX;
     interface HostConfiguration {
         formatCodeOptions: FormatCodeSettings;
-        preferences: UserPreferences;
+        preferences: protocol.UserPreferences;
         hostInfo: string;
         extraFileExtensions?: FileExtensionInfo[];
     }
@@ -8438,9 +8433,9 @@ declare namespace ts.server {
          */
         private ensureProjectStructuresUptoDate;
         getFormatCodeOptions(file: NormalizedPath): FormatCodeSettings;
-        getPreferences(file: NormalizedPath): UserPreferences;
+        getPreferences(file: NormalizedPath): protocol.UserPreferences;
         getHostFormatCodeOptions(): FormatCodeSettings;
-        getHostPreferences(): UserPreferences;
+        getHostPreferences(): protocol.UserPreferences;
         private onSourceFileChanged;
         private handleDeletedFile;
         private onConfigChangedForConfiguredProject;

Original file line number	Diff line number	Diff line change
`@@ -1,9 +1,3 @@`
`1`		`-namespace ts {`
`2`		`- export interface UserPreferences {`
`3`		`- readonly lazyConfiguredProjectsFromExternalProject?: boolean;`
`4`		`- }`
`5`		`-}`
`6`		`-`
`7`	`1`	`namespace ts.server {`
`8`	`2`	`export const maxProgramSizeForNonTsFiles = 20 * 1024 * 1024;`
`9`	`3`	`/@internal/`
`@@ -224,9 +218,15 @@ namespace ts.server {`
`224`	`218`	`}`
`225`	`219`	`}`
`226`	`220`
	`221`	`+ /@internal/`
	`222`	`+ export function convertUserPreferences(preferences: protocol.UserPreferences): UserPreferences {`
	`223`	`+ const { lazyConfiguredProjectsFromExternalProject, ...userPreferences } = preferences;`
	`224`	`+ return userPreferences;`
	`225`	`+ }`
	`226`	`+`
`227`	`227`	`export interface HostConfiguration {`
`228`	`228`	`formatCodeOptions: FormatCodeSettings;`
`229`		`- preferences: UserPreferences;`
	`229`	`+ preferences: protocol.UserPreferences;`
`230`	`230`	`hostInfo: string;`
`231`	`231`	`extraFileExtensions?: FileExtensionInfo[];`
`232`	`232`	`}`
`@@ -808,7 +808,7 @@ namespace ts.server {`
`808`	`808`	`return info && info.getFormatCodeSettings() \|\| this.hostConfiguration.formatCodeOptions;`
`809`	`809`	`}`
`810`	`810`
`811`		`- getPreferences(file: NormalizedPath): UserPreferences {`
	`811`	`+ getPreferences(file: NormalizedPath): protocol.UserPreferences {`
`812`	`812`	`const info = this.getScriptInfoForNormalizedPath(file);`
`813`	`813`	`return info && info.getPreferences() \|\| this.hostConfiguration.preferences;`
`814`	`814`	`}`
`@@ -817,7 +817,7 @@ namespace ts.server {`
`817`	`817`	`return this.hostConfiguration.formatCodeOptions;`
`818`	`818`	`}`
`819`	`819`
`820`		`- getHostPreferences(): UserPreferences {`
	`820`	`+ getHostPreferences(): protocol.UserPreferences {`
`821`	`821`	`return this.hostConfiguration.preferences;`
`822`	`822`	`}`
`823`	`823`
Original file line number	Diff line number	Diff line change
`@@ -1423,7 +1423,7 @@ namespace ts.server {`
`1423`	`1423`	`const position = this.getPosition(args, scriptInfo);`
`1424`	`1424`
`1425`	`1425`	`const completions = project.getLanguageService().getCompletionsAtPosition(file, position, {`
`1426`		`- ...this.getPreferences(file),`
	`1426`	`+ ...convertUserPreferences(this.getPreferences(file)),`
`1427`	`1427`	`triggerCharacter: args.triggerCharacter,`
`1428`	`1428`	`includeExternalModuleExports: args.includeExternalModuleExports,`
`1429`	`1429`	`includeInsertTextCompletions: args.includeInsertTextCompletions`
`@@ -2352,15 +2352,15 @@ namespace ts.server {`
`2352`	`2352`	`return this.projectService.getFormatCodeOptions(file);`
`2353`	`2353`	`}`
`2354`	`2354`
`2355`		`- private getPreferences(file: NormalizedPath): UserPreferences {`
	`2355`	`+ private getPreferences(file: NormalizedPath): protocol.UserPreferences {`
`2356`	`2356`	`return this.projectService.getPreferences(file);`
`2357`	`2357`	`}`
`2358`	`2358`
`2359`	`2359`	`private getHostFormatOptions(): FormatCodeSettings {`
`2360`	`2360`	`return this.projectService.getHostFormatCodeOptions();`
`2361`	`2361`	`}`
`2362`	`2362`
`2363`		`- private getHostPreferences(): UserPreferences {`
	`2363`	`+ private getHostPreferences(): protocol.UserPreferences {`
`2364`	`2364`	`return this.projectService.getHostPreferences();`
`2365`	`2365`	`}`
`2366`	`2366`	`}`