netlify-cli 17.3.2 → 17.4.0

package/src/commands/watch/watch.mjs

@@ -1,19 +1,14 @@
-// @ts-check
-import pWaitFor from 'p-wait-for'
-import prettyjson from 'prettyjson'
-
-import { startSpinner, stopSpinner } from '../../lib/spinner.mjs'
-import { chalk, error, log } from '../../utils/command-helpers.mjs'
-import { init } from '../init/index.mjs'
-
+import pWaitFor from 'p-wait-for';
+import prettyjson from 'prettyjson';
+import { startSpinner, stopSpinner } from '../../lib/spinner.mjs';
+import { chalk, error, log } from '../../utils/command-helpers.mjs';
+import { init } from '../init/index.mjs';
 // 1 second
-const INIT_WAIT = 1e3
-
+const INIT_WAIT = 1e3;
 // 1 second
-const BUILD_FINISH_INTERVAL = 1e3
+const BUILD_FINISH_INTERVAL = 1e3;
 // 20 minutes
-const BUILD_FINISH_TIMEOUT = 12e5
-
+const BUILD_FINISH_TIMEOUT = 12e5;
 /**
  *
  * @param {import('netlify').NetlifyAPI} api
@@ -21,111 +16,102 @@ const BUILD_FINISH_TIMEOUT = 12e5
  * @param {import('ora').Ora} spinner
  * @returns {Promise<boolean>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'api' implicitly has an 'any' type.
 const waitForBuildFinish = async function (api, siteId, spinner) {
-  let firstPass = true
-
-  const waitForBuildToFinish = async function () {
-    const builds = await api.listSiteBuilds({ siteId })
-    // build.error
-    const currentBuilds = builds.filter((build) => !build.done)
-
-    // if build.error
-    // @TODO implement build error messages into this
-
-    if (!currentBuilds || currentBuilds.length === 0) {
-      stopSpinner({ spinner })
-      return true
-    }
-    firstPass = false
-    return false
-  }
-
-  await pWaitFor(waitForBuildToFinish, {
-    interval: BUILD_FINISH_INTERVAL,
-    timeout: {
-      milliseconds: BUILD_FINISH_TIMEOUT,
-      message: 'Timeout while waiting for deploy to finish',
-    },
-  })
-
-  // return only when build done or timeout happens
-  return firstPass
-}
-
+    let firstPass = true;
+    const waitForBuildToFinish = async function () {
+        const builds = await api.listSiteBuilds({ siteId });
+        // build.error
+        // @ts-expect-error TS(7006) FIXME: Parameter 'build' implicitly has an 'any' type.
+        const currentBuilds = builds.filter((build) => !build.done);
+        // if build.error
+        // @TODO implement build error messages into this
+        if (!currentBuilds || currentBuilds.length === 0) {
+            // @ts-expect-error TS(2345) FIXME: Argument of type '{ spinner: any; }' is not assign... Remove this comment to see the full error message
+            stopSpinner({ spinner });
+            return true;
+        }
+        firstPass = false;
+        return false;
+    };
+    await pWaitFor(waitForBuildToFinish, {
+        interval: BUILD_FINISH_INTERVAL,
+        timeout: {
+            milliseconds: BUILD_FINISH_TIMEOUT,
+            message: 'Timeout while waiting for deploy to finish',
+        },
+    });
+    // return only when build done or timeout happens
+    return firstPass;
+};
 /**
  * The watch command
  * @param {import('commander').OptionValues} options
  * @param {import('../base-command.mjs').default} command
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 const watch = async (options, command) => {
-  await command.authenticate()
-  const client = command.netlify.api
-  let siteId = command.netlify.site.id
-
-  if (!siteId) {
-    // TODO: build init command
-    const siteData = await init({}, command)
-    siteId = siteData.id
-  }
-
-  // wait for 1 sec for everything to kickoff
-  console.time('Deploy time')
-  await new Promise((resolve) => {
-    setTimeout(() => resolve(), INIT_WAIT)
-  })
-
-  // Get latest commit and look for that
-  // git rev-parse HEAD
-
-  // if no sha, its a manual "triggered deploy"
-  //
-  // {
-  //     "id": "5b4e23db82d3f1780abd74f3",
-  //     "deploy_id": "5b4e23db82d3f1780abd74f2",
-  //     "sha": "pull/1/head",
-  //     "log": [],
-  //     "done": false,
-  //     "error": null,
-  //     "created_at": "2018-07-17T17:14:03.423Z"
-  // }
-  //
-  const spinner = startSpinner({ text: 'Waiting for active site deploys to complete' })
-  try {
-    // Fetch all builds!
-    // const builds = await client.listSiteBuilds({siteId})
+    await command.authenticate();
+    const client = command.netlify.api;
+    let siteId = command.netlify.site.id;
+    if (!siteId) {
+        // TODO: build init command
+        const siteData = await init({}, command);
+        siteId = siteData.id;
+    }
+    // wait for 1 sec for everything to kickoff
+    console.time('Deploy time');
+    await new Promise((resolve) => {
+        // @ts-expect-error TS(2794) FIXME: Expected 1 arguments, but got 0. Did you forget to... Remove this comment to see the full error message
+        setTimeout(() => resolve(), INIT_WAIT);
+    });
+    // Get latest commit and look for that
+    // git rev-parse HEAD
+    // if no sha, its a manual "triggered deploy"
+    //
+    // {
+    //     "id": "5b4e23db82d3f1780abd74f3",
+    //     "deploy_id": "5b4e23db82d3f1780abd74f2",
+    //     "sha": "pull/1/head",
+    //     "log": [],
+    //     "done": false,
+    //     "error": null,
+    //     "created_at": "2018-07-17T17:14:03.423Z"
+    // }
     //
-    // // Filter down to any that are not done
-    // const buildsToWatch = builds.filter((build) => {
-    //   return !build.done
-    // })
-
-    const noActiveBuilds = await waitForBuildFinish(client, siteId, spinner)
-
-    const siteData = await client.getSite({ siteId })
-
-    const message = chalk.cyanBright.bold.underline(noActiveBuilds ? 'Last build' : 'Deploy complete')
-    log()
-    log(message)
-    log(
-      prettyjson.render({
-        URL: siteData.ssl_url || siteData.url,
-        Admin: siteData.admin_url,
-      }),
-    )
-    console.timeEnd('Deploy time')
-  } catch (error_) {
-    error(error_)
-  }
-}
-
+    const spinner = startSpinner({ text: 'Waiting for active site deploys to complete' });
+    try {
+        // Fetch all builds!
+        // const builds = await client.listSiteBuilds({siteId})
+        //
+        // // Filter down to any that are not done
+        // const buildsToWatch = builds.filter((build) => {
+        //   return !build.done
+        // })
+        const noActiveBuilds = await waitForBuildFinish(client, siteId, spinner);
+        const siteData = await client.getSite({ siteId });
+        const message = chalk.cyanBright.bold.underline(noActiveBuilds ? 'Last build' : 'Deploy complete');
+        log();
+        log(message);
+        log(prettyjson.render({
+            URL: siteData.ssl_url || siteData.url,
+            Admin: siteData.admin_url,
+        }));
+        console.timeEnd('Deploy time');
+    }
+    catch (error_) {
+        // @ts-expect-error TS(2345) FIXME: Argument of type 'unknown' is not assignable to pa... Remove this comment to see the full error message
+        error(error_);
+    }
+};
 /**
  * Creates the `netlify watch` command
  * @param {import('../base-command.mjs').default} program
  * @returns
  */
