fix: use ts-dedent

nix-community · Dec 5, 2023 · d952be2 · d952be2
1 parent f8b4795
commit d952be2
Show file tree

Hide file tree

Showing 8 changed files with 45 additions and 26 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -28,7 +28,8 @@
     "@actions/core": "^1.10.0",
     "@actions/exec": "^1.1.1",
     "@actions/github": "^5.1.1",
-    "@actions/io": "^1.1.2"
+    "@actions/io": "^1.1.2",
+    "ts-dedent": "^2.2.0"
   },
   "devDependencies": {
     "@types/jest": "^27.5.2",

diff --git a/src/gc.ts b/src/gc.ts
@@ -1,11 +1,10 @@
-import * as core from "@actions/core";
 import { exec } from "@actions/exec";
 
 import { Inputs } from "./constants";
 import * as utils from "./utils/actionUtils";
 
 export async function collectGarbage() {
-    core.info("Collecting garbage");
+    utils.info("Collecting garbage");
 
     await exec("bash", ["-c", "sudo rm -rf /nix/.[!.]* /nix/..?*"]);
 

diff --git a/src/purge.ts b/src/purge.ts
@@ -19,7 +19,7 @@ async function purgeByTime({
 
     const maxDate = utils.getMaxDate({ doUseLastAccessedTime, time });
 
-    core.info(
+    utils.info(
         `
         ${
             lookupOnly ? "Searching for" : "Purging"
@@ -36,7 +36,7 @@ async function purgeByTime({
         maxDate
     });
 
-    core.info(
+    utils.info(
         `
         Found ${caches.length} cache(s):
         ${utils.stringify(caches)}
@@ -57,7 +57,7 @@ async function purgeByTime({
             const atDate = new Date(at);
             const atDatePretty = atDate.toISOString();
             if (atDate < maxDate) {
-                core.info(
+                utils.info(
                     `Deleting the cache having the key '${cache.key}' and ${verb} at ${atDatePretty}`
                 );
 
@@ -69,7 +69,7 @@ async function purgeByTime({
                         cache_id: cache.id
                     });
                 } catch (error) {
-                    core.info(
+                    utils.info(
                         `
                         Failed to delete cache ${cache.key}
                         
@@ -78,7 +78,7 @@ async function purgeByTime({
                     );
                 }
             } else {
-                core.info(
+                utils.info(
                     `Skipping the cache having the key '${cache.key}' and ${verb} at ${atDatePretty}`
                 );
             }

diff --git a/src/restoreExtraCaches.ts b/src/restoreExtraCaches.ts
@@ -12,7 +12,7 @@ export async function restoreExtraCaches() {
 
     const token = core.getInput(Inputs.Token, { required: true });
 
-    core.info(
+    utils.info(
         `
         Restoring extra caches with keys:
         ${utils.stringify(extraRestoreKeys)}
@@ -21,7 +21,7 @@ export async function restoreExtraCaches() {
 
     const results = await utils.getCachesByKeys(token, extraRestoreKeys);
 
-    core.info(
+    utils.info(
         `
         Found ${results.length} cache(s):
         ${utils.stringify(results)}
@@ -31,7 +31,7 @@ export async function restoreExtraCaches() {
     const cachePaths = utils.paths;
 
     results.forEach(async cache => {
-        core.info(`Restoring a cache with the key ${cache.key}`);
+        utils.info(`Restoring a cache with the key ${cache.key}`);
 
         if (cache.key !== undefined) {
             const restoreKey = await utils.getCacheKey({
@@ -42,7 +42,7 @@ export async function restoreExtraCaches() {
             });
 
             if (restoreKey) {
-                core.info(`Restored a cache with the key ${cache.key}`);
+                utils.info(`Restored a cache with the key ${cache.key}`);
             }
         }
     });

diff --git a/src/restoreImpl.ts b/src/restoreImpl.ts
@@ -6,9 +6,9 @@ import { IStateProvider } from "./stateProvider";
 import * as utils from "./utils/actionUtils";
 
 export async function restoreWithKey(key: string, paths: string[]) {
-    core.info(`Restoring a cache with the key "${key}"...`);
+    utils.info(`Restoring a cache with the key "${key}"...`);
 
-    core.info(
+    utils.info(
         `::group::Logs while restoring. Errors are due to attempts to overwrite read-only paths.`
     );
 
@@ -19,9 +19,9 @@ export async function restoreWithKey(key: string, paths: string[]) {
         lookupOnly: false
     });
 
-    core.info(`::endgroup::`);
+    utils.info(`::endgroup::`);
 
-    core.info(`Finished restoring a cache with the key "${key}"...`);
+    utils.info(`Finished restoring a cache with the key "${key}"...`);
 }
 
 async function restoreImpl(
@@ -50,7 +50,7 @@ async function restoreImpl(
         const failOnCacheMiss = utils.getInputAsBool(Inputs.FailOnCacheMiss);
         const restoreKeyHit = utils.getInputAsBool(Inputs.RestoreKeyHit);
 
-        core.info(`Searching for a cache with the key "${primaryKey}"...`);
+        utils.info(`Searching for a cache with the key "${primaryKey}"...`);
 
         let cacheKey = await utils.getCacheKey({
             paths: cachePaths,
@@ -62,7 +62,7 @@ async function restoreImpl(
         if (cacheKey) {
             await restoreWithKey(cacheKey, cachePaths);
         } else {
-            core.info(
+            utils.info(
                 `
                 No cache with the key "${cacheKey}" found.
                 Searching for a cache using restore keys:
@@ -96,7 +96,7 @@ async function restoreImpl(
                     `
                 );
             }
-            core.info(
+            utils.info(
                 `
                 Cache not found for input keys:
                 ${utils.stringify([primaryKey, ...restoreKeys])}
@@ -119,7 +119,7 @@ async function restoreImpl(
 
         core.setOutput(Outputs.CacheHit, isExactKeyMatch.toString());
 
-        core.info(`Cache restored from key: ${cacheKey}`);
+        utils.info(`Cache restored from key: ${cacheKey}`);
 
         await restoreExtraCaches();
 

diff --git a/src/saveImpl.ts b/src/saveImpl.ts
@@ -58,7 +58,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
         const time = Date.now();
 
         if (utils.isExactKeyMatch(primaryKey, restoredKey)) {
-            core.info(`Cache hit occurred on the primary key ${primaryKey}.`);
+            utils.info(`Cache hit occurred on the primary key ${primaryKey}.`);
 
             const caches = await purgeCaches({
                 key: primaryKey,
@@ -67,7 +67,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
             });
 
             if (caches.map(cache => cache.key).includes(primaryKey)) {
-                core.info(`Purging the cache with the key ${primaryKey}...`);
+                utils.info(`Purging the cache with the key ${primaryKey}...`);
 
                 const token = core.getInput(Inputs.Token, { required: true });
                 const octokit = getOctokit(token);
@@ -80,7 +80,7 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
                     ref: github.context.ref
                 });
             } else {
-                core.info(
+                utils.info(
                     `The cache with the key ${primaryKey} won't be purged. Not saving a new cache.`
                 );
 
@@ -92,14 +92,14 @@ async function saveImpl(stateProvider: IStateProvider): Promise<number | void> {
 
         await collectGarbage();
 
-        core.info(`Saving a new cache with the key ${primaryKey}...`);
+        utils.info(`Saving a new cache with the key ${primaryKey}...`);
 
         cacheId = await cache.saveCache(cachePaths, primaryKey, {
             uploadChunkSize: utils.getInputAsInt(Inputs.UploadChunkSize)
         });
 
         if (cacheId != -1) {
-            core.info(`Cache saved with the key ${primaryKey}.`);
+            utils.info(`Cache saved with the key ${primaryKey}.`);
 
             await purgeCaches({ key: primaryKey, lookupOnly: false, time });
         }

diff --git a/src/utils/actionUtils.ts b/src/utils/actionUtils.ts
@@ -1,6 +1,7 @@
 import * as cache from "@actions/cache";
 import * as core from "@actions/core";
 import * as github from "@actions/github";
+import { dedent } from "ts-dedent";
 
 import { Inputs, RefKey } from "../constants";
 
@@ -192,3 +193,7 @@ export function getMaxDate({
 }
 
 export const stringify = (value: any) => JSON.stringify(value, null, 2);
+
+export const info = (message: string) => {
+    core.info(dedent(message));
+};