feat: add npm-shrinkwrap.json file support (#59)

Author: thinca

.github/workflows/example-shrinkwrap.yml

@@ -0,0 +1,12 @@
+name: example-shrinkwrap
+on: [push, pull_request]
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: bahmutov/npm-install@HEAD
+        with:
+          working-directory: examples/shrinkwrap
+      - run: npm t
+        working-directory: examples/shrinkwrap

README.md

@@ -9,6 +9,7 @@ Example | Status
 --- | ---
 [main](.github/workflows/main.yml) | ![this repo](https://github.com/bahmutov/npm-install/workflows/main/badge.svg?branch=master)
 [basic](.github/workflows/example-basic.yml) | ![basic example](https://github.com/bahmutov/npm-install/workflows/example-basic/badge.svg?branch=master)
+[shrinkwrap](.github/workflows/example-shrinkwrap.yml) | ![shrinkwrap example](https://github.com/bahmutov/npm-install/workflows/example-shrinkwrap/badge.svg?branch=master)
 [Yarn](.github/workflows/example-yarn.yml) | ![yarn example](https://github.com/bahmutov/npm-install/workflows/example-yarn/badge.svg?branch=master)
 [without lock file](.github/workflows/example-without-lock-file.yml) | ![without lockfile example](https://github.com/bahmutov/npm-install/workflows/example-without-lock-file/badge.svg?branch=master)
 [subfolders](.github/workflows/example-subfolders.yml) | ![subfolders example](https://github.com/bahmutov/npm-install/workflows/example-subfolders/badge.svg?branch=master)
@@ -98,7 +99,7 @@ jobs:
 
 ### Use lock file
 
-By default, this action will use a lock file like `package-lock.json` or `yarn.lock`. You can set `useLockFile: false` to use just `package.json` which might be better for [building libraries](https://twitter.com/mikeal/status/1202298796274700288).
+By default, this action will use a lock file like `package-lock.json`, `npm-shrinkwrap.json` or `yarn.lock`. You can set `useLockFile: false` to use just `package.json` which might be better for [building libraries](https://twitter.com/mikeal/status/1202298796274700288).
 
 ```yml
 - uses: bahmutov/npm-install@v1

dist/index.js

@@ -2927,11 +2927,19 @@ const getLockFilename = usePackageLock => workingDirectory => {
   const useYarn = fs.existsSync(yarnFilename)
   core.debug(`yarn lock file "${yarnFilename}" exists? ${useYarn}`)
 
+  const npmShrinkwrapFilename = path.join(
+    workingDirectory,
+    'npm-shrinkwrap.json'
+  )
   const packageLockFilename = path.join(workingDirectory, 'package-lock.json')
+  const npmFilename =
+    !useYarn && fs.existsSync(npmShrinkwrapFilename)
+      ? npmShrinkwrapFilename
+      : packageLockFilename
 
   const result = {
     useYarn,
-    lockFilename: useYarn ? yarnFilename : packageLockFilename
+    lockFilename: useYarn ? yarnFilename : npmFilename
   }
   return result
 }

examples/shrinkwrap/index.js

@@ -0,0 +1,2 @@
+const chalk = require('chalk')
+console.log(chalk.cyanBright('chalk is working!'))

examples/shrinkwrap/npm-shrinkwrap.json

@@ -0,0 +1,15 @@
+{
+  "name": "example-shrinkwrap",
+  "private": true,
+  "version": "1.0.0",
+  "description": "npm-install with npm-shrinkwrap.json example",
+  "main": "index.js",
+  "scripts": {
+    "test": "node ."
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "chalk": "3.0.0"
+  }
+}

examples/shrinkwrap/package.json

@@ -125,11 +125,19 @@ const getLockFilename = usePackageLock => workingDirectory => {
   const useYarn = fs.existsSync(yarnFilename)
   core.debug(`yarn lock file "${yarnFilename}" exists? ${useYarn}`)
 
+  const npmShrinkwrapFilename = path.join(
+    workingDirectory,
+    'npm-shrinkwrap.json'
+  )
   const packageLockFilename = path.join(workingDirectory, 'package-lock.json')
+  const npmFilename =
+    !useYarn && fs.existsSync(npmShrinkwrapFilename)
+      ? npmShrinkwrapFilename
+      : packageLockFilename
 
   const result = {
     useYarn,
-    lockFilename: useYarn ? yarnFilename : packageLockFilename
+    lockFilename: useYarn ? yarnFilename : npmFilename
   }
   return result
 }

index.js

@@ -79,10 +79,10 @@ describe('action', () => {
 
   context('does not find Yarn', function() {
     const yarnFilename = path.join(cwd, 'yarn.lock')
+    const npmShrinkwrapFilename = path.join(cwd, 'npm-shrinkwrap.json')
     const packageLockFilename = path.join(cwd, 'package-lock.json')
     const npmCachePaths = [path.join(homedir, '.npm')]
     const pathToNpm = '/path/to/npm'
-    const cacheKey = 'npm-platform-arch-hash-from-package-lock-file'
 
     beforeEach(function() {
       sandbox
@@ -100,31 +100,77 @@ describe('action', () => {
         .withArgs('npm')
         .resolves(pathToNpm)
 
-      sandbox
-        .stub(hasha, 'fromFileSync')
-        .withArgs(packageLockFilename)
-        .returns('hash-from-package-lock-file')
-
       const cacheHit = false
       this.restoreCache = sandbox.stub(cache, 'restoreCache').resolves(cacheHit)
       this.saveCache = sandbox.stub(cache, 'saveCache').resolves()
     })
 
-    it('uses package lock and NPM', async function() {
-      await action.npmInstallAction()
+    context('finds npm-shrinkwrap.json', async function() {
+      const cacheKey = 'npm-platform-arch-hash-from-npm-shrinkwrap-file'
 
-      expect(this.restoreCache).to.be.calledOnceWithExactly(
-        npmCachePaths,
-        cacheKey,
-        [cacheKey]
-      )
-      expect(this.exec).to.be.calledOnceWithExactly(quote(pathToNpm), ['ci'], {
-        cwd
+      beforeEach(function() {
+        fs.existsSync.withArgs(npmShrinkwrapFilename).returns(true)
+
+        sandbox
+          .stub(hasha, 'fromFileSync')
+          .withArgs(npmShrinkwrapFilename)
+          .returns('hash-from-npm-shrinkwrap-file')
+      })
+
+      it('uses npm-shrinkwrap.json and NPM', async function() {
+        await action.npmInstallAction()
+
+        expect(this.restoreCache).to.be.calledOnceWithExactly(
+          npmCachePaths,
+          cacheKey,
+          [cacheKey]
+        )
+        expect(this.exec).to.be.calledOnceWithExactly(
+          quote(pathToNpm),
+          ['ci'],
+          {
+            cwd
+          }
+        )
+        expect(this.saveCache).to.be.calledOnceWithExactly(
+          npmCachePaths,
+          cacheKey
+        )
+      })
+    })
+
+    context('finds package-lock.json', async function() {
+      const cacheKey = 'npm-platform-arch-hash-from-package-lock-file'
+
+      beforeEach(function() {
+        fs.existsSync.withArgs(npmShrinkwrapFilename).returns(false)
+
+        sandbox
+          .stub(hasha, 'fromFileSync')
+          .withArgs(packageLockFilename)
+          .returns('hash-from-package-lock-file')
+      })
+
+      it('uses package-lock.json and NPM', async function() {
+        await action.npmInstallAction()
+
+        expect(this.restoreCache).to.be.calledOnceWithExactly(
+          npmCachePaths,
+          cacheKey,
+          [cacheKey]
+        )
+        expect(this.exec).to.be.calledOnceWithExactly(
+          quote(pathToNpm),
+          ['ci'],
+          {
+            cwd
+          }
+        )
+        expect(this.saveCache).to.be.calledOnceWithExactly(
+          npmCachePaths,
+          cacheKey
+        )
       })
-      expect(this.saveCache).to.be.calledOnceWithExactly(
-        npmCachePaths,
-        cacheKey
-      )
     })
   })