ID generation

.github/workflows/lint.yml

@@ -0,0 +1,37 @@
+name: Lint
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  type-check:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun run type-check
+
+  lint-eslint:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun run lint-eslint
+
+  lint-format:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun run lint-format

.github/workflows/release.yml

@@ -19,6 +19,17 @@ jobs:
           node-version: "20"
           registry-url: "https://registry.npmjs.org"
 
+      - name: Setup Bun
+        uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+
+      - name: Install dependencies
+        run: bun install
+
+      - name: Build
+        run: bun run build
+
       - name: Compare local and published versions
         id: check
         run: |

.github/workflows/test.yml

@@ -0,0 +1,17 @@
+name: Test
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+        with:
+          bun-version: latest
+      - run: bun install
+      - run: bun run test

.github/workflows/validate.yml

@@ -17,4 +17,4 @@ jobs:
 
       - run: bun install
 
-      - run: bun run bin/cli.js validate-schema --folder examples/v1
+      - run: bun run bin/cli.ts validate-schema --folder examples/v1

.gitignore

@@ -5,4 +5,5 @@ Desktop.ini
 *.swp
 *.swo
 node_modules/
+dist/
 *.tgz

.oxfmtrc.json

@@ -0,0 +1,4 @@
+{
+  "printWidth": 80,
+  "trailingComma": "all"
+}

README.md

@@ -57,10 +57,32 @@ npx @metabase/representations extract-schema --folder ./schemas
 
 Omit `--folder` to extract into the current directory.
 
+### Generating entity IDs
+
+Print one or more 21-character NanoID entity IDs (one per line):
+
+```sh
+npx @metabase/representations generate-entity-id
+npx @metabase/representations generate-entity-id --count 5
+```
+
+### Generating UUIDs
+
+Print one or more v4 UUIDs (one per line):
+
+```sh
+npx @metabase/representations generate-uuid
+npx @metabase/representations generate-uuid --count 5
+```
+
 ### Programmatic
 
 ```js
-import { validateSchema } from "@metabase/representations";
+import {
+  generateEntityId,
+  generateUuid,
+  validateSchema,
+} from "@metabase/representations";
 
 const { results, passed, failed } = validateSchema({
   folder: "./my-export",
@@ -71,6 +93,9 @@ for (const result of results) {
     console.log(result.file, result.errors);
   }
 }
+
+const entityId = generateEntityId(); // "LZfXLFzPPR4NNrgjlWDxn"
+const uuid = generateUuid(); // "1d4e9fdf-49ae-4fbe-ae27-05e7c6a5cfe8"
 ```
 
 ## Publishing to NPM