Extra types

Author: jablko

src/pr-info.ts

@@ -181,6 +181,12 @@ export async function queryPRInfo(prNumber: number) {
     });
 }
 
+interface Refs {
+    readonly head: string;
+    readonly master: "master";
+    readonly latestSuggestions: string;
+}
+
 // The GQL response => Useful data for us
 export async function deriveStateForPR(
     info: ApolloQueryResult<PRQueryResult>,
@@ -218,7 +224,7 @@ export async function deriveStateForPR(
                 !latest?.submittedAt || review.submittedAt && new Date (review.submittedAt) > new Date(latest.submittedAt)
                 || review.commit?.oid === headCommit.oid)
                     ? review : latest, null)?.commit?.oid,
-    };
+    } as const;
     const pkgInfoEtc = await getPackageInfosEtc(
         noNulls(prInfo.files?.nodes).map(f => f.path).sort(),
         refs, fetchFile, async name => await getDownloads(name, lastPushDate));
@@ -319,11 +325,11 @@ function getLastMaintainerBlessingDate(timelineItems: PR_repository_pullRequest_
 }
 
 async function getPackageInfosEtc(
-    paths: string[], refs: { [ref: string]: string }, fetchFile: typeof defaultFetchFile, getDownloads: typeof getMonthlyDownloadCount
+    paths: string[], refs: Refs, fetchFile: typeof defaultFetchFile, getDownloads: typeof getMonthlyDownloadCount
 ): Promise<{pkgInfo: PackageInfo[], popularityLevel: PopularityLevel} | Error> {
     const infos = new Map<string|null, FileInfo[]>();
     for (const path of paths) {
-        const [pkg, fileInfo] = await categorizeFile(path, async (ref: string) => fetchFile(`${refs[ref]}:${path}`));
+        const [pkg, fileInfo] = await categorizeFile(path, async ref => fetchFile(`${refs[ref]}:${path}`));
         if (!infos.has(pkg)) infos.set(pkg, []);
         infos.get(pkg)!.push(fileInfo);
     }
@@ -354,7 +360,9 @@ async function getPackageInfosEtc(
     return { pkgInfo: result, popularityLevel: downloadsToPopularityLevel(maxDownloads) };
 }
 
-async function categorizeFile(path: string, getContents: (ref: string) => Promise<string | undefined>): Promise<[string|null, FileInfo]> {
+type GetContents = (ref: keyof Refs) => Promise<string | undefined>;
+
+async function categorizeFile(path: string, getContents: GetContents): Promise<[string|null, FileInfo]> {
     // https://regex101.com/r/eFvtrz/1
     const match = /^types\/(.*?)\/.*?[^\/](?:\.(d\.ts|tsx?|md))?$/.exec(path);
     if (!match) return [null, { path, kind: "infrastructure" }];
@@ -370,8 +378,8 @@ async function categorizeFile(path: string, getContents: (ref: string) => Promis
 }
 
 interface ConfigSuspicious {
-    (path: string, getContents: (ref: string) => Promise<string | undefined>): Promise<{ suspect: string, sugestion?: Suggestion } | undefined>;
-    [basename: string]: (newText: string, getContents: (ref: string) => Promise<string | undefined>) => Promise<{ suspect: string, suggestion?: Suggestion } | undefined>;
+    (path: string, getContents: GetContents): Promise<{ suspect: string, sugestion?: Suggestion } | undefined>;
+    [basename: string]: (newText: string, getContents: GetContents) => Promise<{ suspect: string, suggestion?: Suggestion } | undefined>;
 };
 const configSuspicious = <ConfigSuspicious>(async (path, getContents) => {
     const basename = path.replace(/.*\//, "");
@@ -414,7 +422,7 @@ configSuspicious["tsconfig.json"] = makeJsonCheckerFromCore(
 // to it, ignoring some keys (JSON Patch paths).  The ignored properties are in most cases checked
 // elsewhere (dtslint), and in some cases they are irrelevant.
 function makeJsonCheckerFromCore(requiredForm: any, ignoredKeys: string[]) {
-    return async (newText: string, getContents: (ref: string) => Promise<string | undefined>) => {
+    return async (newText: string, getContents: GetContents) => {
         let suggestion: any;
         try { suggestion = JSON.parse(newText); } catch (e) { return { suspect: "couldn't parse json" }; }
         const newJson = jsonDiff.deepClone(suggestion);
@@ -435,7 +443,7 @@ function makeJsonCheckerFromCore(requiredForm: any, ignoredKeys: string[]) {
         };
 
         // Apply any preexisting diffs to towardsIt
-        async function ignoreExistingDiffs(ref: string) {
+        async function ignoreExistingDiffs(ref: keyof Refs) {
             const diffFromReq = (json: any) => jsonDiff.compare(towardsIt, json);
             const newDiff = diffFromReq(newJson);
             if (newDiff.length === 0) return undefined;