Create a basic, initial schema for firebase.json

schema/firebase-config.json

@@ -1221,6 +1221,34 @@
             ],
             "type": "object"
         },
+        "RunSingle": {
+            "additionalProperties": false,
+            "properties": {
+                "ignore": {
+                    "items": {
+                        "type": "string"
+                    },
+                    "type": "array"
+                },
+                "localBuild": {
+                    "type": "boolean"
+                },
+                "region": {
+                    "type": "string"
+                },
+                "rootDir": {
+                    "type": "string"
+                },
+                "serviceId": {
+                    "type": "string"
+                }
+            },
+            "required": [
+                "region",
+                "serviceId"
+            ],
+            "type": "object"
+        },
         "StorageSingle": {
             "additionalProperties": false,
             "properties": {
@@ -2008,6 +2036,19 @@
         "remoteconfig": {
             "$ref": "#/definitions/RemoteConfigConfig"
         },
+        "run": {
+            "anyOf": [
+                {
+                    "$ref": "#/definitions/RunSingle"
+                },
+                {
+                    "items": {
+                        "$ref": "#/definitions/RunSingle"
+                    },
+                    "type": "array"
+                }
+            ]
+        },
         "storage": {
             "anyOf": [
                 {

src/config.ts

@@ -34,23 +34,24 @@
     "apphosting",
     "auth",
     "ailogic",
+    "run",
   ];
 
   public options: any;
   public projectDir: string;
   public data: any = {};
   public defaults: any = {};
   public notes: any = {};
 
   private _src: any;
 
   /**
    * @param src incoming firebase.json source, parsed by not validated.
    * @param options command-line options.
    */
   constructor(src: any, options: any = {}) {
     this.options = options;
     this.projectDir = this.options.projectDir || detectProjectRoot(this.options);
     this._src = src;
 
     if (this._src.firebase) {

src/firebaseConfig.ts

@@ -366,6 +366,18 @@ export type AppHostingMultiple = AppHostingSingle[];
 
 export type AppHostingConfig = AppHostingSingle | AppHostingMultiple;
 
+export interface RunSingle {
+  serviceId: string;
+  region: string;
+  rootDir?: string;
+  ignore?: string[];
+  localBuild?: boolean;
+}
+
+export type RunMultiple = RunSingle[];
+
+export type RunConfig = RunSingle | RunMultiple;
+
 export interface AuthConfig {
   providers?: {
     anonymous?: boolean;
@@ -392,4 +404,5 @@ export type FirebaseConfig = {
   dataconnect?: DataConnectConfig;
   apphosting?: AppHostingConfig;
   auth?: AuthConfig;
+  run?: RunConfig;
 };

src/firebaseConfigValidate.spec.ts

@@ -24,6 +24,87 @@ describe("firebaseConfigValidate", () => {
     expect(isValid).to.be.true;
   });
 
+  function expectValidationError(
+    config: unknown,
+    keyword: string,
+    instancePath: string,
+    params: Record<string, unknown>,
+  ): void {
+    const validator = getValidator();
+    expect(validator(config)).to.be.false;
+    expect(
+      (validator.errors ?? []).some(
+        (e) =>
+          e.keyword === keyword &&
+          e.instancePath === instancePath &&
+          Object.entries(params).every(([k, v]) => e.params[k] === v),
+      ),
+    ).to.be.true;
+  }
+
+  it("should accept a valid run config", () => {
+    const config: FirebaseConfig = {
+      run: [
+        {
+          serviceId: "my-service",
+          region: "us-central1",
+          rootDir: ".",
+        },
+      ],
+    };
+
+    const validator = getValidator();
+    expect(validator(config)).to.be.true;
+  });
+
+  it("should accept a single-object run config", () => {
+    const config: FirebaseConfig = {
+      run: {
+        serviceId: "my-service",
+        region: "us-central1",
+        localBuild: true,
+      },
+    };
+
+    const validator = getValidator();
+    expect(validator(config)).to.be.true;
+  });
+
+  it("should reject a run config missing serviceId", () => {
+    expectValidationError(
+      { run: [{ region: "us-central1", rootDir: "." }] },
+      "required",
+      "/run/0",
+      {
+        missingProperty: "serviceId",
+      },
+    );
+  });
+
+  it("should reject a run config missing region", () => {
+    expectValidationError({ run: { serviceId: "my-service" } }, "required", "/run", {
+      missingProperty: "region",
+    });
+  });
+
+  it("should reject a run config with an unknown field", () => {
+    expectValidationError(
+      { run: { serviceId: "my-service", region: "us-central1", bananas: true } },
+      "additionalProperties",
+      "/run",
+      { additionalProperty: "bananas" },
+    );
+  });
+
+  it("should reject a run config with an incorrect type", () => {
+    expectValidationError(
+      { run: { serviceId: "my-service", region: "us-central1", localBuild: "yes" } },
+      "type",
+      "/run/localBuild",
+      { type: "boolean" },
+    );
+  });
+
   it("should report an extra top-level field", () => {
     // This config has an extra 'bananas' top-level property
     const config = {