feat: a command for installing Node.js (pnpm#3620)

zkochan · web-flow · commit af8b5716e403 · 2021-07-30T14:21:19.000+03:00
The following command will install Node.js (inspired by [poetry](https://python-poetry.org/docs/managing-environments/)): ``` pnpm env use --global 16.5.0 ```
diff --git a/.changeset/twelve-rice-compare.md b/.changeset/twelve-rice-compare.md
@@ -0,0 +1,5 @@
+---
+"@pnpm/plugin-commands-env": patch
+---
+
+New command added: `pnpm env use --global <version>`. This command installs the specified Node.js version globally.
diff --git a/.changeset/wise-needles-fix.md b/.changeset/wise-needles-fix.md
@@ -0,0 +1,5 @@
+---
+"@pnpm/config": patch
+---
+
+pnpm should always have write access to its home directory
diff --git a/packages/config/src/dirs.ts b/packages/config/src/dirs.ts
@@ -39,3 +39,21 @@ export function getStateDir (
   }
   return path.join(os.homedir(), '.pnpm-state')
 }
+
+export function getDataDir (
+  opts: {
+    env: NodeJS.ProcessEnv
+    platform: string
+  }
+) {
+  if (opts.env.XDG_DATA_HOME) {
+    return path.join(opts.env.XDG_DATA_HOME, 'pnpm')
+  }
+  if (opts.platform !== 'win32' && opts.platform !== 'darwin') {
+    return path.join(os.homedir(), '.local/share/pnpm')
+  }
+  if (opts.env.LOCALAPPDATA) {
+    return path.join(opts.env.LOCALAPPDATA, 'pnpm')
+  }
+  return path.join(os.homedir(), '.pnpm')
+}
diff --git a/packages/config/src/index.ts b/packages/config/src/index.ts
@@ -13,7 +13,7 @@ import realpathMissing from 'realpath-missing'
 import whichcb from 'which'
 import getScopeRegistries, { normalizeRegistry } from './getScopeRegistries'
 import findBestGlobalPrefix from './findBestGlobalPrefix'
-import { getCacheDir, getStateDir } from './dirs'
+import { getCacheDir, getDataDir, getStateDir } from './dirs'
 import {
   Config,
   ConfigWithDeprecatedSettings,
@@ -427,19 +427,7 @@ export default async (
     pnpmConfig.noProxy = pnpmConfig['noproxy'] ?? getProcessEnv('no_proxy')
   }
   pnpmConfig.enablePnp = pnpmConfig['nodeLinker'] === 'pnp'
-  if (process['pkg'] != null) {
-    // If the pnpm CLI was bundled by vercel/pkg then we cannot use the js path for npm_execpath
-    // because in that case the js is in a virtual filesystem inside the executor.
-    // Instead, we use the path to the exe file.
-    pnpmConfig.pnpmExecPath = process.execPath
-    pnpmConfig.pnpmHomeDir = path.dirname(pnpmConfig.pnpmExecPath)
-  } else if (require.main != null) {
-    pnpmConfig.pnpmExecPath = require.main.filename
-    pnpmConfig.pnpmHomeDir = path.dirname(pnpmConfig.pnpmExecPath)
-  } else {
-    pnpmConfig.pnpmExecPath = process.cwd()
-    pnpmConfig.pnpmHomeDir = process.cwd()
-  }
+  pnpmConfig.pnpmHomeDir = getDataDir(process)
 
   if (opts.checkUnknownSetting) {
     const settingKeys = Object.keys({
diff --git a/packages/config/test/dirs.test.ts b/packages/config/test/dirs.test.ts
@@ -1,6 +1,6 @@
 import os from 'os'
 import path from 'path'
-import { getCacheDir, getStateDir } from '../lib/dirs'
+import { getCacheDir, getDataDir, getStateDir } from '../lib/dirs'
 
 test('getCacheDir()', () => {
   expect(getCacheDir({
@@ -55,3 +55,30 @@ test('getStateDir()', () => {
     platform: 'win32',
   })).toBe(path.join(os.homedir(), '.pnpm-state'))
 })
+
+test('getDataDir()', () => {
+  expect(getDataDir({
+    env: {
+      XDG_DATA_HOME: '/home/foo/data',
+    },
+    platform: 'linux',
+  })).toBe(path.join('/home/foo/data', 'pnpm'))
+  expect(getDataDir({
+    env: {},
+    platform: 'linux',
+  })).toBe(path.join(os.homedir(), '.local/share/pnpm'))
+  expect(getDataDir({
+    env: {},
+    platform: 'darwin',
+  })).toBe(path.join(os.homedir(), '.pnpm'))
+  expect(getDataDir({
+    env: {
+      LOCALAPPDATA: '/localappdata',
+    },
+    platform: 'win32',
+  })).toBe(path.join('/localappdata', 'pnpm'))
+  expect(getDataDir({
+    env: {},
+    platform: 'win32',
+  })).toBe(path.join(os.homedir(), '.pnpm'))
+})
diff --git a/packages/plugin-commands-env/CHANGELOG.md b/packages/plugin-commands-env/CHANGELOG.md
@@ -1,4 +1,4 @@
-# @pnpm/plugin-commands-nvm
+# @pnpm/plugin-commands-env
 
 ## 0.2.8
 
diff --git a/packages/plugin-commands-env/README.md b/packages/plugin-commands-env/README.md
@@ -1,13 +1,13 @@
-# @pnpm/plugin-commands-nvm
+# @pnpm/plugin-commands-env
 
 > pnpm commands for managing Node.js
 
-[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-nvm.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-nvm)
+[![npm version](https://img.shields.io/npm/v/@pnpm/plugin-commands-env.svg)](https://www.npmjs.com/package/@pnpm/plugin-commands-env)
 
 ## Installation
 
 ```sh
-<pnpm|npm|yarn> add @pnpm/plugin-commands-nvm
+<pnpm|npm|yarn> add @pnpm/plugin-commands-env
 ```
 
 ## License
diff --git a/packages/plugin-commands-env/jest.config.js b/packages/plugin-commands-env/jest.config.js
diff --git a/packages/plugin-commands-env/package.json b/packages/plugin-commands-env/package.json
@@ -1,5 +1,5 @@
 {
-  "name": "@pnpm/plugin-commands-nvm",
+  "name": "@pnpm/plugin-commands-env",
   "version": "0.2.8",
   "description": "pnpm commands for managing Node.js",
   "main": "lib/index.js",
@@ -18,31 +18,37 @@
     "prepublishOnly": "pnpm run compile",
     "compile": "rimraf lib tsconfig.tsbuildinfo && tsc --build && pnpm run lint -- --fix"
   },
-  "repository": "https://github.com/pnpm/pnpm/blob/master/packages/plugin-commands-nvm",
+  "repository": "https://github.com/pnpm/pnpm/blob/master/packages/plugin-commands-env",
   "keywords": [
     "pnpm",
-    "nvm"
+    "env"
   ],
   "license": "MIT",
   "bugs": {
     "url": "https://github.com/pnpm/pnpm/issues"
   },
-  "homepage": "https://github.com/pnpm/pnpm/blob/master/packages/plugin-commands-nvm#readme",
+  "homepage": "https://github.com/pnpm/pnpm/blob/master/packages/plugin-commands-env#readme",
   "dependencies": {
+    "@pnpm/cli-utils": "workspace:0.6.13",
     "@pnpm/config": "workspace:12.4.3",
+    "@pnpm/error": "workspace:2.0.0",
     "@pnpm/fetch": "workspace:4.0.2",
     "@pnpm/package-store": "workspace:12.0.12",
     "@pnpm/store-path": "^5.0.0",
     "@pnpm/tarball-fetcher": "workspace:9.3.4",
+    "@zkochan/cmd-shim": "^5.1.3",
     "adm-zip": "^0.5.5",
     "load-json-file": "^6.2.0",
     "rename-overwrite": "^4.0.0",
+    "render-help": "^1.0.1",
     "tempy": "^1.0.0",
     "write-json-file": "^4.3.0"
   },
   "funding": "https://opencollective.com/pnpm",
   "devDependencies": {
     "@pnpm/prepare": "workspace:0.0.26",
-    "@types/adm-zip": "^0.4.34"
+    "@types/adm-zip": "^0.4.34",
+    "execa": "^5.0.0",
+    "path-name": "^1.0.0"
   }
 }
diff --git a/packages/plugin-commands-env/src/env.ts b/packages/plugin-commands-env/src/env.ts
@@ -0,0 +1,66 @@
+import path from 'path'
+import { docsUrl } from '@pnpm/cli-utils'
+import PnpmError from '@pnpm/error'
+import cmdShim from '@zkochan/cmd-shim'
+import renderHelp from 'render-help'
+import { getNodeDir, NvmNodeCommandOptions } from './node'
+
+export function rcOptionsTypes () {
+  return {}
+}
+
+export function cliOptionsTypes () {
+  return {
+    global: Boolean,
+  }
+}
+
+export const commandNames = ['env']
+
+export function help () {
+  return renderHelp({
+    description: 'Install and use the specified version of Node.js',
+    descriptionLists: [
+      {
+        title: 'Options',
+
+        list: [
+          {
+            description: 'Installs Node.js globally',
+            name: '--global',
+            shortAlias: '-g',
+          },
+        ],
+      },
+    ],
+    url: docsUrl('env'),
+    usages: [
+      'pnpm env use --global <version>',
+    ],
+  })
+}
+
+export async function handler (opts: NvmNodeCommandOptions, params: string[]) {
+  if (params.length === 0) {
+    throw new PnpmError('ENV_NO_SUBCOMMAND', 'Please specify the subcommand')
+  }
+  switch (params[0]) {
+  case 'use': {
+    if (!opts.global) {
+      throw new PnpmError('NOT_IMPLEMENTED_YET', '"pnpm env use <version>" can only be used with the "--global" option currently')
+    }
+    const nodeDir = await getNodeDir({
+      ...opts,
+      useNodeVersion: params[1],
+    })
+    const src = path.join(nodeDir, process.platform === 'win32' ? 'node.exe' : 'node')
+    const dest = path.join(opts.bin, 'node')
+    await cmdShim(src, dest)
+    return `Node.js ${params[1]} is activated
+  ${dest} -> ${src}`
+  }
+  default: {
+    throw new PnpmError('ENV_UNKNOWN_SUBCOMMAND', 'This subcommand is not known')
+  }
+  }
+}
diff --git a/packages/plugin-commands-env/src/index.ts b/packages/plugin-commands-env/src/index.ts
@@ -0,0 +1,4 @@
+import * as env from './env'
+import * as node from './node'
+
+export { env, node }
diff --git a/packages/plugin-commands-env/src/node.ts b/packages/plugin-commands-env/src/node.ts
@@ -12,6 +12,8 @@ import loadJsonFile from 'load-json-file'
 import writeJsonFile from 'write-json-file'
 
 export type NvmNodeCommandOptions = Pick<Config,
+| 'bin'
+| 'global'
 | 'rawConfig'
 | 'fetchRetries'
 | 'fetchRetryFactor'
@@ -34,10 +36,9 @@ export type NvmNodeCommandOptions = Pick<Config,
 >
 
 export async function getNodeDir (opts: NvmNodeCommandOptions) {
-  const nodesDir = path.join(opts.pnpmHomeDir, 'nodes')
+  const nodesDir = path.join(opts.pnpmHomeDir, 'nodejs')
   let wantedNodeVersion = opts.useNodeVersion ?? (await readNodeVersionsManifest(nodesDir))?.default
   await fs.promises.mkdir(nodesDir, { recursive: true })
-  fs.writeFileSync(path.join(nodesDir, 'pnpm-workspace.yaml'), '', 'utf8')
   if (wantedNodeVersion == null) {
     const response = await fetch('https://registry.npmjs.org/node')
     wantedNodeVersion = (await response.json())['dist-tags'].lts
diff --git a/packages/plugin-commands-env/test/env.test.ts b/packages/plugin-commands-env/test/env.test.ts
@@ -0,0 +1,27 @@
+import fs from 'fs'
+import path from 'path'
+import { tempDir } from '@pnpm/prepare'
+import { env } from '@pnpm/plugin-commands-env'
+import execa from 'execa'
+import PATH from 'path-name'
+
+test('install node', async () => {
+  tempDir()
+
+  await env.handler({
+    bin: process.cwd(),
+    global: true,
+    pnpmHomeDir: process.cwd(),
+    rawConfig: {},
+  }, ['use', '16.4.0'])
+
+  const { stdout } = execa.sync('node', ['-v'], {
+    env: {
+      [PATH]: `${process.cwd()}${path.delimiter}${process.env[PATH] as string}`,
+    },
+  })
+  expect(stdout.toString()).toBe('v16.4.0')
+
+  const dirs = fs.readdirSync(path.resolve('nodejs'))
+  expect(dirs).toEqual(['16.4.0'])
+})
diff --git a/packages/plugin-commands-env/test/node.test.ts b/packages/plugin-commands-env/test/node.test.ts
@@ -1,4 +1,4 @@
-import { node } from '@pnpm/plugin-commands-nvm'
+import { node } from '@pnpm/plugin-commands-env'
 
 test('check API (placeholder test)', async () => {
   expect(typeof node.getNodeDir).toBe('function')
diff --git a/packages/plugin-commands-env/tsconfig.json b/packages/plugin-commands-env/tsconfig.json
@@ -12,9 +12,15 @@
     {
       "path": "../../privatePackages/prepare"
     },
+    {
+      "path": "../cli-utils"
+    },
     {
       "path": "../config"
     },
+    {
+      "path": "../error"
+    },
     {
       "path": "../fetch"
     },
diff --git a/packages/plugin-commands-env/tsconfig.lint.json b/packages/plugin-commands-env/tsconfig.lint.json
diff --git a/packages/plugin-commands-nvm/src/index.ts b/packages/plugin-commands-nvm/src/index.ts
diff --git a/packages/pnpm/package.json b/packages/pnpm/package.json
@@ -43,7 +43,7 @@
     "@pnpm/plugin-commands-import": "workspace:3.0.8",
     "@pnpm/plugin-commands-installation": "workspace:6.0.8",
     "@pnpm/plugin-commands-listing": "workspace:4.0.4",
-    "@pnpm/plugin-commands-nvm": "workspace:0.2.8",
+    "@pnpm/plugin-commands-env": "workspace:0.2.8",
     "@pnpm/plugin-commands-outdated": "workspace:5.0.4",
     "@pnpm/plugin-commands-publishing": "workspace:4.2.0",
     "@pnpm/plugin-commands-rebuild": "workspace:5.0.4",
diff --git a/packages/pnpm/src/cmd/index.ts b/packages/pnpm/src/cmd/index.ts
@@ -1,6 +1,7 @@
 import { CompletionFunc } from '@pnpm/command'
 import { types as allTypes } from '@pnpm/config'
 import { audit } from '@pnpm/plugin-commands-audit'
+import { env } from '@pnpm/plugin-commands-env'
 import { importCommand } from '@pnpm/plugin-commands-import'
 import { add, fetch, install, link, prune, remove, unlink, update } from '@pnpm/plugin-commands-installation'
 import { list, ll, why } from '@pnpm/plugin-commands-listing'
@@ -61,6 +62,7 @@ const commands: Array<{
   add,
   audit,
   bin,
+  env,
   exec,
   fetch,
   importCommand,
diff --git a/packages/pnpm/src/main.ts b/packages/pnpm/src/main.ts
@@ -11,7 +11,7 @@ import { filterPackages } from '@pnpm/filter-workspace-packages'
 import findWorkspacePackages from '@pnpm/find-workspace-packages'
 import logger from '@pnpm/logger'
 import { ParsedCliArgs } from '@pnpm/parse-cli-args'
-import { node } from '@pnpm/plugin-commands-nvm'
+import { node } from '@pnpm/plugin-commands-env'
 import chalk from 'chalk'
 import checkForUpdates from './checkForUpdates'
 import pnpmCmds, { rcOptionsTypes } from './cmd'
diff --git a/packages/pnpm/tsconfig.json b/packages/pnpm/tsconfig.json
@@ -72,6 +72,9 @@
     {
       "path": "../plugin-commands-audit"
     },
+    {
+      "path": "../plugin-commands-env"
+    },
     {
       "path": "../plugin-commands-import"
     },
@@ -81,9 +84,6 @@
     {
       "path": "../plugin-commands-listing"
     },
-    {
-      "path": "../plugin-commands-nvm"
-    },
     {
       "path": "../plugin-commands-outdated"
     },
diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml

-Original file line number
+Diff line change
@@ @@ -0,0 +1,5 @@ @@
 +---
 +"@pnpm/plugin-commands-env": patch
 +---
++
 +New command added: `pnpm env use --global <version>`. This command installs the specified Node.js version globally.
Original file line number	Diff line number	Diff line change
`@@ -1,4 +1,4 @@`
`1`		`-# @pnpm/plugin-commands-nvm`
	`1`	`+# @pnpm/plugin-commands-env`
`2`	`2`
`3`	`3`	`## 0.2.8`
`4`	`4`