fix: packageManager reader (#35)

* fix: packageManager reader

* chore: resolve review

* chore: run build

.github/dependabot.yml

@@ -0,0 +1,10 @@
+version: 2
+updates:
+  - package-ecosystem: github-actions
+    directory: "/"
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 10
+    labels:
+    - dependabot
+    - github-actions

.github/workflows/test.yaml

@@ -3,6 +3,7 @@ name: Test Action
 on:
   - push
   - pull_request
+  - workflow_dispatch
 
 jobs:
   test_default_inputs:
@@ -57,8 +58,6 @@ jobs:
         with:
           version: 4.11.1
           dest: ~/test/pnpm
-          bin_dest: ~/test/pnpm/.bin
-          registry: http://registry.yarnpkg.com/
 
       - name: 'Test: which'
         run: which pnpm && which pnpx

.gitignore

@@ -8,3 +8,4 @@ temp
 *.temp
 tmp.*
 temp.*
+.pnpm-store

README.md

@@ -1,24 +1,20 @@
-# Setup PNPM
+# Setup pnpm
 
-Install PNPM package manager.
+Install pnpm package manager.
 
 ## Inputs
 
 ### `version`
 
-**Required** Version of PNPM to install.
+Version of pnpm to install.
+
+**Optional** when there is a [`packageManager` field in the `package.json`](https://nodejs.org/api/corepack.html).
+
+otherwise, this field is **required** It supports npm versioning scheme, it could be an exact version (such as `6.24.1`), or a version range (such as `6`, `6.x.x`, `6.24.x`, `^6.24.1`, `*`, etc.), or `latest`.
 
 ### `dest`
 
-**Optional** Where to store PNPM files.
-
-### `bin_dest`
-
-**Optional** Where to store executables (`pnpm` and `pnpx` commands).
-
-### `registry`
-
-**Optional** (_default:_ `https://registry.npmjs.com`) Registry to download PNPM from.
+**Optional** Where to store pnpm files.
 
 ### `run_install`
 
@@ -50,11 +46,11 @@ Expanded path of inputs#dest.
 
 ### `bin_dest`
 
-Expanded path of inputs#bin_dest.
+Location of `pnpm` and `pnpx` command.
 
 ## Usage example
 
-### Just install PNPM
+### Just install pnpm
 
 ```yaml
 on:
@@ -62,15 +58,16 @@ on:
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  install:
+    runs-on: ubuntu-latest
 
-  steps:
-    - uses: pnpm/action-setup@v1.2.0
-      with:
-        version: 4.11.1
+    steps:
+      - uses: pnpm/action-setup@v2.1.0
+        with:
+          version: 6.0.2
 ```
 
-### Install PNPM and a few NPM packages
+### Install pnpm and a few npm packages
 
 ```yaml
 on:
@@ -78,20 +75,52 @@ on:
   - pull_request
 
 jobs:
-  runs-on: ubuntu-latest
+  install:
+    runs-on: ubuntu-latest
 
-  steps:
-    - uses: actions/checkout@v2
+    steps:
+      - uses: actions/checkout@v2
 
-    - uses: pnpm/action-setup@v1.2.0
-      with:
-        version: 4.11.1
-        run_install: |
-          - recursive: true
-            args: [--frozen-lockfile, --strict-peer-dependencies]
-          - args: [--global, gulp, prettier, typescript]
+      - uses: pnpm/action-setup@v2.1.0
+        with:
+          version: 6.0.2
+          run_install: |
+            - recursive: true
+              args: [--frozen-lockfile, --strict-peer-dependencies]
+            - args: [--global, gulp, prettier, typescript]
 ```
 
+### Use cache to reduce installation time
+
+```yaml
+on:
+  - push
+  - pull_request
+
+jobs:
+  cache-and-install:
+    runs-on: ubuntu-latest
+
+    steps:
+      build:
+        - uses: actions/checkout@v2
+
+        - name: Cache pnpm modules
+          uses: actions/cache@v2
+          with:
+            path: ~/.pnpm-store
+            key: ${{ runner.os }}-${{ hashFiles('**/pnpm-lock.yaml') }}
+            restore-keys: |
+              ${{ runner.os }}-
+
+        - uses: pnpm/action-setup@v2.1.0
+          with:
+            version: 6.0.2
+            run_install: true
+```
+
+**Note:** You don't need to run `pnpm store prune` at the end; post-action has already taken care of that.
+
 ## Notes
 
 This action does not setup Node.js for you, use [actions/setup-node](https://github.com/actions/setup-node) yourself.

action.yml

@@ -6,19 +6,10 @@ branding:
 inputs:
   version:
     description: Version of PNPM to install
-    required: true
   dest:
     description: Where to store PNPM files
     required: false
     default: ~/setup-pnpm
-  bin_dest:
-    description: Where to store executables (pnpm and pnpx commands)
-    required: false
-    default: ~/setup-pnpm/.bin
-  registry:
-    description: Registry to download PNPM from
-    required: false
-    default: https://registry.npmjs.com
   run_install:
     description: If specified, run `pnpm install`
     required: false

package.json

@@ -7,19 +7,22 @@
     "start": "pnpm run build && sh ./run.sh"
   },
   "dependencies": {
-    "node-fetch": "^2.6.0",
-    "expand-tilde": "^2.0.2",
-    "js-yaml": "^3.13.1",
-    "ajv": "^6.12.0",
-    "@actions/core": "^1.2.4",
+    "@actions/core": "^1.6.0",
+    "@pnpm/fetch": "^4.2.5",
+    "@pnpm/logger": "^4.0.0",
     "@types/expand-tilde": "^2.0.0",
-    "@types/node-fetch": "^2.5.7",
-    "@types/js-yaml": "^3.12.3",
-    "@types/node": "^13.13.5"
+    "@types/fs-extra": "^9.0.13",
+    "@types/js-yaml": "^4.0.5",
+    "@types/node": "^14.18.10",
+    "@types/node-fetch": "^2.6.1",
+    "ajv": "^6.12.6",
+    "expand-tilde": "^2.0.2",
+    "fs-extra": "^10.0.0",
+    "js-yaml": "^4.1.0"
   },
   "devDependencies": {
-    "typescript": "^3.8.3",
     "@ts-schema-autogen/cli": "^0.1.2",
-    "@zeit/ncc": "^0.22.1"
+    "@vercel/ncc": "^0.33.3",
+    "typescript": "^4.5.5"
   }
 }

renovate.json

@@ -1,6 +1,10 @@
 {
+  "$schema": "https://docs.renovatebot.com/renovate-schema.json",
   "pinVersions": false,
   "extends": [
     "config:base"
+  ],
+  "ignoreDeps": [
+    "ajv"
   ]
 }

run.sh

@@ -3,7 +3,5 @@
 export HOME="$(pwd)"
 export INPUT_VERSION=4.11.1
 export INPUT_DEST='~/pnpm.temp'
-export INPUT_BIN_DEST='~/pnpm.temp/.bin'
-export INPUT_REGISTRY=https://registry.npmjs.com
 export INPUT_RUN_INSTALL=null
 exec node dist/index.js

src/index.ts

@@ -1,7 +1,7 @@
 import { setFailed, saveState, getState } from '@actions/core'
 import getInputs from './inputs'
-import setOutputs from './outputs'
 import installPnpm from './install-pnpm'
+import setOutputs from './outputs'
 import pnpmInstall from './pnpm-install'
 import pruneStore from './pnpm-store-prune'
 

src/inputs/index.ts

@@ -3,10 +3,8 @@ import expandTilde from 'expand-tilde'
 import { RunInstall, parseRunInstall } from './run-install'
 
 export interface Inputs {
-  readonly version: string
+  readonly version?: string
   readonly dest: string
-  readonly binDest: string
-  readonly registry: string
   readonly runInstall: RunInstall[]
 }
 
@@ -17,10 +15,8 @@ const options: InputOptions = {
 const parseInputPath = (name: string) => expandTilde(getInput(name, options))
 
 export const getInputs = (): Inputs => ({
-  version: getInput('version', options),
+  version: getInput('version'),
   dest: parseInputPath('dest'),
-  binDest: parseInputPath('bin_dest'),
-  registry: getInput('registry', options),
   runInstall: parseRunInstall('run_install'),
 })
 

src/inputs/run-install.ts

@@ -1,7 +1,7 @@
-import process from 'process'
-import { safeLoad } from 'js-yaml'
-import Ajv from 'ajv'
 import { getInput, error, InputOptions } from '@actions/core'
+import Ajv from 'ajv'
+import { load } from 'js-yaml'
+import process from 'process'
 import runInstallSchema from './run-install-input.schema.json'
 
 export interface RunInstall {
@@ -21,10 +21,9 @@ const options: InputOptions = {
 }
 
 export function parseRunInstall(name: string): RunInstall[] {
-  const result: RunInstallInput = safeLoad(getInput(name, options))
+  const result: RunInstallInput = load(getInput(name, options)) as any
   const ajv = new Ajv({
     allErrors: true,
-    async: false,
   })
   const validate = ajv.compile(runInstallSchema)
   if (!validate(result)) {

src/install-pnpm/index.ts

@@ -9,7 +9,7 @@ export async function install(inputs: Inputs) {
   const status = await runSelfInstaller(inputs)
   endGroup()
   if (status) {
-    return setFailed(`Something does wrong, self-installer exits with code ${status}`)
+    return setFailed(`Something went wrong, self-installer exits with code ${status}`)
   }
 }
 

src/install-pnpm/run.ts

@@ -1,26 +1,66 @@
+import { addPath, exportVariable } from '@actions/core'
+import fetch from '@pnpm/fetch'
 import { spawn } from 'child_process'
+import { remove, ensureFile, writeFile, readFile } from 'fs-extra'
+import path from 'path'
 import { execPath } from 'process'
-import { downloadSelfInstaller } from '../self-installer'
 import { Inputs } from '../inputs'
 
 export async function runSelfInstaller(inputs: Inputs): Promise<number> {
-  const cp = spawn(execPath, {
-    env: {
-      PNPM_VERSION: inputs.version,
-      PNPM_DEST: inputs.dest,
-      PNPM_BIN_DEST: inputs.binDest,
-      PNPM_REGISTRY: inputs.registry,
-    },
+  const { version, dest } = inputs
+
+  // prepare self install
+  await remove(dest)
+  const pkgJson = path.join(dest, 'package.json')
+  await ensureFile(pkgJson)
+  await writeFile(pkgJson, JSON.stringify({ private: true }))
+
+  // prepare target pnpm
+  const target = await readTarget(version)
+  const cp = spawn(execPath, ['-', 'install', target, '--no-lockfile'], {
+    cwd: dest,
     stdio: ['pipe', 'inherit', 'inherit'],
   })
 
-  const response = await downloadSelfInstaller()
+  const response = await fetch('https://get.pnpm.io/v6.16.js')
+  if (!response.body) throw new Error('Did not receive response body')
   response.body.pipe(cp.stdin)
 
-  return new Promise((resolve, reject) => {
+  const exitCode = await new Promise<number>((resolve, reject) => {
     cp.on('error', reject)
     cp.on('close', resolve)
   })
+  if (exitCode === 0) {
+    const pnpmHome = path.join(dest, 'node_modules/.bin')
+    addPath(pnpmHome)
+    exportVariable('PNPM_HOME', pnpmHome)
+  }
+  return exitCode
+}
+
+async function readTarget(version?: string | undefined) {
+  if (version) return `pnpm@${version}`
+
+  const { GITHUB_WORKSPACE } = process.env
+  if (!GITHUB_WORKSPACE) {
+    throw new Error(`No workspace is found.
+If you're intended to let pnpm/action-setup read preferred pnpm version from the "packageManager" field in the package.json file,
+please run the actions/checkout before pnpm/action-setup.
+Otherwise, please specify the pnpm version in the action configuration.`)
+  }
+
+  const { packageManager } = JSON.parse(await readFile(path.join(GITHUB_WORKSPACE, 'package.json'), 'utf8'))
+  if (typeof packageManager !== 'string') {
+    throw new Error(`No pnpm version is specified.
+Please specify it by one of the following ways:
+  - in the GitHub Action config with the key "version"
+  - in the package.json with the key "packageManager" (See https://nodejs.org/api/corepack.html)`)
+  }
+
+  if (!packageManager.startsWith('pnpm@')) {
+    throw new Error('Invalid packageManager field in package.json')
+  }
+  return packageManager
 }
 
 export default runSelfInstaller

src/outputs/index.ts

@@ -1,10 +1,12 @@
 import { setOutput, addPath } from '@actions/core'
 import { Inputs } from '../inputs'
+import { getBinDest } from '../utils'
 
 export function setOutputs(inputs: Inputs) {
-  addPath(inputs.binDest)
+  const binDest = getBinDest(inputs)
+  addPath(binDest)
   setOutput('dest', inputs.dest)
-  setOutput('bin_dest', inputs.binDest)
+  setOutput('bin_dest', binDest)
 }
 
 export default setOutputs

src/pnpm-install/index.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
 import { setFailed, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
 import { Inputs } from '../inputs'
 import { patchPnpmEnv } from '../utils'
 

src/pnpm-store-prune/index.ts

@@ -1,5 +1,5 @@
-import { spawnSync } from 'child_process'
 import { warning, startGroup, endGroup } from '@actions/core'
+import { spawnSync } from 'child_process'
 import { Inputs } from '../inputs'
 import { patchPnpmEnv } from '../utils'
 
@@ -13,7 +13,7 @@ export function pruneStore(inputs: Inputs) {
   const { error, status } = spawnSync('pnpm', ['store', 'prune'], {
     stdio: 'inherit',
     shell: true,
-    env: patchPnpmEnv(inputs)
+    env: patchPnpmEnv(inputs),
   })
   endGroup()
 

src/self-installer/download.ts

@@ -1,4 +0,0 @@
-import fetch from 'node-fetch'
-import url from './url'
-export const downloadSelfInstaller = () => fetch(url)
-export default downloadSelfInstaller

src/self-installer/index.ts

@@ -1,2 +0,0 @@
-export * from './url'
-export * from './download'

src/self-installer/url.ts

@@ -1,3 +0,0 @@
-export const ref = '301414cec74a2b6b63c95b42f2ad1790ccb980ed'
-export const url = `https://raw.githubusercontent.com/pnpm/self-installer/${ref}/install.js`
-export default url

src/utils/index.ts

@@ -1,8 +1,10 @@
-import process from 'process'
 import path from 'path'
+import process from 'process'
 import { Inputs } from '../inputs'
 
+export const getBinDest = (inputs: Inputs): string => path.join(inputs.dest, 'node_modules', '.bin')
+
 export const patchPnpmEnv = (inputs: Inputs): NodeJS.ProcessEnv => ({
   ...process.env,
-  PATH: inputs.binDest + path.delimiter + process.env.PATH
+  PATH: getBinDest(inputs) + path.delimiter + process.env.PATH,
 })