netlify-cli 18.0.4 → 18.1.0

package/dist/commands/recipes/recipes.d.ts

@@ -1,6 +1,6 @@
 import { OptionValues } from 'commander';
 import BaseCommand from '../base-command.js';
-interface RunRecipeOptions {
+export interface RunRecipeOptions {
     args: string[];
     command?: BaseCommand;
     config: unknown;
@@ -9,5 +9,4 @@ interface RunRecipeOptions {
 }
 export declare const runRecipe: ({ args, command, config, recipeName, repositoryRoot }: RunRecipeOptions) => Promise<any>;
 export declare const recipesCommand: (recipeName: string, options: OptionValues, command: BaseCommand) => Promise<any>;
-export {};
 //# sourceMappingURL=recipes.d.ts.map

package/dist/commands/recipes/recipes.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../../../src/commands/recipes/recipes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAKxC,OAAO,WAAW,MAAM,oBAAoB,CAAA;AAM5C,UAAU,gBAAgB;IACxB,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,eAAO,MAAM,SAAS,0DAAiE,gBAAgB,iBAItG,CAAA;AAED,eAAO,MAAM,cAAc,eAAsB,MAAM,WAAW,YAAY,WAAW,WAAW,KAAG,OAAO,CAAC,GAAG,CAgDjH,CAAA"}
+{"version":3,"file":"recipes.d.ts","sourceRoot":"","sources":["../../../src/commands/recipes/recipes.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,YAAY,EAAE,MAAM,WAAW,CAAA;AAKxC,OAAO,WAAW,MAAM,oBAAoB,CAAA;AAM5C,MAAM,WAAW,gBAAgB;IAC/B,IAAI,EAAE,MAAM,EAAE,CAAA;IACd,OAAO,CAAC,EAAE,WAAW,CAAA;IACrB,MAAM,EAAE,OAAO,CAAA;IACf,UAAU,EAAE,MAAM,CAAA;IAClB,cAAc,EAAE,MAAM,CAAA;CACvB;AAED,eAAO,MAAM,SAAS,0DAAiE,gBAAgB,iBAItG,CAAA;AAED,eAAO,MAAM,cAAc,eAAsB,MAAM,WAAW,YAAY,WAAW,WAAW,KAAG,OAAO,CAAC,GAAG,CAgDjH,CAAA"}

package/dist/recipes/ai-context/context.d.ts

@@ -0,0 +1,33 @@
+export declare const FILE_NAME = "netlify-development.mdc";
+export declare const NETLIFY_PROVIDER = "netlify";
+export declare const downloadFile: (cliVersion: string) => Promise<{
+    contents: string;
+    minimumCLIVersion: string | undefined;
+} | null>;
+interface ParsedContextFile {
+    contents: string;
+    innerContents?: string;
+    overrides?: {
+        contents?: string;
+        innerContents?: string;
+    };
+    provider?: string;
+    version?: string;
+}
+/**
+ * Parses the `<ProviderContext>` and `<ProviderContextOverrides>` blocks in
+ * a context file.
+ */
+export declare const parseContextFile: (contents: string) => ParsedContextFile;
+/**
+ * Takes a context file (a template) and injects a string in an overrides block
+ * if one is found. Returns the resulting context file.
+ */
+export declare const applyOverrides: (template: string, overrides?: string) => string;
+/**
+ * Reads a file on disk and tries to parse it as a context file.
+ */
+export declare const getExistingContext: (path: string) => Promise<ParsedContextFile | null>;
+export declare const writeFile: (path: string, contents: string) => Promise<void>;
+export {};
+//# sourceMappingURL=context.d.ts.map

package/dist/recipes/ai-context/context.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"context.d.ts","sourceRoot":"","sources":["../../../src/recipes/ai-context/context.ts"],"names":[],"mappings":"AAKA,eAAO,MAAM,SAAS,4BAA4B,CAAA;AAElD,eAAO,MAAM,gBAAgB,YAAY,CAAA;AAKzC,eAAO,MAAM,YAAY,eAAsB,MAAM;;;SAmBpD,CAAA;AAED,UAAU,iBAAiB;IACzB,QAAQ,EAAE,MAAM,CAAA;IAChB,aAAa,CAAC,EAAE,MAAM,CAAA;IACtB,SAAS,CAAC,EAAE;QACV,QAAQ,CAAC,EAAE,MAAM,CAAA;QACjB,aAAa,CAAC,EAAE,MAAM,CAAA;KACvB,CAAA;IACD,QAAQ,CAAC,EAAE,MAAM,CAAA;IACjB,OAAO,CAAC,EAAE,MAAM,CAAA;CACjB;AAED;;;GAGG;AACH,eAAO,MAAM,gBAAgB,aAAc,MAAM,sBA0ChD,CAAA;AAED;;;GAGG;AACH,eAAO,MAAM,cAAc,aAAc,MAAM,cAAc,MAAM,WASlE,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,kBAAkB,SAAgB,MAAM,sCAqBpD,CAAA;AAED,eAAO,MAAM,SAAS,SAAgB,MAAM,YAAY,MAAM,kBAK7D,CAAA"}

package/dist/recipes/ai-context/context.js

@@ -0,0 +1,100 @@
+import { promises as fs } from 'node:fs';
+import { dirname } from 'node:path';
+const ATTRIBUTES_REGEX = /(\S*)="([^\s"]*)"/gim;
+const BASE_URL = 'https://docs.netlify.com/ai-context';
+export const FILE_NAME = 'netlify-development.mdc';
+const MINIMUM_CLI_VERSION_HEADER = 'x-cli-min-ver';
+export const NETLIFY_PROVIDER = 'netlify';
+const PROVIDER_CONTEXT_REGEX = /<providercontext ([^>]*)>(.*)<\/providercontext>/ims;
+const PROVIDER_CONTEXT_OVERRIDES_REGEX = /<providercontextoverrides([^>]*)>(.*)<\/providercontextoverrides>/ims;
+const PROVIDER_CONTEXT_OVERRIDES_TAG = 'ProviderContextOverrides';
+export const downloadFile = async (cliVersion) => {
+    try {
+        const res = await fetch(`${BASE_URL}/${FILE_NAME}`, {
+            headers: {
+                'user-agent': `NetlifyCLI ${cliVersion}`,
+            },
+        });
+        const contents = await res.text();
+        const minimumCLIVersion = res.headers.get(MINIMUM_CLI_VERSION_HEADER) ?? undefined;
+        return {
+            contents,
+            minimumCLIVersion,
+        };
+    }
+    catch {
+        // no-op
+    }
+    return null;
+};
+/**
+ * Parses the `<ProviderContext>` and `<ProviderContextOverrides>` blocks in
+ * a context file.
+ */
+export const parseContextFile = (contents) => {
+    const result = {
+        contents,
+    };
+    const providerContext = contents.match(PROVIDER_CONTEXT_REGEX);
+    if (providerContext) {
+        const [, attributes, innerContents] = providerContext;
+        result.innerContents = innerContents;
+        for (const [, name, value] of attributes.matchAll(ATTRIBUTES_REGEX)) {
+            switch (name.toLowerCase()) {
+                case 'provider':
+                    result.provider = value;
+                    break;
+                case 'version':
+                    result.version = value;
+                    break;
+                default:
+                    continue;
+            }
+        }
+    }
+    const contextOverrides = contents.match(PROVIDER_CONTEXT_OVERRIDES_REGEX);
+    if (contextOverrides) {
+        const [overrideContents, , innerContents] = contextOverrides;
+        result.overrides = {
+            contents: overrideContents,
+            innerContents,
+        };
+    }
+    return result;
+};
+/**
+ * Takes a context file (a template) and injects a string in an overrides block
+ * if one is found. Returns the resulting context file.
+ */
+export const applyOverrides = (template, overrides) => {
+    if (!overrides) {
+        return template;
+    }
+    return template.replace(PROVIDER_CONTEXT_OVERRIDES_REGEX, `<${PROVIDER_CONTEXT_OVERRIDES_TAG}>${overrides}</${PROVIDER_CONTEXT_OVERRIDES_TAG}>`);
+};
+/**
+ * Reads a file on disk and tries to parse it as a context file.
+ */
+export const getExistingContext = async (path) => {
+    try {
+        const stats = await fs.stat(path);
+        if (!stats.isFile()) {
+            throw new Error(`${path} already exists but is not a file. Please remove it or rename it and try again.`);
+        }
+        const file = await fs.readFile(path, 'utf8');
+        const parsedFile = parseContextFile(file);
+        return parsedFile;
+    }
+    catch (error) {
+        const exception = error;
+        if (exception.code !== 'ENOENT') {
+            throw new Error(`Could not open context file at ${path}: ${exception.message}`);
+        }
+        return null;
+    }
+};
+export const writeFile = async (path, contents) => {
+    const directory = dirname(path);
+    await fs.mkdir(directory, { recursive: true });
+    await fs.writeFile(path, contents);
+};

