jest -> vitest & README update

FlatFilers · Nov 25, 2024 · 2e43c07 · 2e43c07
1 parent 33b7a96
commit 2e43c07
Show file tree

Hide file tree

Showing 5 changed files with 28 additions and 22 deletions.
diff --git a/package-lock.json b/package-lock.json
diff --git a/plugins/stored-constraints/README.md b/plugins/stored-constraints/README.md
@@ -1,9 +1,27 @@
-# @flatfile/plugin-constraints
+<!-- START_INFOCARD -->
 
-This plugin enabled running stored constraints.
+# @flatfile/plugin-stored-constraints
+
+The `@flatfile/plugin-stored-constraints` plugin enables running stored constraints.
+
+**Event Type:**
+`listener.on('commit:created')`
+
+<!-- END_INFOCARD -->
+
+## Installation
+
+```bash install
+npm i @flatfile/plugin-stored-constraints
+```
 
 ## Usage
 
-```ts
+```ts listener.ts
+import type { FlatfileListener } from "@flatfile/listener";
+import { storedConstraint } from '@flatfile/plugin-stored-constraints'
+
+export default function (listener: FlatfileListener) {
   listener.use(storedConstraint())
-```
+}
+```
diff --git a/plugins/stored-constraints/jest.config.cjs b/plugins/stored-constraints/jest.config.cjs
diff --git a/plugins/stored-constraints/package.json b/plugins/stored-constraints/package.json
@@ -63,7 +63,7 @@
     "validator": "^13.12.0"
   },
   "peerDependencies": {
-    "@flatfile/api": "^1.9.19",
+    "@flatfile/api": "^1.11.0",
     "@flatfile/listener": "^1.1.0",
     "@flatfile/plugin-record-hook": "^1.10.0"
   },

diff --git a/plugins/stored-constraints/vitest.config.ts b/plugins/stored-constraints/vitest.config.ts
@@ -0,0 +1,4 @@
+import config from '@flatfile/config-vitest'
+import { defineConfig } from 'vitest/config'
+
+export default defineConfig(config)