igwejk/improve logs (#140)

* Improve consistency of logging

* Setup facilitation for development and debugging

* Improve logging in worker.ts

.vscode/launch.json

@@ -0,0 +1,18 @@
+{
+  // Use IntelliSense to learn about possible attributes.
+  // Hover to view descriptions of existing attributes.
+  // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "runtimeExecutable": "/Users/igwejk/.nvm/versions/node/v20.11.0/bin/node",
+      "type": "node",
+      "request": "launch",
+      "name": "Debug",
+      "skipFiles": ["<node_internals>/**"],
+      "program": "${workspaceFolder}/src/enable.ts",
+      "preLaunchTask": "tsc: build - tsconfig.json",
+      "outFiles": ["${workspaceFolder}/lib/**/*.js"]
+    }
+  ]
+}

package.json

@@ -14,7 +14,8 @@
     "getRepos": "node ./lib/getRepos.js",
     "getOrgs": "node ./lib/getOrgs.js",
     "enableOrg": "node ./lib/enableOrg.js",
-    "start": "npm run build && node ./lib/enable.js"
+    "start": "npm run build && node ./lib/enable.js",
+    "start:debug": "npx ts-node ./src/enable.ts"
   },
   "keywords": [
     "GitHub",

src/utils/clients/auth.ts

@@ -1,4 +1,5 @@
 import { createAppAuth, StrategyOptions } from "@octokit/auth-app";
+import { error, inform } from "../globals";
 
 import { env } from "process";
 
@@ -24,10 +25,10 @@ export const auth = async (): Promise<string | Error> => {
   const auth = createAppAuth(options);
   try {
     const data = await auth({ type: "installation" });
-    console.log(data);
+    inform(data);
     return data.token;
   } catch (err: any) {
-    console.error("Error within function (githubAuth)", err.message);
+    error("\n", "Error within function (githubAuth)", err.message);
     throw new Error(
       "We failed to generate a token from the credentials provided on the GitHub App. Please re-check the credentails provided.",
     );

src/utils/getOrganisationsInEnterprise.ts

@@ -32,7 +32,7 @@ const performOrganisationsQuery = async (
     })) as GraphQlQueryResponseData;
     return [hasNextPage, endCursor, nodes];
   } catch (err) {
-    console.error(err);
+    error("\n", err);
     throw err;
   }
 };
@@ -90,7 +90,7 @@ export const index = async (client: Octokit): Promise<void> => {
     const data = await getOrganisationsInEnterprise(client, slug, query);
     await createFile(data, orgsFileLocation);
   } catch (err) {
-    console.error(err);
+    error("\n", err);
     throw err;
   }
 };

src/utils/worker.ts

@@ -5,15 +5,16 @@ import { Octokit } from "@octokit/core";
 
 import { enableFeaturesForRepository } from "./enableFeaturesForRepository";
 import { client as octokit, auth as generateAuth } from "./clients";
-import { inform, reposFileLocation } from "./globals.js";
-import { reposFile } from "../../types/common/index.js";
+import { error, inform, reposFileLocation } from "./globals";
+import { reposFile } from "../../types/common";
 
-export const worker = async (): Promise<unknown> => {
-  let res;
+export const worker = async (): Promise<undefined> => {
   let orgIndex: number;
   let repoIndex: number;
   let repos: reposFile;
   let file: string;
+  let repoCount: number = 0;
+  let errorCount: number = 0;
 
   const client = (await octokit()) as Octokit;
 
@@ -27,7 +28,7 @@ export const worker = async (): Promise<unknown> => {
     }
     repos = JSON.parse(file);
   } catch (err) {
-    console.error(err);
+    error("\n", err);
     throw new Error(
       "We did not find your repos.json file, please run `yarn run getRepos` to collect the repos to run this script on.",
     );
@@ -47,15 +48,22 @@ export const worker = async (): Promise<unknown> => {
       );
 
       try {
+        ++repoCount;
         await enableFeaturesForRepository({
           repository: repos[orgIndex].repos[repoIndex],
           client,
           generateAuth,
         });
       } catch (err) {
-        // boo
+        ++errorCount;
+        error("\n", err);
       }
     }
   }
-  return res;
+
+  if (errorCount > 0) {
+    throw new Error(
+      `\nProcessed a total of ${repoCount} repositories, encountered errors for ${errorCount} out of the total ${repoCount} repositories.`,
+    );
+  }
 };

tsconfig.json

@@ -4,11 +4,16 @@
   "exclude": ["lib", "node_modules"],
   "compilerOptions": {
     "typeRoots": ["./types", "node_modules/@types"],
+    "strict": true,
     "outDir": "./lib",
+    "rootDir": "./src",
+    "target": "ES2017",
+    "sourceMap": true,
     "noUnusedLocals": true,
     "noUnusedParameters": true,
     "removeComments": true,
     "preserveConstEnums": true,
     "resolveJsonModule": true,
+    "esModuleInterop": true,
   },
 }