package/dist/recipes/ai-context/index.d.ts

@@ -0,0 +1,4 @@
+import type { RunRecipeOptions } from '../../commands/recipes/recipes.js';
+export declare const description = "Manage context files for AI tools";
+export declare const run: ({ args, command }: RunRecipeOptions) => Promise<void>;
+//# sourceMappingURL=index.d.ts.map

package/dist/recipes/ai-context/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/recipes/ai-context/index.ts"],"names":[],"mappings":"AAKA,OAAO,KAAK,EAAE,gBAAgB,EAAE,MAAM,mCAAmC,CAAA;AAazE,eAAO,MAAM,WAAW,sCAAsC,CAAA;AAuC9D,eAAO,MAAM,GAAG,sBAA6B,gBAAgB,kBAuE5D,CAAA"}

package/dist/recipes/ai-context/index.js

@@ -0,0 +1,85 @@
+import { resolve } from 'node:path';
+import inquirer from 'inquirer';
+import semver from 'semver';
+import { chalk, error, log, version } from '../../utils/command-helpers.js';
+import { applyOverrides, downloadFile, getExistingContext, parseContextFile, writeFile, FILE_NAME, NETLIFY_PROVIDER, } from './context.js';
+export const description = 'Manage context files for AI tools';
+const presets = [
+    { name: 'Cursor rules (.cursor/rules/)', value: '.cursor/rules' },
+    { name: 'Custom location', value: '' },
+];
+const promptForPath = async () => {
+    const { presetPath } = await inquirer.prompt([
+        {
+            name: 'presetPath',
+            message: 'Where should we put the context files?',
+            type: 'list',
+            choices: presets,
+        },
+    ]);
+    if (presetPath) {
+        return presetPath;
+    }
+    const { customPath } = await inquirer.prompt([
+        {
+            type: 'input',
+            name: 'customPath',
+            message: 'Enter the path, relative to the project root, where the context files should be placed',
+            default: './ai-context',
+        },
+    ]);
+    if (customPath) {
+        return customPath;
+    }
+    log('You must select a path.');
+    return promptForPath();
+};
+export const run = async ({ args, command }) => {
+    // Start the download in the background while we wait for the prompts.
+    // eslint-disable-next-line promise/prefer-await-to-then
+    const download = downloadFile(version).catch(() => null);
+    const filePath = args[0] || (await promptForPath());
+    const { contents: downloadedFile, minimumCLIVersion } = (await download) ?? {};
+    if (!downloadedFile) {
+        error('An error occurred when pulling the latest context files. Please try again.');
+        return;
+    }
+    if (minimumCLIVersion && semver.lt(version, minimumCLIVersion)) {
+        error(`This command requires version ${minimumCLIVersion} or above of the Netlify CLI. Refer to ${chalk.underline('https://ntl.fyi/update-cli')} for information on how to update.`);
+        return;
+    }
+    const absoluteFilePath = resolve(command?.workingDir ?? '', filePath, FILE_NAME);
+    const existing = await getExistingContext(absoluteFilePath);
+    const remote = parseContextFile(downloadedFile);
+    let { contents } = remote;
+    // Does a file already exist at this path?
+    if (existing) {
+        // If it's a file we've created, let's check the version and bail if we're
+        // already on the latest, otherwise rewrite it with the latest version.
+        if (existing.provider?.toLowerCase() === NETLIFY_PROVIDER) {
+            if (remote?.version === existing.version) {
+                log(`You're all up to date! ${chalk.underline(absoluteFilePath)} contains the latest version of the context files.`);
+                return;
+            }
+            // We must preserve any overrides found in the existing file.
+            contents = applyOverrides(remote.contents, existing.overrides?.innerContents);
+        }
+        else {
+            // If this is not a file we've created, we can offer to overwrite it and
+            // preserve the existing contents by moving it to the overrides slot.
+            const { confirm } = await inquirer.prompt({
+                type: 'confirm',
+                name: 'confirm',
+                message: `A context file already exists at ${chalk.underline(absoluteFilePath)}. It has not been created by the Netlify CLI, but we can update it while preserving its existing content. Can we proceed?`,
+                default: true,
+            });
+            if (!confirm) {
+                return;
+            }
+            // Whatever exists in the file goes in the overrides block.
+            contents = applyOverrides(remote.contents, existing.contents);
+        }
+    }
+    await writeFile(absoluteFilePath, contents);
+    log(`${existing ? 'Updated' : 'Created'} context files at ${chalk.underline(absoluteFilePath)}`);
+};