fix(netlify): allow writing config.json (#2264)

docs/2.deploy/20.providers/netlify.md

@@ -46,3 +46,7 @@ Make sure the publish directory is set to `dist` when creating a new project.
 On-demand Builders are serverless functions used to generate web content as needed that’s automatically cached on Netlify’s Edge CDN. They enable you to build pages for your site when a user visits them for the first time and then cache them at the edge for subsequent visits.
 
 :read-more{title="Netlify On-demand Builders" to="https://docs.netlify.com/configure-builds/on-demand-builders/"}
+
+## Custom deploy configuration
+
+You can provide additional deploy configuration using the `netlify` key inside `nitro.config`. It will be merged with built-in auto-generated config. Currently the only supported value is `images.remote_images`, for [configuring Netlify Image CDN](https://docs.netlify.com/image-cdn/create-integration/).

src/presets/netlify.ts

@@ -25,6 +25,19 @@ export const netlify = defineNitroPreset({
  await writeHeaders(nitro);
  await writeRedirects(nitro);
 
+ if (nitro.options.netlify) {
+ const configPath = join(
+ nitro.options.output.dir,
+ "../deploy/v1/config.json"
+ );
+ await fsp.mkdir(dirname(configPath), { recursive: true });
+ await fsp.writeFile(
+ configPath,
+ JSON.stringify(nitro.options.netlify),
+ "utf8"
+ );
+ }
+
  const functionConfig = {
  config: { nodeModuleFormat: "esm" },
  version: 1,

src/types/presets/index.ts

@@ -2,12 +2,14 @@ import { AWSAmplifyOptions } from "./aws-amplify";
 import { AzureOptions } from "./azure";
 import { CloudflareOptions } from "./cloudflare";
 import { FirebaseOptions } from "./firebase";
+import { NetlifyOptions } from "./netlify";
 import { VercelOptions } from "./vercel";
 
 export interface PresetOptions {
+ awsAmplify: AWSAmplifyOptions;
  azure: AzureOptions;
  cloudflare: CloudflareOptions;
  firebase: FirebaseOptions;
+ netlify: NetlifyOptions;
  vercel: VercelOptions;
- awsAmplify: AWSAmplifyOptions;
 }

src/types/presets/netlify.ts

@@ -0,0 +1,12 @@
+/**
+ * Netlify options
+ */
+export interface NetlifyOptions {
+ images?: {
+ /**
+ * Permitted remote image sources. Array of regex strings.
+ * @see https://docs.netlify.com/image-cdn/overview/#remote-path
+ */
+ remote_images?: string[];
+ };
+}

test/presets/netlify.test.ts

@@ -11,6 +11,11 @@ describe("nitro:preset:netlify", async () => {
  output: {
  publicDir: resolve(getPresetTmpDir("netlify"), "dist"),
  },
+ netlify: {
+ images: {
+ remote_images: ["https://example.com/.*"],
+ },
+ },
  },
  });
  testNitro(
@@ -90,6 +95,20 @@ describe("nitro:preset:netlify", async () => {
  `);
  /* eslint-enable no-tabs */
  });
+ it("should write config.json", async () => {
+ const config = await fsp
+ .readFile(resolve(ctx.outDir, "../deploy/v1/config.json"), "utf8")
+ .then((r) => JSON.parse(r));
+ expect(config).toMatchInlineSnapshot(`
+ {
+ "images": {
+ "remote_images": [
+ "https://example.com/.*",
+ ],
+ },
+ }
+ `);
+ });
  }
  );
 });