set up docgen and api review for packages-exp (#2868)

* set up doc gen tools

* save progress

* fix tsdocs

* create docs without -exp in package name

* enable api-report in app-types-exp

* set up doc and api review pipeline

* prepend underscore to internal only symbols

* remove api review

* [AUTOMATED]: Prettier Code Styling

* [AUTOMATED]: License Headers

* fix prepush hook

* add api report for app-types

* manually change the report file for testing

* [AUTOMATED]: API Reports

* centralize api review location

* rename docgen script

* enable json with comment in github

.gitattributes

@@ -0,0 +1 @@
+*.json  linguist-language=JSON-with-Comments

.gitignore

@@ -81,3 +81,13 @@ typings/
 
 # NPM Lockfiles
 package-lock.json
+
+# temp folder used by api-extractor
+temp
+packages-exp/**/temp
+
+# temp markdowns generated for individual SDKs
+packages-exp/**/docs
+
+# files generated by api-extractor that should not be tracked
+tsdoc-metadata.json

.vscode/settings.json

@@ -9,5 +9,6 @@
     // Exclude installed dependencies from searches too
     "**/node_modules": true
   },
-  "typescript.tsdk": "node_modules/typescript/lib"
+  "typescript.tsdk": "node_modules/typescript/lib",
+  "files.associations": { "*.json": "jsonc" }
 }

common/api-review/app-exp.api.md

@@ -0,0 +1,44 @@
+## API Report File for "@firebase/app-exp"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { FirebaseApp } from '@firebase/app-types-exp';
+import { FirebaseAppConfig } from '@firebase/app-types-exp';
+import { FirebaseOptions } from '@firebase/app-types-exp';
+import { LogCallback } from '@firebase/logger';
+import { LogLevel } from '@firebase/logger';
+import { LogOptions } from '@firebase/logger';
+
+// @public
+export function deleteApp(app: FirebaseApp): Promise<void>;
+
+// @public
+export function getApp(name?: string): FirebaseApp;
+
+// @public
+export function getApps(): FirebaseApp[];
+
+// @public
+export function initializeApp(options: FirebaseOptions, name?: string): FirebaseApp;
+
+// @public
+export function initializeApp(options: FirebaseOptions, config?: FirebaseAppConfig): FirebaseApp;
+
+export { LogLevel }
+
+// @public
+export function onLog(logCallback: LogCallback | null, options?: LogOptions): void;
+
+// @public
+export function registerVersion(libraryKeyOrName: string, version: string, variant?: string): void;
+
+// @public
+export const SDK_VERSION: string;
+
+// @public
+export function setLogLevel(logLevel: LogLevel): void;
+
+
+```

common/api-review/app-types-exp.api.md

@@ -0,0 +1,65 @@
+## API Report File for "@firebase/app-types-exp"
+
+> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
+
+```ts
+
+import { ComponentContainer } from '@firebase/component';
+
+// @public
+export interface FirebaseApp {
+  automaticDataCollectionEnabled: boolean;
+
+  readonly name: string;
+
+  readonly options: FirebaseOptions;
+}
+
+// @public (undocumented)
+export interface FirebaseAppConfig {
+  // (undocumented)
+  automaticDataCollectionEnabled?: boolean;
+  // (undocumented)
+  name?: string;
+}
+
+// @internal (undocumented)
+export interface _FirebaseAppInternal extends FirebaseApp {
+  // (undocumented)
+  checkDestroyed(): void;
+  // (undocumented)
+  container: ComponentContainer;
+  // (undocumented)
+  isDeleted: boolean;
+}
+
+// @public (undocumented)
+export interface FirebaseOptions {
+  // (undocumented)
+  apiKey?: string;
+  // (undocumented)
+  appId?: string;
+  // (undocumented)
+  authDomain?: string;
+  // (undocumented)
+  databaseURL?: string;
+  // (undocumented)
+  measurementId?: string;
+  // (undocumented)
+  messagingSenderId?: string;
+  // (undocumented)
+  projectId?: string;
+  // (undocumented)
+  storageBucket?: string;
+}
+
+// @public (undocumented)
+export interface PlatformLoggerService {
+  // (undocumented)
+  getPlatformInfoString(): string;
+}
+
+
+// (No @packageDocumentation comment for this package)
+
+```