Allow plugins to provide a list of external files.

chuckjaz · chuckjaz · commit 785c281fd6ce · 2017-04-25T10:11:05.000-07:00
The list of the plugin's external files and request made to
a file in the list will be routed to an instance of the plugin.
diff --git a/src/server/project.ts b/src/server/project.ts
@@ -112,6 +112,7 @@ namespace ts.server {
         private rootFiles: ScriptInfo[] = [];
         private rootFilesMap: FileMap<ScriptInfo> = createFileMap<ScriptInfo>();
         private program: ts.Program;
+        private externalFiles: SortedReadonlyArray<string>;
 
         private cachedUnresolvedImportsPerFile = new UnresolvedImportsMap();
         private lastCachedUnresolvedImportsList: SortedReadonlyArray<string>;
@@ -267,8 +268,8 @@ namespace ts.server {
         abstract getProjectRootPath(): string | undefined;
         abstract getTypeAcquisition(): TypeAcquisition;
 
-        getExternalFiles(): string[] {
-            return [];
+        getExternalFiles(): SortedReadonlyArray<string> {
+            return emptyArray as SortedReadonlyArray<string>;
         }
 
         getSourceFile(path: Path) {
@@ -567,6 +568,24 @@ namespace ts.server {
                     }
                 }
             }
+
+            const oldExternalFiles = this.externalFiles || emptyArray as SortedReadonlyArray<string>;
+            this.externalFiles = this.getExternalFiles();
+            enumerateInsertsAndDeletes(this.externalFiles, oldExternalFiles,
+                // Ensure a ScriptInfo is created for new external files. This is performed indirectly
+                // by the LSHost for files in the program when the program is retrieved above but
+                // the program doesn't contain external files so this must be done explicitly.
+                inserted => {
+                    const scriptInfo = this.projectService.getOrCreateScriptInfo(inserted, /*openedByClient*/ false);
+                    scriptInfo.attachToProject(this);
+                },
+                removed => {
+                    const scriptInfoToDetach = this.projectService.getScriptInfo(removed);
+                    if (scriptInfoToDetach) {
+                        scriptInfoToDetach.detachFromProject(this);
+                    }
+                });
+
             return hasChanges;
         }
 
@@ -947,7 +966,7 @@ namespace ts.server {
             return this.typeAcquisition;
         }
 
-        getExternalFiles(): string[] {
+        getExternalFiles(): SortedReadonlyArray<string> {
             const items: string[] = [];
             for (const plugin of this.plugins) {
                 if (typeof plugin.getExternalFiles === "function") {
@@ -959,7 +978,7 @@ namespace ts.server {
                     }
                 }
             }
-            return items;
+            return toSortedReadonlyArray(items);
         }
 
         watchConfigFile(callback: (project: ConfiguredProject) => void) {
diff --git a/src/server/utilities.ts b/src/server/utilities.ts
@@ -192,6 +192,37 @@ namespace ts.server {
         return <any>arr;
     }
 
+    export function enumerateInsertsAndDeletes<T>(a: SortedReadonlyArray<T>, b: SortedReadonlyArray<T>, inserted: (item: T) => void, deleted: (item: T) => void, compare?: (a: T, b: T) => Comparison) {
+        compare = compare || ts.compareValues;
+        let aIndex = 0;
+        let bIndex = 0;
+        const aLen = a.length;
+        const bLen = b.length;
+        while (aIndex < aLen && bIndex < bLen) {
+            const aItem = a[aIndex];
+            const bItem = b[bIndex];
+            const compareResult = compare(aItem, bItem);
+            if (compareResult === Comparison.LessThan) {
+                inserted(aItem);
+                aIndex++;
+            }
+            else if (compareResult === Comparison.GreaterThan) {
+                deleted(bItem);
+                bIndex++;
+            }
+            else {
+                aIndex++;
+                bIndex++;
+            }
+        }
+        while (aIndex < aLen) {
+            inserted(a[aIndex++]);
+        }
+        while (bIndex < bLen) {
+            deleted(b[bIndex++]);
+        }
+    }
+
     export class ThrottledOperations {
         private pendingTimeouts: Map<any> = createMap<any>();
         constructor(private readonly host: ServerHost) {

Original file line number	Diff line number	Diff line change
`@@ -112,6 +112,7 @@ namespace ts.server {`
`112`	`112`	`private rootFiles: ScriptInfo[] = [];`
`113`	`113`	`private rootFilesMap: FileMap<ScriptInfo> = createFileMap<ScriptInfo>();`
`114`	`114`	`private program: ts.Program;`
	`115`	`+ private externalFiles: SortedReadonlyArray<string>;`
`115`	`116`
`116`	`117`	`private cachedUnresolvedImportsPerFile = new UnresolvedImportsMap();`
`117`	`118`	`private lastCachedUnresolvedImportsList: SortedReadonlyArray<string>;`
`@@ -267,8 +268,8 @@ namespace ts.server {`
`267`	`268`	`abstract getProjectRootPath(): string \| undefined;`
`268`	`269`	`abstract getTypeAcquisition(): TypeAcquisition;`
`269`	`270`
`270`		`- getExternalFiles(): string[] {`
`271`		`- return [];`
	`271`	`+ getExternalFiles(): SortedReadonlyArray<string> {`
	`272`	`+ return emptyArray as SortedReadonlyArray<string>;`
`272`	`273`	`}`
`273`	`274`
`274`	`275`	`getSourceFile(path: Path) {`
`@@ -567,6 +568,24 @@ namespace ts.server {`
`567`	`568`	`}`
`568`	`569`	`}`
`569`	`570`	`}`
	`571`	`+`
	`572`	`+ const oldExternalFiles = this.externalFiles \|\| emptyArray as SortedReadonlyArray<string>;`
	`573`	`+ this.externalFiles = this.getExternalFiles();`
	`574`	`+ enumerateInsertsAndDeletes(this.externalFiles, oldExternalFiles,`
	`575`	`+ // Ensure a ScriptInfo is created for new external files. This is performed indirectly`
	`576`	`+ // by the LSHost for files in the program when the program is retrieved above but`
	`577`	`+ // the program doesn't contain external files so this must be done explicitly.`
	`578`	`+ inserted => {`
	`579`	`+ const scriptInfo = this.projectService.getOrCreateScriptInfo(inserted, /openedByClient/ false);`
	`580`	`+ scriptInfo.attachToProject(this);`
	`581`	`+ },`
	`582`	`+ removed => {`
	`583`	`+ const scriptInfoToDetach = this.projectService.getScriptInfo(removed);`
	`584`	`+ if (scriptInfoToDetach) {`
	`585`	`+ scriptInfoToDetach.detachFromProject(this);`
	`586`	`+ }`
	`587`	`+ });`
	`588`	`+`
`570`	`589`	`return hasChanges;`
`571`	`590`	`}`
`572`	`591`
`@@ -947,7 +966,7 @@ namespace ts.server {`
`947`	`966`	`return this.typeAcquisition;`
`948`	`967`	`}`
`949`	`968`
`950`		`- getExternalFiles(): string[] {`
	`969`	`+ getExternalFiles(): SortedReadonlyArray<string> {`
`951`	`970`	`const items: string[] = [];`
`952`	`971`	`for (const plugin of this.plugins) {`
`953`	`972`	`if (typeof plugin.getExternalFiles === "function") {`
`@@ -959,7 +978,7 @@ namespace ts.server {`
`959`	`978`	`}`
`960`	`979`	`}`
`961`	`980`	`}`
`962`		`- return items;`
	`981`	`+ return toSortedReadonlyArray(items);`
`963`	`982`	`}`
`964`	`983`
`965`	`984`	`watchConfigFile(callback: (project: ConfiguredProject) => void) {`