Format comment containing process.env (#6874)

firebase · Dec 21, 2022 · d4114a4 · d4114a4
1 parent 9d2757a
commit d4114a4
Show file tree

Hide file tree

Showing 2 changed files with 10 additions and 2 deletions.
diff --git a/.changeset/wild-geckos-fetch.md b/.changeset/wild-geckos-fetch.md
@@ -0,0 +1,5 @@
+---
+'@firebase/util': patch
+---
+
+Reformat a comment that causes compile errors in some build toolchains.
diff --git a/packages/util/src/defaults.ts b/packages/util/src/defaults.ts
@@ -53,8 +53,11 @@ const getDefaultsFromGlobal = (): FirebaseDefaults | undefined =>
 
 /**
  * Attempt to read defaults from a JSON string provided to
- * process.env.__FIREBASE_DEFAULTS__ or a JSON file whose path is in
- * process.env.__FIREBASE_DEFAULTS_PATH__
+ * process(.)env(.)__FIREBASE_DEFAULTS__ or a JSON file whose path is in
+ * process(.)env(.)__FIREBASE_DEFAULTS_PATH__
+ * The dots are in parens because certain compilers (Vite?) cannot
+ * handle seeing that variable in comments.
+ * See https://github.com/firebase/firebase-js-sdk/issues/6838
  */
 const getDefaultsFromEnvVariable = (): FirebaseDefaults | undefined => {
   if (typeof process === 'undefined' || typeof process.env === 'undefined') {