Merge pull request #13 from ShtibsDev:version-1-0-0

Version-1-0-0

Author: ShtibsDev

.vscode/settings.json

@@ -1,3 +1,3 @@
 {
-	"cSpell.words": ["datamodel", "Ofir", "Stiber", "Voronzov"]
+	"cSpell.words": ["datamodel", "dmmf", "Ofir", "Stiber", "Voronzov"]
 }

README.md

@@ -2,6 +2,11 @@
 
 This package will generate enum validation methods from your `schema.prisma` file.
 
+1. [Installation](#installation)
+2. [Usage](#usage)
+3. [Configuration](#configuration)
+   1. [Using With Javascript](#using-with-javascript)
+
 ## Installation
 
 ```bash
@@ -25,7 +30,8 @@ npx prisma generate
 The following enum:
 
 ```prisma
-enum Colors {RED
+enum Colors {
+  RED
   BLUE
   GREEN
 }
@@ -44,3 +50,67 @@ export function isColors(value: string | null | undefined): value is Colors {
 	return Object.values(Colors).includes(value as Colors);
 }
 ```
+
+## Usage
+
+To use the validation functions you simply import the one you need from the generated file.
+The functions are [type guards](https://www.typescriptlang.org/docs/handbook/advanced-types.html#using-type-predicates), which means that their return value is `boolean` but they also modify the type of the the argument that you pass.
+
+```typescript
+import { isColors } from '../prisma/enum-validators';
+
+function someFunction(str: string | null) {
+	if (isColors(str)) {
+		// str: Colors
+	}
+
+	// str: string | null
+}
+```
+
+## Configuration
+
+The generator provides the following configurations:
+
+```prisma
+generator erd {
+  provider = "prisma-enum-validator-generator"
+  output = string //Specifies where the validators file will be generated. Defaults to 'enum-validators.ts'.
+  isTs = boolean //Specifies whether the output is targeted for typescript or javascript. Defaults to true.
+}
+```
+
+### Using with Javascript
+
+The generator also supports outputting to javascript format.
+By setting `isTs` to `false`, all typescript exclusive syntax will be removed, allowing you to use the validation functions in your javascript project.
+
+Typescript output:
+
+```typescript
+/**
+ * A function to validate if a string is of type {@link Colors}.
+ * @param {string | null | undefined} value The value to test.
+ * @returns {boolean} `true` if {@link value} is of type {@link Colors}. Otherwise `false`.
+ */
+export function isColors(value: string | null | undefined): value is Colors {
+	if (!value) return false;
+	return Object.values(Colors).includes(value as Colors);
+}
+```
+
+Javascript output:
+
+```javascript
+/**
+ * A function to validate if a string is of type {@link Colors}.
+ * @param {string | null | undefined} value The value to test.
+ * @returns {boolean} `true` if {@link value} is of type {@link Colors}. Otherwise `false`.
+ */
+export function isColors(value) {
+	if (!value) return false;
+	return Object.values(Colors).includes(value);
+}
+```
+
+\*\* Note that setting `isTs` to `false`, will change any output filename extension to `.js`

package-lock.json

@@ -14,9 +14,10 @@
     "test": "test"
   },
   "keywords": [
-    "Enums",
+    "Enum",
     "Typescript",
-    "Prisma"
+    "Prisma",
+    "Generator"
   ],
   "author": "Ofir Stiber Voronzov",
   "repository": {
@@ -25,12 +26,12 @@
   },
   "license": "MIT",
   "devDependencies": {
-    "prisma": "^4.15.0",
+    "prisma": "^4.16.2",
     "typescript": "^5.1.6"
   },
   "dependencies": {
-    "@prisma/client": "^4.15.0",
+    "@prisma/client": "^4.16.2",
     "@prisma/generator-helper": "^4.16.2",
     "dotenv": "^16.3.1"
   }
-}
+}

package.json

@@ -19,7 +19,8 @@ enum Numbers {
   TWO
 }
 
-enum Colors {RED
+enum Colors {
+  RED
   BLUE
   GREEN
 }

prisma/schema.prisma

@@ -1,53 +1,15 @@
-import { GeneratorOptions } from '@prisma/generator-helper';
-import path from 'path';
+import { DMMF, GeneratorOptions } from '@prisma/generator-helper';
 import fs from 'fs';
-import * as child_process from 'child_process';
-import os from 'os';
 
-type SchemaEnum = {
-	name: string;
-	values: string[];
-};
-
-const enumRegex = /enum [\s\S]*?\}/g;
-const modelRegex = /model [\s\S]*?\}/g;
-const curlyBracesRegex = /\{([^{}]+)\}/g;
-
-function parseEnums(dataModel: string) {
-	const enumStrings = dataModel.match(enumRegex);
-	const modelStrings = dataModel.match(modelRegex);
-
-	const enums: string[] =
-		enumStrings?.map((enumString) => {
-			const name = enumString.split(' ')[1];
-
-			// const valueString = enumString.substring(enumString.indexOf('{')).replace('{', '').replace('}', '').trim();
-			// const values = valueString.split(/\s/).filter(Boolean);
-
-			return name;
-		}) ?? [];
+function extractEnums(dataModel: DMMF.Datamodel): string[] {
+	const enums = dataModel.enums.map((e) => e.name);
 
-	const enumUsage: any = {};
+	const enumUsage: Record<string, number> = {};
 	enums.forEach((e) => (enumUsage[e] = 0));
 
-	const ignoreTokens = ['@@', '//'];
-
-	for (const modelString of modelStrings ?? []) {
-		const fieldsString = modelString.substring(modelString.indexOf('{')).replace('{', '').replace('}', '').trim();
-		const fields = fieldsString
-			.split('\n')
-			.map((f) => f.trim())
-			.filter((f) => f && !ignoreTokens.some((it) => f.startsWith(it)));
-		for (const field of fields) {
-			const tokens = field.split(/\s/).filter(Boolean);
-
-			const fieldType = tokens[1] ?? null;
-
-			if (!fieldType) continue;
-
-			if (enums.includes(fieldType)) {
-				enumUsage[fieldType]++;
-			}
+	for (const model of dataModel.models) {
+		for (const field of model.fields) {
+			if (enums.includes(field.type)) enumUsage[field.type]++;
 		}
 	}
 
@@ -84,9 +46,13 @@ export default async (options: GeneratorOptions) => {
 
 		const isTs = !!config.useTs ? config.useTs === 'true' : true;
 
-		const output = options.generator.output?.value || `./prisma/enum-validators.${isTs ? 'ts' : 'js'}`;
-		const enums = parseEnums(options.datamodel);
+		let output = options.generator.output?.value || `./prisma/enum-validators.${isTs ? 'ts' : 'js'}`;
+
+		if (!isTs && !output.endsWith('.js')) {
+			output = `${output.substring(0, output.lastIndexOf('.'))}.js`;
+		}
 
+		const enums = extractEnums(options.dmmf.datamodel);
 		const fileContent = generateFileContent(enums, isTs);
 
 		fs.writeFileSync(output, fileContent);