Generate JSON Schema for firebase.json

.github/workflows/node-test.yml

@@ -124,3 +124,21 @@ jobs:
           node-version: ${{ matrix.node-version }}
       - run: npm install --package-lock-only
       - run: "git diff --exit-code -- package-lock.json || (echo 'Error: package-lock.json is changed during npm install! Please make sure to use npm >= 6.9.0 and commit package-lock.json.' && false)"
+
+  check-json-schema:
+    runs-on: ubuntu-latest
+
+    strategy:
+      matrix:
+        node-version:
+          - 12.x
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Use Node.js ${{ matrix.node-version }}
+        uses: actions/setup-node@v2
+        with:
+          node-version: ${{ matrix.node-version }}
+      - run: npm install
+      - run: npm run generate:json-schema
+      - run: "git diff --exit-code -- schema/*.json || (echo 'Error: JSON schema is changed! Please run npm run generate:json-schema and commit the results.' && false)"

package.json

@@ -14,6 +14,7 @@
     "format:other": "npm run lint:other -- --write",
     "format:ts": "npm run lint:ts -- --fix --quiet",
     "generate:auth-api": "ts-node scripts/gen-auth-api-spec.ts",
+    "generate:json-schema": "typescript-json-schema --strictNullChecks --required --noExtraProps src/firebaseConfig.ts FirebaseConfig > schema/firebase-config.json",
     "lint": "npm run lint:ts && npm run lint:other",
     "lint:changed-files": "ts-node ./scripts/lint-changed-files.ts",
     "lint:other": "prettier --check '**/*.{md,yaml,yml}'",
@@ -85,6 +86,7 @@
     "@types/archiver": "^5.1.0",
     "JSONStream": "^1.2.1",
     "abort-controller": "^3.0.0",
+    "ajv": "^6.12.6",
     "archiver": "^5.0.0",
     "body-parser": "^1.19.0",
     "chokidar": "^3.0.2",
@@ -205,6 +207,7 @@
     "supertest": "^3.3.0",
     "swagger2openapi": "^6.0.3",
     "ts-node": "^9.1.1",
-    "typescript": "^3.9.5"
+    "typescript": "^3.9.5",
+    "typescript-json-schema": "^0.50.1"
   }
 }