isolate-package 1.9.3 → 1.9.4

package/README.md

@@ -31,6 +31,7 @@
   - [Modern Yarn](#modern-yarn)
 - [API](#api)
 - [The internal packages strategy](#the-internal-packages-strategy)
+- [Firebase](#firebase)
 
 <!-- /TOC -->
 
@@ -435,3 +436,8 @@ to the Typescript source files, but since the shared code was embedded in the
 bundle, they will never be referenced via import statements. So the manifest the
 entry declarations are never used. The reason the packages are included in the
 isolated output is to instruct package manager to install their dependencies.
+
+## Firebase
+
+For detailed information on how to use isolate-package in combination with
+Firebase [see this documentation](./docs/firebase.md#firebase)

package/docs/firebase.md

@@ -1,5 +1,16 @@
 # Firebase
 
+<!-- TOC -->
+
+- [Motivation](#motivation)
+- [Example](#example)
+- [Quick Start](#quick-start)
+- [Firebase Tools With Isolate](#firebase-tools-with-isolate)
+- [Deploying from multiple packages](#deploying-from-multiple-packages)
+- [Deploying from the root](#deploying-from-the-root)
+
+<!-- /TOC -->
+
 > !! There is
 > [a fork of firebase-tools](https://github.com/0x80/firebase-tools-with-isolate),
 > where isolate-package is integrated.
@@ -16,29 +27,15 @@ There is nothing Firebase-specific to this solution and there should be other
 use-cases for it, but that is why this documentation contains some instructions
 related to Firebase.
 
-## Firebase Tools With Isolate
-
-I recommend using
-[the fork](https://github.com/0x80/firebase-tools-with-isolate) for monorepos
-until it is officially integrated. It not only simplifies the setup but more
-importantly allows `isolate` to run as an integral part of the deployment
-process, so it doesn't affect anything prior to deployment. Because of this, you
-preserve live code updates when running the local Firebase emulators, which I
-think is highly desirable.
-
-The fork is almost identical, and the integration with isolate-package does not
-affect any existing functionality, so I do not think there's reason to worry
-about things breaking. I will sync the fork with the upstream firebase-tools on
-a regular basis. The fork versions will match the firebase-tools versions for
-clarity.
-
-## A Quick Start
+## Example
 
 If you are not completely confident that your monorepo setup is solid, I advise
 you to check out my in-dept boilerplate at
 [mono-ts](https://github.com/0x80/mono-ts) where many different aspects are
 discussed and `isolate-package` is used to demonstrate Firebase deployments.
 
+## Quick Start
+
 This section describes the steps required for Firebase deployment, assuming:
 
 - You use a fairly typical monorepo setup
@@ -46,7 +43,7 @@ This section describes the steps required for Firebase deployment, assuming:
   deploy to Firebase, hereafter referred to as the "target package".
 
 If your setup diverges from a traditional one, please continue reading the
-[Prerequisites](#prerequisites) section.
+[Prerequisites](../README.md#prerequisites) section.
 
 1. In the target package, install `isolate-package` and `firebase-tools` by
    running `pnpm add isolate-package firebase-tools -D` or the Yarn / NPM
@@ -66,6 +63,22 @@ gen functions, deploy different node versions, and decrease the built output
 size and dependency lists for each package, improving deployment and cold-start
 times.
 
+## Firebase Tools With Isolate
+
+I recommend using
+[the fork](https://github.com/0x80/firebase-tools-with-isolate) for monorepos
+until it is officially integrated. It not only simplifies the setup but more
+importantly allows `isolate` to run as an integral part of the deployment
+process, so it doesn't affect anything prior to deployment. Because of this, you
+preserve live code updates when running the local Firebase emulators, which I
+think is highly desirable.
+
+The fork is almost identical, and the integration with isolate-package does not
+affect any existing functionality, so I do not think there's reason to worry
+about things breaking. I will sync the fork with the upstream firebase-tools on
+a regular basis. The fork versions will match the firebase-tools versions for
+clarity.
+
 ## Deploying from multiple packages
 
 You can deploy to Firebase from multiple packages in your monorepo, in which
@@ -101,9 +114,9 @@ information,
 [read this](https://firebase.google.com/docs/functions/beta/organize-functions).
 
 Make sure your Firebase package adheres to the things mentioned in
-[prerequisites](#prerequisites) and its package manifest contains the field
-`"main"`, or `"module"` if you set `"type": "module"`, so Firebase knows the
-entry point to your source code.
+[prerequisites](../README.md#prerequisites) and its package manifest contains
+the field `"main"`, or `"module"` if you set `"type": "module"`, so Firebase
+knows the entry point to your source code.
 
 ## Deploying from the root
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "isolate-package",
-  "version": "1.9.3",
+  "version": "1.9.4",
   "description": "Isolate a monorepo package with its shared dependencies to form a self-contained directory, compatible with Firebase deploy",
   "author": "Thijs Koerselman",
   "license": "MIT",