More TS

lib/build.js

@@ -204,10 +204,7 @@ I can help set you up with an initial configuration if you run ${chalk.magenta('
  */
 async function buildFromGitHubTemplate(options, template) {
   Spinner.setText('Fetching template information');
-  const commit = await RemoteTemplate.getRelevantCommit(
-    options,
-    options.template
-  );
+  const commit = await RemoteTemplate.getRelevantCommit(options, template);
   const reviewElmJson = await RemoteTemplate.getRemoteElmJson(
     options,
     template,

lib/remote-template.js

@@ -18,6 +18,8 @@ const TemplateDependencies = require('./template-dependencies');
 // GET LATEST INFORMATION ABOUT REPOSITORY
 
 /**
+ * @param {Options} options
+ * @param {Template} template
  * @returns {Promise<string>}
  */
 async function getRelevantCommit(options, template) {
@@ -36,33 +38,42 @@ async function getRelevantCommit(options, template) {
 
 /**
  * @returns {Promise<string>}
+ * @param {Options} options
+ * @param {Template} template
  */
 async function findDefaultBranch(options, template) {
   Debug.log('Fetching default branch');
-  const body = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${template.repoName}`,
-    () => repoNotFoundErrorMessage(template.repoName)
+  const body = /** @type {{default_branch: string}} */ (
+    await makeGitHubApiRequest(
+      options,
+      `https://api.github.com/repos/${template.repoName}`,
+      () => repoNotFoundErrorMessage(template.repoName)
+    )
   );
   return body.default_branch;
 }
 
 /**
  * @returns {Promise<string>}
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} reference
  */
 async function getLatestCommitForReference(options, template, reference) {
   Debug.log(`Fetching commit ${reference}`);
-  const body = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${template.repoName}/commits/${reference}`,
-    (responseBody) => {
-      if (responseBody.message === 'Not Found') {
-        // This error means that the repo itself was not found
-        return repoNotFoundErrorMessage(template.repoName);
-      }
+  const body = /** @type {{sha: string}} */ (
+    await makeGitHubApiRequest(
+      options,
+      `https://api.github.com/repos/${template.repoName}/commits/${reference}`,
+      (responseBody) => {
+        if (responseBody.message === 'Not Found') {
+          // This error means that the repo itself was not found
+          return repoNotFoundErrorMessage(template.repoName);
+        }
 
-      return commitNotFoundErrorMessage(template.repoName, reference);
-    }
+        return commitNotFoundErrorMessage(template.repoName, reference);
+      }
+    )
   );
   return body.sha;
 }
@@ -108,6 +119,10 @@ async function getRemoteElmJson(
   return TemplateDependencies.update(options, elmJson);
 }
 
+/**
+ * @param {Template} template
+ * @param {string} commit
+ */
 async function downloadTemplateElmJson(template, commit) {
   const {repoName, pathToFolder} = template;
   const pathToFolderAsUrl = pathToFolder ? `/${pathToFolder}` : '';
@@ -165,6 +180,9 @@ elm-review in your project:
     elm-review init --template <some-configuration>`
 };
 
+/**
+ * @param {string} repoName
+ */
 function repoNotFoundErrorMessage(repoName) {
   return {
     title: 'REPOSITORY NOT FOUND',
@@ -176,6 +194,10 @@ with private ones at the moment.`
   };
 }
 
+/**
+ * @param {unknown} repoName
+ * @param {unknown} reference
+ */
 function commitNotFoundErrorMessage(repoName, reference) {
   return {
     title: 'BRANCH OR COMMIT NOT FOUND',
@@ -189,6 +211,13 @@ Check the spelling and make sure it has been pushed.`
 
 // DOWNLOAD TEMPLATE FILES
 
+/**
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} commit
+ * @param {string} basePath
+ * @param {ApplicationElmJson} reviewElmJson
+ */
 async function downloadSourceDirectories(
   options,
   template,
@@ -209,6 +238,13 @@ async function downloadSourceDirectories(
   );
 }
 
+/**
+ * @param {Options} options
+ * @param {Template} template
+ * @param {string} commit
+ * @param {string} basePath
+ * @param {string} directory
+ */
 async function downloadDirectory(
   options,
   template,
@@ -220,12 +256,15 @@ async function downloadDirectory(
   const destinationDirectory = directory.split('..').join('parent');
 
   await FS.mkdirp(path.join(basePath, destinationDirectory));
-  const fileListing = await makeGitHubApiRequest(
-    options,
-    `https://api.github.com/repos/${repoName}/contents${pathToFolder}/${directory}?ref=${commit}`
-      .split('//')
-      .join('/')
-  );
+  const fileListing =
+    /** @type {({ type: string; name: string; download_url: string; })[]} */ (
+      await makeGitHubApiRequest(
+        options,
+        `https://api.github.com/repos/${repoName}/contents${pathToFolder}/${directory}?ref=${commit}`
+          .split('//')
+          .join('/')
+      )
+    );
 
   await Promise.all(
     fileListing.map(async (fileOrDir) => {
@@ -283,7 +322,7 @@ async function downloadFile(url, dest) {
  * @param {Options} options
  * @param {string} url
  * @param {((arg: JsonResponse) => {title: string, message: string})} [handleNotFound]
- * @returns {Promise<object>}
+ * @returns {Promise<unknown>}
  */
 async function makeGitHubApiRequest(options, url, handleNotFound) {
   /** @type {OptionsOfJSONResponseBody}} */

tsconfig.no-implicit-any.json

@@ -34,6 +34,7 @@
     "lib/project-dependencies.js",
     "lib/project-json-files.js",
     "lib/promisify-port.js",
+    "lib/remote-template.js",
     "lib/report.js",
     "lib/result-cache.js",
     "lib/result-cache-json.js",