Make example directory more standalone (#1247)

* Remove `is-email` from testing suite * Add README and package.json to examples dir * Remove is-uuid and is-url from root package.json --------- Co-authored-by: Artur Müller <me@arturmuller.com>
ianstormtaylor · Jun 22, 2024 · 88563ad · 88563ad
1 parent 625cea5
commit 88563ad
Show file tree

Hide file tree

Showing 6 changed files with 15 additions and 10 deletions.
diff --git a/examples/README.md b/examples/README.md
@@ -0,0 +1,3 @@
+# Examples
+
+To run the examples locally, first run `npm install` in this directory. Then use node to run any of the examples like so: `node basic-validation.js`, `node composing-structs.js`, etc.
diff --git a/examples/package.json b/examples/package.json
@@ -0,0 +1,10 @@
+{
+  "type": "module",
+  "license": "MIT",
+  "dependencies": {
+    "is-email": "^1.0.2",
+    "is-url": "^1.2.4",
+    "is-uuid": "^1.0.2",
+    "superstruct": "latest"
+  }
+}
diff --git a/package.json b/package.json
@@ -34,9 +34,6 @@
     "eslint": "^8.57.0",
     "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-prettier": "^5.1.3",
-    "is-email": "^1.0.0",
-    "is-url": "^1.2.4",
-    "is-uuid": "^1.0.2",
     "lodash": "^4.17.15",
     "np": "^10.0.0",
     "prettier": "^3.2.5",

diff --git a/test/@types/is-email.d.ts b/test/@types/is-email.d.ts
diff --git a/test/validation/refine/invalid.ts b/test/validation/refine/invalid.ts
@@ -1,7 +1,6 @@
-import isEmail from 'is-email'
 import { string, refine } from '../../../src'
 
-export const Struct = refine(string(), 'email', isEmail)
+export const Struct = refine(string(), 'email', (value) => value.includes('@'))
 
 export const data = 'invalid'
 

diff --git a/test/validation/refine/valid.ts b/test/validation/refine/valid.ts
@@ -1,7 +1,6 @@
-import isEmail from 'is-email'
 import { string, refine } from '../../../src'
 
-export const Struct = refine(string(), 'email', isEmail)
+export const Struct = refine(string(), 'email', (value) => value.includes('@'))
 
 export const data = 'name@example.com'
Original file line number	Diff line number	Diff line change
		@@ -0,0 +1,3 @@
		# Examples

		To run the examples locally, first run `npm install` in this directory. Then use node to run any of the examples like so: `node basic-validation.js`, `node composing-structs.js`, etc.