-export const createWatchCommand = (program) =>
-  program
+// @ts-expect-error TS(7006) FIXME: Parameter 'program' implicitly has an 'any' type.
+export const createWatchCommand = (program) => program
     .command('watch')
     .description('Watch for site deploy to finish')
     .addExamples([`netlify watch`, `git push && netlify watch`])
-    .action(watch)
+    .action(watch);

package/src/functions-templates/javascript/hello/{{name}}.js

@@ -1,5 +1,4 @@
-export default async (request) => {
-  return new Response('Hello, World!', {
+export default async (request) =>
+  new Response('Hello, World!', {
     headers: { 'content-type': 'text/html' },
   })
-}

package/src/lib/account.mjs

@@ -1,14 +1,13 @@
-// @ts-check
-
 /**
  * @param {any} account
  * @param {string} capability
  * @returns {boolean}
  */
-const supportsBooleanCapability = (account, capability) => Boolean(account?.capabilities?.[capability]?.included)
-
+// @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
+const supportsBooleanCapability = (account, capability) => Boolean(account?.capabilities?.[capability]?.included);
 /**
  * @param {any} account
  * @returns {boolean}
  */
-export const supportsBackgroundFunctions = (account) => supportsBooleanCapability(account, 'background_functions')
+// @ts-expect-error TS(7006) FIXME: Parameter 'account' implicitly has an 'any' type.
+export const supportsBackgroundFunctions = (account) => supportsBooleanCapability(account, 'background_functions');

package/src/lib/api.mjs

@@ -1,22 +1,24 @@
-import { warn } from '../utils/command-helpers.mjs'
-
+import { warn } from '../utils/command-helpers.mjs';
+// @ts-expect-error TS(7031) FIXME: Binding element 'api' implicitly has an 'any' type... Remove this comment to see the full error message
 export const cancelDeploy = async ({ api, deployId }) => {
-  try {
-    await api.cancelSiteDeploy({ deploy_id: deployId })
-  } catch (error) {
-    warn(`Failed canceling deploy with id ${deployId}: ${error.message}`)
-  }
-}
-
-const FIRST_PAGE = 1
-const MAX_PAGES = 10
-const MAX_PER_PAGE = 100
+    try {
+        await api.cancelSiteDeploy({ deploy_id: deployId });
+    }
+    catch (error) {
+        // @ts-expect-error TS(2571) FIXME: Object is of type 'unknown'.
+        warn(`Failed canceling deploy with id ${deployId}: ${error.message}`);
+    }
+};
+const FIRST_PAGE = 1;
+const MAX_PAGES = 10;
+const MAX_PER_PAGE = 100;
+// @ts-expect-error TS(7023) FIXME: 'listSites' implicitly has return type 'any' becau... Remove this comment to see the full error message
 export const listSites = async ({ api, options }) => {
-  const { maxPages = MAX_PAGES, page = FIRST_PAGE, ...rest } = options
-  const sites = await api.listSites({ page, per_page: MAX_PER_PAGE, ...rest })
-  // TODO: use pagination headers when js-client returns them
-  if (sites.length === MAX_PER_PAGE && page + 1 <= maxPages) {
-    return [...sites, ...(await listSites({ api, options: { page: page + 1, maxPages, ...rest } }))]
-  }
-  return sites
-}
+    const { maxPages = MAX_PAGES, page = FIRST_PAGE, ...rest } = options;
+    const sites = await api.listSites({ page, per_page: MAX_PER_PAGE, ...rest });
+    // TODO: use pagination headers when js-client returns them
+    if (sites.length === MAX_PER_PAGE && page + 1 <= maxPages) {
+        return [...sites, ...(await listSites({ api, options: { page: page + 1, maxPages, ...rest } }))];
+    }
+    return sites;
+};

