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

src/commands/base-command.ts

@@ -26,6 +26,7 @@ import {
   exit,
   getToken,
   log,
+  netlifyCliVersion,
   normalizeConfig,
   padLeft,
   pollForToken,
@@ -38,6 +39,9 @@ import openBrowser from '../utils/open-browser.js'
 import StateConfig from '../utils/state-config.js'
 import { identify, reportError, track } from '../utils/telemetry/index.js'
 
+// eslint-disable-next-line @typescript-eslint/no-explicit-any
+type $FIXME = any
+
 // load the autocomplete plugin
 inquirer.registerPrompt('autocomplete', inquirerAutocompletePrompt)
 /** Netlify CLI client id. Lives in [email protected] */
@@ -229,7 +233,7 @@ export default class BaseCommand extends Command {
       }
       debug(`${name}:preAction`)('start')
       this.analytics = { startTime: process.hrtime.bigint() }
-      await this.init(actionCommand)
+      await this.init(actionCommand as BaseCommand)
       debug(`${name}:preAction`)('end')
     })
   }
@@ -521,8 +525,7 @@ export default class BaseCommand extends Command {
    * @param {BaseCommand} actionCommand The command of the action that is run (`this.` gets the parent command)
    * @private
    */
-  // @ts-expect-error TS(7006) FIXME: Parameter 'actionCommand' implicitly has an 'any' ... Remove this comment to see the full error message
-  async init(actionCommand) {
+  async init<C extends BaseCommand>(actionCommand: C) {
     debug(`${actionCommand.name()}:init`)('start')
     const flags = actionCommand.opts()
     // here we actually want to use the process.cwd as we are setting the workingDir
@@ -606,7 +609,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,
@@ -689,21 +693,19 @@ export default class BaseCommand extends Command {
 
   /**
    * Find and resolve the Netlify configuration
-   * @param {object} config
-   * @param {string} config.cwd
-   * @param {string|null=} config.token
-   * @param {*} config.state
-   * @param {boolean=} config.offline
-   * @param {string=} config.configFilePath An optional path to the netlify configuration file e.g. netlify.toml
-   * @param {string=} config.packagePath
-   * @param {string=} config.repositoryRoot
-   * @param {string=} config.host
-   * @param {string=} config.pathPrefix
-   * @param {string=} config.scheme
-   * @returns {ReturnType<typeof resolveConfig>}
    */
-  // @ts-expect-error TS(7023) FIXME: 'getConfig' implicitly has return type 'any' becau... Remove this comment to see the full error message
-  async getConfig(config) {
+  async getConfig(config: {
+    cwd: string
+    token?: string | null
+    state: $FIXME
+    offline?: boolean
+    configFilePath?: string
+    packagePath?: string
+    repositoryRoot?: string
+    host?: string
+    pathPrefix?: string
+    scheme?: string
+  }): Promise<ReturnType<typeof resolveConfig>> {
     // the flags that are passed to the command like `--debug` or `--offline`
     const flags = this.opts()
 

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

@@ -38,7 +38,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 +290,17 @@ 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: '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,17 @@ 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.withNetlifyToml({ config: { dev: { command: `node -e console.log(process.env)` } } }).build()
+
+      await withDevServer({ cwd: builder.directory }, async (server) => {
+        await server.close()
+        t.expect(server.output).toContain('NETLIFY_CLI_VERSION')
+      })
+    })
+  })
+
   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({