feat(yaml-parser): replace bahmutov/npm-install for 'npm ci' if uses cache (#14)

* feat(yaml-parser): replace bahmutov/npm-install for npm ci if uses cache

* test(yaml-parser): add coverage for bahmutov/npm-install use case

Author: oscard0m

tests/utils/github-action-fixtures/already-has-cache/not-replace-bahmutov-npm-install/actual.yml

@@ -0,0 +1,16 @@
+name: Node.js CI
+"on":
+  push:
+    branches:
+      - master
+      - "dependabot/**"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: bahmutov/npm-install@v1
+      - run: npm test

tests/utils/github-action-fixtures/already-has-cache/not-replace-bahmutov-npm-install/expected.yml

@@ -0,0 +1,16 @@
+name: Node.js CI
+"on":
+  push:
+    branches:
+      - master
+      - "dependabot/**"
+  pull_request:
+    types:
+      - opened
+      - synchronize
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: bahmutov/npm-install@v1
+      - run: npm test

tests/utils/github-action-fixtures/pending-to-add-cache/example5/actual.yml renamed to tests/utils/github-action-fixtures/pending-to-add-cache/replace-bahmutov-npm-install/actual.yml

@@ -1,5 +1,5 @@
 name: Node.js CI
-'on':
+"on":
   push:
     branches:
       - master

tests/utils/github-action-fixtures/pending-to-add-cache/example5/expected.yml renamed to tests/utils/github-action-fixtures/pending-to-add-cache/replace-bahmutov-npm-install/expected.yml

@@ -18,5 +18,5 @@ jobs:
         with:
           node-version: 12.x
           cache: npm
-      - uses: bahmutov/npm-install@v1
+      - run: npm ci
       - run: npm test

utils/yaml-parser.js

@@ -3,6 +3,9 @@ import prettier from "prettier";
 
 const { parseDocument } = YAML;
 
+const usesBahmutovNpmInstall = (hasCache, stepUses) =>
+  hasCache && stepUses && stepUses.includes("bahmutov/npm-install");
+
 /**
  * @param {string} cache
  *
@@ -27,11 +30,15 @@ export function getAddCacheToSetupNodeFunction(cache) {
 
     for (const { value: job } of jobs.items) {
       const steps = job.get("steps");
+      let jobHasCache = false;
       for (const step of steps.items) {
         const stepUses = step.get("uses");
         const stepWith = step.get("with");
 
-        if (
+        if (usesBahmutovNpmInstall(jobHasCache, stepUses)) {
+          step.set("run", "npm ci");
+          step.delete("uses")
+        } else if (
           stepUses &&
           stepUses.includes("actions/setup-node") &&
           (!stepWith || !stepWith.get("cache"))
@@ -47,13 +54,15 @@ export function getAddCacheToSetupNodeFunction(cache) {
           }
 
           cacheAdded = true;
+          jobHasCache = true;
         }
       }
     }
 
-    return cacheAdded ? prettier.format(
-		yamlDocument.toString({lineWidth: 0}), {
-			parser: 'yaml'
-		}) : null;
+    return cacheAdded
+      ? prettier.format(yamlDocument.toString({ lineWidth: 0 }), {
+          parser: "yaml",
+        })
+      : null;
   };
 }