package/src/lib/blobs/blobs.mjs

@@ -1,50 +1,41 @@
-import path from 'path'
-
-import { BlobsServer } from '@netlify/blobs'
-import { v4 as uuidv4 } from 'uuid'
-
-import { getPathInProject } from '../settings.mjs'
-
-/**
- * @typedef BlobsContext
- * @type {object}
- * @property {string} edgeURL
- * @property {string} deployID
- * @property {string} siteID
- * @property {string} token
- */
-
+import path from 'path';
+import { BlobsServer } from '@netlify/blobs';
+import { v4 as uuidv4 } from 'uuid';
+import { log, NETLIFYDEVLOG } from '../../utils/command-helpers.mjs';
+import { getPathInProject } from '../settings.mjs';
+let hasPrintedLocalBlobsNotice = false;
+const printLocalBlobsNotice = () => {
+    if (hasPrintedLocalBlobsNotice) {
+        return;
+    }
+    hasPrintedLocalBlobsNotice = true;
+    log(`${NETLIFYDEVLOG} Netlify Blobs running in sandbox mode for local development. Refer to https://ntl.fyi/local-blobs for more information.`);
+};
+const startBlobsServer = async (debug, projectRoot, token) => {
+    const directory = path.resolve(projectRoot, getPathInProject(['blobs-serves']));
+    const server = new BlobsServer({
+        debug,
+        directory,
+        onRequest: () => {
+            printLocalBlobsNotice();
+        },
+        token,
+    });
+    const { port } = await server.start();
+    return { port };
+};
 /**
  * Starts a local Blobs server and returns a context object that lets functions
  * connect to it.
- *
- * @param {object} options
- * @param {boolean} options.debug
- * @param {string} options.projectRoot
- * @param {string} options.siteID
- * @returns {Promise<BlobsContext>}
  */
 export const getBlobsContext = async ({ debug, projectRoot, siteID }) => {
-  const token = uuidv4()
-  const { port } = await startBlobsServer({ debug, projectRoot, token })
-  const context = {
-    deployID: '0',
-    edgeURL: `http://localhost:${port}`,
-    siteID,
-    token,
-  }
-
-  return context
-}
-
-const startBlobsServer = async ({ debug, projectRoot, token }) => {
-  const directory = path.resolve(projectRoot, getPathInProject(['blobs']))
-  const server = new BlobsServer({
-    debug,
-    directory,
-    token,
-  })
-  const { port } = await server.start()
-
-  return { port }
-}
+    const token = uuidv4();
+    const { port } = await startBlobsServer(debug, projectRoot, token);
+    const context = {
+        deployID: '0',
+        edgeURL: `http://localhost:${port}`,
+        siteID,
+        token,
+    };
+    return context;
+};

