experimental: support package.json#engines for use and install (#…

…839) Co-authored-by: Gal Schlezinger <gal@spitfire.co.il>
Schniz · Jul 6, 2023 · 97be792 · 97be792
1 parent 30deaf9
commit 97be792
Show file tree

Hide file tree

Showing 14 changed files with 296 additions and 19 deletions.
diff --git a/.changeset/warm-parrots-drive.md b/.changeset/warm-parrots-drive.md
@@ -0,0 +1,5 @@
+---
+"fnm": minor
+---
+
+Support resolving `engines.node` field via experimental `--resolve-engines` flag
diff --git a/docs/commands.md b/docs/commands.md
@@ -59,6 +59,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 
@@ -112,6 +119,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -162,6 +176,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -222,6 +243,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -282,6 +310,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -347,6 +382,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -402,6 +444,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -459,6 +508,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -513,6 +569,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -569,6 +632,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -619,6 +689,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -681,6 +758,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```
@@ -737,6 +821,13 @@ Options:
 
           [env: FNM_COREPACK_ENABLED]
 
+      --resolve-engines
+          Resolve `engines.node` field in `package.json` whenever a `.node-version` or `.nvmrc` file is not present.
+          Experimental: This feature is subject to change.
+          Note: `engines.node` can be any semver range, with the latest satisfying version being resolved.
+
+          [env: FNM_RESOLVE_ENGINES]
+
   -h, --help
           Print help (see a summary with '-h')
 ```

diff --git a/e2e/__snapshots__/basic.test.ts.snap b/e2e/__snapshots__/basic.test.ts.snap
@@ -42,6 +42,28 @@ if [ "$(node --version)" != "v8.11.3" ]; then
 fi"
 `;
 
+exports[`Bash package.json engines.node with semver range: Bash 1`] = `
+"set -e
+eval "$(fnm env --resolve-engines)"
+fnm install
+fnm use
+if [ "$(node --version)" != "v6.17.0" ]; then
+  echo "Expected node version to be v6.17.0. Got $(node --version)"
+  exit 1
+fi"
+`;
+
+exports[`Bash package.json engines.node: Bash 1`] = `
+"set -e
+eval "$(fnm env --resolve-engines)"
+fnm install
+fnm use
+if [ "$(node --version)" != "v8.11.3" ]; then
+  echo "Expected node version to be v8.11.3. Got $(node --version)"
+  exit 1
+fi"
+`;
+
 exports[`Bash resolves partial semver: Bash 1`] = `
 "set -e
 eval "$(fnm env)"
@@ -118,6 +140,28 @@ if test "$____test____" != "v8.11.3"
 end"
 `;
 
+exports[`Fish package.json engines.node with semver range: Fish 1`] = `
+"fnm env --resolve-engines | source
+fnm install
+fnm use
+set ____test____ (node --version)
+if test "$____test____" != "v6.17.0"
+  echo "Expected node version to be v6.17.0. Got $____test____"
+  exit 1
+end"
+`;
+
+exports[`Fish package.json engines.node: Fish 1`] = `
+"fnm env --resolve-engines | source
+fnm install
+fnm use
+set ____test____ (node --version)
+if test "$____test____" != "v8.11.3"
+  echo "Expected node version to be v8.11.3. Got $____test____"
+  exit 1
+end"
+`;
+
 exports[`Fish resolves partial semver: Fish 1`] = `
 "fnm env | source
 fnm install 6
@@ -182,6 +226,22 @@ fnm use v8.11.3
 if ( "$(node --version)" -ne "v8.11.3" ) { echo "Expected node version to be v8.11.3. Got $(node --version)"; exit 1 }"
 `;
 
+exports[`PowerShell package.json engines.node with semver range: PowerShell 1`] = `
+"$ErrorActionPreference = "Stop"
+fnm env --resolve-engines | Out-String | Invoke-Expression
+fnm install
+fnm use
+if ( "$(node --version)" -ne "v6.17.0" ) { echo "Expected node version to be v6.17.0. Got $(node --version)"; exit 1 }"
+`;
+
+exports[`PowerShell package.json engines.node: PowerShell 1`] = `
+"$ErrorActionPreference = "Stop"
+fnm env --resolve-engines | Out-String | Invoke-Expression
+fnm install
+fnm use
+if ( "$(node --version)" -ne "v8.11.3" ) { echo "Expected node version to be v8.11.3. Got $(node --version)"; exit 1 }"
+`;
+
 exports[`PowerShell resolves partial semver: PowerShell 1`] = `
 "$ErrorActionPreference = "Stop"
 fnm env | Out-String | Invoke-Expression
