feat: allow frameworks to detect version of CLI that's being used (#6226

)

* refactor: typescriptify a bit

* feat: inject Netlify CLI Version to build command

* chore: also test for ntl dev

* fix: dont show internal variables in env:list

src/commands/base-command.ts

@@ -26,6 +26,7 @@ import {
   exit,
   getToken,
   log,
+  netlifyCliVersion,
   normalizeConfig,
   padLeft,
   pollForToken,
@@ -546,7 +547,8 @@ export default class BaseCommand extends Command {
       token,
       ...apiUrlOpts,
     })
-    const { buildDir, config, configPath, repositoryRoot, siteInfo } = cachedConfig
+    const { buildDir, config, configPath, env, repositoryRoot, siteInfo } = cachedConfig
+    env.NETLIFY_CLI_VERSION = { sources: ['internal'], value: netlifyCliVersion }
     const normalizedConfig = normalizeConfig(config)
     const agent = await getAgent({
       httpProxy: flags.httpProxy,

src/commands/env/env-list.ts

@@ -61,8 +61,10 @@ export const envList = async (options: OptionValues, command: BaseCommand) => {
 
   // filter out general sources
   environment = Object.fromEntries(
-    // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
-    Object.entries(environment).filter(([, variable]) => variable.sources[0] !== 'general'),
+    Object.entries(environment).filter(
+      // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+      ([, variable]) => variable.sources[0] !== 'general' && variable.sources[0] !== 'internal',
+    ),
   )
 
   // Return json response for piping commands

src/utils/command-helpers.ts

@@ -50,7 +50,8 @@ const arch = os.arch() === 'ia32' ? 'x86' : os.arch()
 
 const { name, version } = await getPackageJson()
 
-export const USER_AGENT = `${name}/${version} ${platform}-${arch} node-${process.version}`
+export const netlifyCliVersion = version
+export const USER_AGENT = `${name}/${netlifyCliVersion} ${platform}-${arch} node-${process.version}`
 
 /** A list of base command flags that needs to be sorted down on documentation and on help pages */
 const BASE_FLAGS = new Set(['--debug', '--httpProxy', '--httpProxyCertificateFilename'])

tests/integration/commands/build/build.test.js

@@ -1,4 +1,5 @@
 import path from 'path'
+import process from 'process'
 
 import execa from 'execa'
 import { describe, test } from 'vitest'
@@ -38,7 +39,11 @@ const runBuildCommand = async function (
     outputs = [outputs]
   }
   outputs.forEach((output) => {
-    t.expect(all.includes(output), `Output of build command does not include '${output}'`).toBe(true)
+    if (output instanceof RegExp) {
+      t.expect(all).toMatch(output)
+    } else {
+      t.expect(all.includes(output), `Output of build command does not include '${output}'`).toBe(true)
+    }
   })
   t.expect(exitCode).toBe(expectedExitCode)
 }
@@ -286,4 +291,26 @@ describe.concurrent('command/build', () => {
       })
     })
   })
+
+  test('should have version in NETLIFY_CLI_VERSION variable', async (t) => {
+    await withSiteBuilder('NETLIFY_CLI_VERSION-env', async (builder) => {
+      await builder
+        .withNetlifyToml({
+          config: {
+            build: {
+              command:
+                process.platform === 'win32'
+                  ? 'echo NETLIFY_CLI_VERSION=%NETLIFY_CLI_VERSION%'
+                  : 'echo NETLIFY_CLI_VERSION=$NETLIFY_CLI_VERSION',
+            },
+          },
+        })
+        .build()
+
+      await runBuildCommand(t, builder.directory, {
+        output: /NETLIFY_CLI_VERSION=\d+\.\d+.\d+/,
+        flags: ['--offline'],
+      })
+    })
+  })
 })

tests/integration/commands/dev/dev.config.test.js

@@ -142,6 +142,41 @@ describe.concurrent('commands/dev/config', () => {
     })
   })
 
+  test('should provide CLI version in env var', async (t) => {
+    await withSiteBuilder('site-with-netlify-version-env-var', async (builder) => {
+      await builder
+        .withContentFile({
+          content: `
+          import http from "http";
+
+          http.createServer((req, res) => {
+            res.write(JSON.stringify({
+              NETLIFY_CLI_VERSION: process.env.NETLIFY_CLI_VERSION,
+            }))
+            res.end()
+          }).listen(1234);
+          `,
+          path: 'devserver.mjs',
+        })
+        .withNetlifyToml({
+          config: {
+            dev: {
+              framework: '#custom',
+              command: 'node devserver.mjs',
+              targetPort: 1234,
+            },
+          },
+        })
+        .build()
+
+      await withDevServer({ cwd: builder.directory }, async (server) => {
+        const resp = await fetch(server.url)
+        const { NETLIFY_CLI_VERSION } = await resp.json()
+        t.expect(NETLIFY_CLI_VERSION).toMatch(/\d+\.\d+\.\d+/)
+      })
+    })
+  })
+
   test('should set value of the CONTEXT env variable', async (t) => {
     await withSiteBuilder('site-with-context-override', async (builder) => {
       builder.withNetlifyToml({ config: { functions: { directory: 'functions' } } }).withFunction({