package/src/lib/build.mjs

@@ -1,21 +1,16 @@
-// @ts-check
-import fs from 'fs'
-import process from 'process'
-
-import build from '@netlify/build'
-import tomlify from 'tomlify-j0.4'
-
-import { isFeatureFlagEnabled } from '../utils/feature-flags.mjs'
-
-import { getBootstrapURL } from './edge-functions/bootstrap.mjs'
-import { featureFlags as edgeFunctionsFeatureFlags } from './edge-functions/consts.mjs'
-
+import fs from 'fs';
+import process from 'process';
+import build from '@netlify/build';
+// @ts-expect-error TS(7016) FIXME: Could not find a declaration file for module 'toml... Remove this comment to see the full error message
+import tomlify from 'tomlify-j0.4';
+import { isFeatureFlagEnabled } from '../utils/feature-flags.mjs';
+import { getBootstrapURL } from './edge-functions/bootstrap.mjs';
+import { featureFlags as edgeFunctionsFeatureFlags } from './edge-functions/consts.mjs';
 /**
  * The buildConfig + a missing cachedConfig
  * @typedef BuildConfig
  * @type {Parameters<import('@netlify/build/src/core/main.js')>[0] & {cachedConfig: any}}
  */
-
 // We have already resolved the configuration using `@netlify/config`
 // This is stored as `netlify.cachedConfig` and can be passed to
 // `@netlify/build --cachedConfig`.
@@ -30,88 +25,90 @@ import { featureFlags as edgeFunctionsFeatureFlags } from './edge-functions/cons
  * @param {*} config.deployHandler
  * @returns {BuildConfig}
  */