@@ -249,6 +309,28 @@ if [ "$(node --version)" != "v8.11.3" ]; then
 fi"
 `;
 
+exports[`Zsh package.json engines.node with semver range: Zsh 1`] = `
+"set -e
+eval "$(fnm env --resolve-engines)"
+fnm install
+fnm use
+if [ "$(node --version)" != "v6.17.0" ]; then
+  echo "Expected node version to be v6.17.0. Got $(node --version)"
+  exit 1
+fi"
+`;
+
+exports[`Zsh package.json engines.node: Zsh 1`] = `
+"set -e
+eval "$(fnm env --resolve-engines)"
+fnm install
+fnm use
+if [ "$(node --version)" != "v8.11.3" ]; then
+  echo "Expected node version to be v8.11.3. Got $(node --version)"
+  exit 1
+fi"
+`;
+
 exports[`Zsh resolves partial semver: Zsh 1`] = `
 "set -e
 eval "$(fnm env)"

diff --git a/e2e/basic.test.ts b/e2e/basic.test.ts
@@ -40,6 +40,34 @@ for (const shell of [Bash, Zsh, Fish, PowerShell, WinCmd]) {
         .execute(shell)
     })
 
+    test(`package.json engines.node`, async () => {
+      await writeFile(
+        join(testCwd(), "package.json"),
+        JSON.stringify({ engines: { node: "8.11.3" } })
+      )
+      await script(shell)
+        .then(shell.env({ resolveEngines: true }))
+        .then(shell.call("fnm", ["install"]))
+        .then(shell.call("fnm", ["use"]))
+        .then(testNodeVersion(shell, "v8.11.3"))
+        .takeSnapshot(shell)
+        .execute(shell)
+    })
+
+    test(`package.json engines.node with semver range`, async () => {
+      await writeFile(
+        join(testCwd(), "package.json"),
+        JSON.stringify({ engines: { node: "^6 < 6.17.1" } })
+      )
+      await script(shell)
+        .then(shell.env({ resolveEngines: true }))
+        .then(shell.call("fnm", ["install"]))
+        .then(shell.call("fnm", ["use"]))
+        .then(testNodeVersion(shell, "v6.17.0"))
+        .takeSnapshot(shell)
+        .execute(shell)
+    })
+
     test(`use on cd`, async () => {
       await mkdir(join(testCwd(), "subdir"), { recursive: true })
       await writeFile(join(testCwd(), "subdir", ".node-version"), "v12.22.12")

diff --git a/e2e/env.test.ts b/e2e/env.test.ts
@@ -26,6 +26,7 @@ for (const shell of [Bash, Zsh, Fish, PowerShell, WinCmd]) {
           FNM_LOGLEVEL: "info",
           FNM_MULTISHELL_PATH: expect.any(String),
           FNM_NODE_DIST_MIRROR: expect.any(String),
+          FNM_RESOLVE_ENGINES: "false",
           FNM_COREPACK_ENABLED: "false",
           FNM_VERSION_FILE_STRATEGY: "local",
         })

diff --git a/e2e/shellcode/shells.ts b/e2e/shellcode/shells.ts
@@ -61,7 +61,7 @@ export const PowerShell = {
   ...define<Shell>({
     binaryName: () => "pwsh",
     forceFile: ".ps1",
-    currentlySupported: () => true,
+    currentlySupported: () => process.platform === "win32",
     name: () => "PowerShell",
     launchArgs: () => ["-NoProfile"],
     escapeText: (x) => x,

diff --git a/e2e/shellcode/shells/cmdEnv.ts b/e2e/shellcode/shells/cmdEnv.ts
@@ -4,16 +4,18 @@ type EnvConfig = {
   useOnCd: boolean
   logLevel: string
   corepackEnabled: boolean
+  resolveEngines: boolean
 }
 export type HasEnv = { env(cfg: Partial<EnvConfig>): ScriptLine }
 
 function stringify(envConfig: Partial<EnvConfig> = {}) {
-  const { useOnCd, logLevel, corepackEnabled } = envConfig
+  const { useOnCd, logLevel, corepackEnabled, resolveEngines } = envConfig
   return [
     `fnm env`,
     useOnCd && "--use-on-cd",
     logLevel && `--log-level=${logLevel}`,
     corepackEnabled && "--corepack-enabled",
+    resolveEngines && `--resolve-engines`,
   ]
     .filter(Boolean)
     .join(" ")

diff --git a/src/commands/env.rs b/src/commands/env.rs
@@ -94,6 +94,7 @@ impl Command for Env {
                 "FNM_COREPACK_ENABLED",
                 config.corepack_enabled().to_string(),
             ),
+            ("FNM_RESOLVE_ENGINES", config.resolve_engines().to_string()),
             ("FNM_ARCH", config.arch.to_string()),
         ]);