feat: add cli --migrationsCollection option

.changeset/README.md

@@ -0,0 +1,8 @@
+# Changesets
+
+Hello and welcome! This folder has been automatically generated by `@changesets/cli`, a build tool that works
+with multi-package repos, or single-package repos to help you version and publish your code. You can
+find the full documentation for it [in our repository](https://github.com/changesets/changesets)
+
+We have a quick list of common questions to get you started engaging with this project in
+[our documentation](https://github.com/changesets/changesets/blob/main/docs/common-questions.md)

.changeset/config.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://unpkg.com/@changesets/config@3.0.0/schema.json",
+  "changelog": "@changesets/cli/changelog",
+  "commit": false,
+  "fixed": [],
+  "linked": [],
+  "access": "restricted",
+  "baseBranch": "master",
+  "updateInternalDependencies": "patch",
+  "ignore": []
+}

.github/dependabot.yml

@@ -0,0 +1,11 @@
+# To get started with Dependabot version updates, you'll need to specify which
+# package ecosystems to update and where the package manifests are located.
+# Please see the documentation for all configuration options:
+# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file
+
+version: 2
+updates:
+  - package-ecosystem: "npm" # See documentation for possible values
+    directory: "/" # Location of package manifests
+    schedule:
+      interval: "daily"

.github/workflows/ci.yaml

@@ -0,0 +1,58 @@
+name: Changesets
+on:
+  push:
+    branches:
+      - master
+
+env:
+  CI: true
+
+jobs:
+  version:
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: "write"
+      id-token: "write"
+      pull-requests: write
+
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Setup npmrc
+        run: |
+          cat << EOF > "$HOME/.npmrc"
+            //registry.npmjs.org/:_authToken=$NPM_TOKEN
+          EOF
+        env:
+          NPM_TOKEN: ${{ secrets.NPM_TOKEN }}
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm test
+
+      - run: git status
+
+      - name: create and publish versions
+        uses: changesets/action@v1
+        with:
+          publish: pnpm ci:publish
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.github/workflows/pr.yaml

@@ -0,0 +1,40 @@
+name: PR
+
+on:
+  pull_request:
+    branches:
+      - master
+
+env:
+  CI: true
+
+jobs:
+  run-tests:
+    name: Run tests
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+        with:
+          fetch-depth: 0
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@v3
+        with:
+          version: 8
+
+      - name: Setup Node.js
+        uses: actions/setup-node@v4
+        with:
+          node-version: 20
+          cache: "pnpm"
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Install packages
+        run: pnpm install
+
+      - name: Run tests
+        run: pnpm test

.gitignore

@@ -61,3 +61,6 @@ typings/
 
 # next.js build output
 .next
+
+# ide configurations
+.idea

CHANGELOG.md

@@ -0,0 +1,30 @@
+# fireblaze
+
+## 1.4.0
+
+### Minor Changes
+
+- 6565e40: Updated packages
+- e334cf2: Updated packages versions
+
+### Patch Changes
+
+- d592a60: Updated packages
+
+## 1.3.0
+
+### Minor Changes
+
+- d99c582: Updated packages
+
+## 1.2.2
+
+### Patch Changes
+
+- 61bd1c2: Update packages
+
+## 1.2.1
+
+### Patch Changes
+
+- Update to PNPM

README.md

@@ -1,19 +1,19 @@
-# fireway
-A schema migration tool for firestore heavily inspired by [flyway](https://flywaydb.org/)
+# fireblaze
+A fork of the useful (but seemly dead) project [fireway](https://github.com/kevlened/fireway)
 
 ## Install
 
 ```bash
-yarn global add fireway
+yarn global add fireblaze
 
 # or 
 
-npx fireway
+npx fireblaze
 ```
 
 ## Credentials
 
-In order to fireway be able to connect to firestore you need to set up the environment variable `GOOGLE_APPLICATION_CREDENTIALS` with service account file path.
+In order to fireblaze be able to connect to firestore you need to set up the environment variable `GOOGLE_APPLICATION_CREDENTIALS` with service account file path.
 
 Example:
 ```bash
@@ -24,47 +24,49 @@ export GOOGLE_APPLICATION_CREDENTIALS="path/to/firestore-service-account.json"
 
 ```bash
 Usage
-  $ fireway <command> [options]
+  $ fireblaze <command> [options]
 
 Available Commands
   migrate    Migrates schema to the latest version
 
 For more info, run any command with the `--help` flag
-  $ fireway migrate --help
+  $ fireblaze migrate --help
 
 Options
   --require        Requires a module before executing
   -v, --version    Displays current version
   -h, --help       Displays this message
 
 Examples
-  $ fireway migrate
-  $ fireway --require="ts-node/register" migrate
+  $ fireblaze migrate
+  $ fireblaze --require="ts-node/register" migrate
 ```
 
-### `fireway migrate`
+### `fireblaze migrate`
 ```bash
 Description
   Migrates schema to the latest version
 
 Usage
-  $ fireway migrate [options]
+  $ fireblaze migrate [options]
 
 Options
-  --path         Path to migration files  (default ./migrations)
-  --projectId    Target firebase project
-  --dryrun       Simulates changes
-  --forceWait    Forces waiting for migrations that do not strictly manage async calls
-  --require      Requires a module before executing
-  -h, --help     Displays this message
+  --path                  Path to migration files  (default ./migrations)
+  --projectId             Target firebase project
+  --dryrun                Simulates changes
+  --forceWait             Forces waiting for migrations that do not strictly manage async calls
+  --require               Requires a module before executing
+  --migrationsCollection  Firestore collection to store migration state (default fireblaze)
+  -h, --help              Displays this message
 
 Examples
-  $ fireway migrate
-  $ fireway migrate --path=./my-migrations
-  $ fireway migrate --projectId=my-staging-id
-  $ fireway migrate --dryrun
-  $ fireway migrate --forceWait
-  $ fireway --require="ts-node/register" migrate
+  $ fireblaze migrate
+  $ fireblaze migrate --path=./my-migrations
+  $ fireblaze migrate --projectId=my-staging-id
+  $ fireblaze migrate --dryrun
+  $ fireblaze migrate --forceWait
+  $ fireblaze migrate --migrationsCollection=migrations
+  $ fireblaze --require="ts-node/register" migrate
 ```
 
 ## Migration file format
@@ -103,52 +105,52 @@ For type checking and Intellisense, there are two options:
    ```ts
     // ./migrations/v0.0.1__typescript-example.ts
 
-    import { MigrateOptions } from 'fireway';
+    import { MigrateOptions } from 'fireblaze';
 
     export async function migrate({firestore} : MigrateOptions) {
         await firestore.collection('data').doc('one').set({key: 'value'});
     };
    ```
-4. Run `fireway migrate` with the `require` option
+4. Run `fireblaze migrate` with the `require` option
 
    ```sh
-   $ fireway migrate --require="ts-node/register"
+   $ fireblaze migrate --require="ts-node/register"
    ```
 
 ### JSDoc
 
 Alternatively, you can use [JSDoc](https://jsdoc.app/) for Intellisense
 
 ```js
-/** @param { import('fireway').MigrateOptions } */
+/** @param { import('fireblaze').MigrateOptions } */
 module.exports.migrate = async ({firestore}) => {
     // Intellisense is enabled
 };
 ```
 
 ## Running locally
 
-Typically, `fireway` expects a `--projectId` option that lets you specify the Firebase project associated with your Firestore instance against which it performs migrations. 
+Typically, `fireblaze` expects a `--projectId` option that lets you specify the Firebase project associated with your Firestore instance against which it performs migrations. 
 However, most likely you'll want to test your migration scripts _locally_ first before running them against your actual (presumably, production) instances. 
 If you are using the [Firestore emulator](https://firebase.google.com/docs/emulator-suite/connect_firestore), define the FIRESTORE_EMULATOR_HOST environment variable, e.g.:
 
 `export FIRESTORE_EMULATOR_HOST="localhost:8080"`
 
-The firestore node library will connect to your local instance. This way, you don't need a project ID and migrations will be run against your emulator instance. This works since `fireway` is built on the [firestore node library](https://www.npmjs.com/package/@google-cloud/firestore). 
+The firestore node library will connect to your local instance. This way, you don't need a project ID and migrations will be run against your emulator instance. This works since `fireblaze` is built on the [firestore node library](https://www.npmjs.com/package/@google-cloud/firestore). 
 
 ## Migration logic
 
 1. Gather all the migration files and sort them according to semver
-2. Find the last migration in the `fireway` collection
+2. Find the last migration in the `fireblaze` collection
 3. If the last migration failed, stop. (remove the failed migration result or restore the db to continue)
 4. Run the migration scripts since the last migration
 
 ## Migration results
 
-Migration results are stored in the `fireway` collection in `firestore`
+Migration results are stored in the `fireblaze` collection in `firestore`
 
 ```js
-// /fireway/3-0.0.1-example
+// /fireblaze/3-0.0.1-example
 
 {
   checksum: 'fdfe6a55a7c97a4346cb59871b4ce97c',
@@ -168,11 +170,11 @@ Migration results are stored in the `fireway` collection in `firestore`
 
 ```bash
 # To install packages and firestore emulator
-$ yarn
-$ yarn setup
+$ pnpm
+$ pnpm setup
 
 # To run tests
-$ yarn test
+$ pnpm test
 ```
 
 ## License

fireway.d.ts → fireblaze.d.ts

@@ -5,4 +5,5 @@ export interface MigrateOptions {
 	FieldPath: typeof import("@google-cloud/firestore").FieldPath;
 	Timestamp: typeof import("@google-cloud/firestore").Timestamp;
 	dryrun: boolean;
+	migrationsCollection: string;
 }