-export const getBuildOptions = ({
-  cachedConfig,
-  currentDir,
-  deployHandler,
-  options: { context, cwd, debug, dry, json, offline, silent },
-  packagePath,
-  token,
-}) => {
-  const eventHandlers = {
-    onEnd: {
-      handler: ({ netlifyConfig }) => {
-        const string = tomlify.toToml(netlifyConfig)
-
-        if (!fs.existsSync(`${currentDir}/.netlify`)) {
-          fs.mkdirSync(`${currentDir}/.netlify`, { recursive: true })
-        }
-        fs.writeFileSync(`${currentDir}/.netlify/netlify.toml`, string)
-
-        return {}
-      },
-      description: 'Save updated config',
-    },
-  }
-
-  if (deployHandler) {
-    eventHandlers.onPostBuild = {
-      handler: deployHandler,
-      description: 'Deploy Site',
+export const getBuildOptions = ({ 
+// @ts-expect-error TS(7031) FIXME: Binding element 'cachedConfig' implicitly has an '... Remove this comment to see the full error message
+cachedConfig, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'currentDir' implicitly has an 'an... Remove this comment to see the full error message
+currentDir, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'deployHandler' implicitly has an ... Remove this comment to see the full error message
+deployHandler, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'context' implicitly has an 'any' ... Remove this comment to see the full error message
+options: { context, cwd, debug, dry, json, offline, silent }, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'packagePath' implicitly has an 'a... Remove this comment to see the full error message
+packagePath, 
+// @ts-expect-error TS(7031) FIXME: Binding element 'token' implicitly has an 'any' ty... Remove this comment to see the full error message
+token, }) => {
+    const eventHandlers = {
+        onEnd: {
+            // @ts-expect-error TS(7031) FIXME: Binding element 'netlifyConfig' implicitly has an ... Remove this comment to see the full error message
+            handler: ({ netlifyConfig }) => {
+                const string = tomlify.toToml(netlifyConfig);
+                if (!fs.existsSync(`${currentDir}/.netlify`)) {
+                    fs.mkdirSync(`${currentDir}/.netlify`, { recursive: true });
+                }
+                fs.writeFileSync(`${currentDir}/.netlify/netlify.toml`, string);
+                return {};
+            },
+            description: 'Save updated config',
+        },
+    };
+    if (deployHandler) {
+        // @ts-expect-error TS(2339) FIXME: Property 'onPostBuild' does not exist on type '{ o... Remove this comment to see the full error message
+        eventHandlers.onPostBuild = {
+            handler: deployHandler,
+            description: 'Deploy Site',
+        };
     }
-  }
-
-  return {
-    cachedConfig,
-    siteId: cachedConfig.siteInfo.id,
-    packagePath,
-    token,
-    dry,
-    debug,
-    context,
-    mode: 'cli',
-    telemetry: false,
-    // buffer = true will not stream output
-    buffer: json || silent,
-    offline,
-    cwd,
-    featureFlags: {
-      ...edgeFunctionsFeatureFlags,
-      ...getFeatureFlagsFromSiteInfo(cachedConfig.siteInfo),
-      functionsBundlingManifest: true,
-    },
-    eventHandlers,
-    edgeFunctionsBootstrapURL: getBootstrapURL(),
-  }
-}
-
+    return {
+        cachedConfig,
+        siteId: cachedConfig.siteInfo.id,
+        packagePath,
+        token,
+        dry,
+        debug,
+        context,
+        mode: 'cli',
+        telemetry: false,
+        // buffer = true will not stream output
+        buffer: json || silent,
+        offline,
+        cwd,
+        featureFlags: {
+            ...edgeFunctionsFeatureFlags,
+            ...getFeatureFlagsFromSiteInfo(cachedConfig.siteInfo),
+            functionsBundlingManifest: true,
+        },
+        eventHandlers,
+        edgeFunctionsBootstrapURL: getBootstrapURL(),
+    };
+};
 /**
  * @param {*} siteInfo
  * @returns {Record<string, any>}
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'siteInfo' implicitly has an 'any' type.
 const getFeatureFlagsFromSiteInfo = (siteInfo) => ({
-  ...siteInfo.feature_flags,
-  // see https://github.com/netlify/pod-dev-foundations/issues/581#issuecomment-1731022753
-  zisi_golang_use_al2: isFeatureFlagEnabled('cli_golang_use_al2', siteInfo),
-})
-
+    ...siteInfo.feature_flags,
+    // see https://github.com/netlify/pod-dev-foundations/issues/581#issuecomment-1731022753
+    zisi_golang_use_al2: isFeatureFlagEnabled('cli_golang_use_al2', siteInfo),
+});
 /**
  * run the build command
  * @param {BuildConfig} options
  * @returns
  */
+// @ts-expect-error TS(7006) FIXME: Parameter 'options' implicitly has an 'any' type.
 export const runBuild = async (options) => {
-  // If netlify NETLIFY_API_URL is set we need to pass this information to @netlify/build
-  // TODO don't use testOpts, but add real properties to do this.
-  if (process.env.NETLIFY_API_URL) {
-    const apiUrl = new URL(process.env.NETLIFY_API_URL)
-    const testOpts = {
-      scheme: apiUrl.protocol.slice(0, -1),
-      host: apiUrl.host,
+    // If netlify NETLIFY_API_URL is set we need to pass this information to @netlify/build
+    // TODO don't use testOpts, but add real properties to do this.
+    if (process.env.NETLIFY_API_URL) {
+        const apiUrl = new URL(process.env.NETLIFY_API_URL);
+        const testOpts = {
+            scheme: apiUrl.protocol.slice(0, -1),
+            host: apiUrl.host,
+        };
+        options = { ...options, testOpts };
     }
-    options = { ...options, testOpts }
-  }
-
-  const { configMutations, netlifyConfig: newConfig, severityCode: exitCode } = await build(options)
-  return { exitCode, newConfig, configMutations }
-}
+    const { configMutations, netlifyConfig: newConfig, severityCode: exitCode } = await build(options);
+    return { exitCode, newConfig, configMutations };
+};

package/src/lib/completion/constants.mjs

@@ -1,4 +1,2 @@
-// @ts-check
-import { getPathInHome } from '../settings.mjs'
-
-export const AUTOCOMPLETION_FILE = getPathInHome(['autocompletion.json'])
+import { getPathInHome } from '../settings.mjs';
+export const AUTOCOMPLETION_FILE = getPathInHome(['autocompletion.json']);