Add a local development flake and contributing instructions

.envrc

@@ -0,0 +1,3 @@
+use flake
+
+source_env_if_exists .envrc.local

.gitignore

@@ -2,4 +2,5 @@ node_modules
 *.js
 !shopify.js
 !gitpkg.config.js
-dist/
+dist/
+.direnv

Contributing.md

@@ -0,0 +1,14 @@
+# Development environment
+
+We use nix to manage the development environment for this package. Run `direnv allow` to load the devshell, with node and other utilities ready to go.
+
+Then, run `pnpm install` to install the dependencies.
+
+See the readme for instructions on re-scraping the schemas from Shopify's docs.
+
+# Releasing
+
+Releases are managed automatically by Github Actions. To create a new release, follow these steps:
+
+1. Run `npm version minor|major|patch`. This will change the version in the package.json and create a new git commit changing it.
+2. Push this commit to the `main` branch. CI will run the tests, then run the release workflow, which publishes to NPM, create a Github release, and creates a git tag for the version.

flake.nix

@@ -0,0 +1,33 @@
+{
+  description = "shopify-webhook-schemas development environment";
+
+  inputs = {
+    flake-utils.url = "github:numtide/flake-utils";
+    nixpkgs.url = "github:NixOS/nixpkgs/nixpkgs-unstable";
+  };
+
+  outputs = { self, flake-utils, nixpkgs }:
+    (flake-utils.lib.eachSystem [
+      "x86_64-linux"
+      "x86_64-darwin"
+      "aarch64-darwin"
+    ]
+      (system: nixpkgs.lib.fix (flake:
+        let
+          pkgs = nixpkgs.legacyPackages.${system};
+        in
+        rec {
+
+          packages =
+            rec {
+              bash = pkgs.bash;
+              nodejs = pkgs.nodejs_22;
+              corepack = pkgs.corepack;
+            };
+
+          devShell = pkgs.mkShell {
+            packages = builtins.attrValues packages;
+          };
+        }
+      )));
+}

src/scrape.ts

@@ -72,15 +72,15 @@ const docsWebhooksPageForVersion = (version: string) => `https://shopify.dev/doc
 let warnings = 0;
 let errors = 0;
 
-const sortStringArrays = (obj: Object) => {
+const sortStringArrays = (obj: Record<string, any>) => {
   return cloneDeepWith(obj, (value) => {
     if (Array.isArray(value) && value.every((item) => typeof item === "string")) {
       return value.sort();
     }
   });
 };
 
-const getDeterministicObject = (obj: Object): Object => {
+const getDeterministicObject = (obj: Record<string, any>): Record<string, any> => {
   const stableString = stringify(sortStringArrays(obj));
   return JSON.parse(stableString!);
 };