feat: expose toTyped schema and show helpful logs to the user

Author: logaretm

packages/nuxt/package.json

@@ -36,8 +36,9 @@
     "dist/*.d.ts"
   ],
   "dependencies": {
-    "vee-validate": "^4.8.5",
-    "@nuxt/kit": "^3.4.0"
+    "@nuxt/kit": "^3.4.0",
+    "local-pkg": "^0.4.3",
+    "vee-validate": "^4.8.5"
   },
   "devDependencies": {
     "@nuxt/eslint-config": "^0.1.1",

packages/nuxt/src/module.ts

@@ -1,5 +1,10 @@
 import { defineNuxtModule, addComponent, addImports } from '@nuxt/kit';
 import type { NuxtModule } from '@nuxt/schema';
+import { isPackageExists } from 'local-pkg';
+
+interface VeeValidateModuleOptions {
+  autoImports?: boolean;
+}
 
 const components = ['Field', 'Form', 'ErrorMessage', 'FieldArray'];
 
@@ -25,26 +30,96 @@ const composables = [
   'useValidateForm',
 ];
 
-export default defineNuxtModule({
+export default defineNuxtModule<VeeValidateModuleOptions>({
   meta: {
     name: 'vee-valiate',
     configKey: 'veeValidate',
   },
+  defaults: {
+    autoImports: true,
+  },
   setup(options, nuxt) {
-    composables.forEach(composable => {
-      addImports({
-        name: composable,
-        as: composable,
-        from: 'vee-validate',
+    if (options.autoImports) {
+      composables.forEach(composable => {
+        addImports({
+          name: composable,
+          as: composable,
+          from: 'vee-validate',
+        });
       });
-    });
 
-    components.forEach(component => {
-      addComponent({
-        name: component,
-        export: component,
-        filePath: 'vee-validate',
+      components.forEach(component => {
+        addComponent({
+          name: component,
+          export: component,
+          filePath: 'vee-validate',
+        });
       });
-    });
+    }
+
+    const usingYup = checkForYup(options);
+    if (!usingYup) {
+      checkForZod(options);
+    }
   },
-}) as NuxtModule;
+}) as NuxtModule<VeeValidateModuleOptions>;
+
+function checkForZod(options: VeeValidateModuleOptions) {
+  if (isPackageExists('zod') && !isPackageExists('@vee-validate/zod')) {
+    console.log(
+      'You seem to be using zod, but you have not installed @vee-validate/zod. Please install it to use zod with vee-validate.'
+    );
+    return true;
+  }
+
+  if (isPackageExists('@vee-validate/zod') && !isPackageExists('zod')) {
+    console.log(
+      'You seem to be using @vee-validate/zod, but you have not installed zod. Please install it to use zod with vee-validate.'
+    );
+    return true;
+  }
+
+  if (isPackageExists('@vee-validate/zod') && isPackageExists('zod')) {
+    if (options.autoImports) {
+      addImports({
+        name: 'toTypedSchema',
+        as: 'toTypedSchema',
+        from: '@vee-validate/zod',
+      });
+    }
+
+    return true;
+  }
+
+  return false;
+}
+
+function checkForYup(options: VeeValidateModuleOptions) {
+  if (isPackageExists('yup') && !isPackageExists('@vee-validate/yup')) {
+    console.log(
+      'You seem to be using yup, but you have not installed @vee-validate/yup. Please install it to use yup with vee-validate.'
+    );
+    return true;
+  }
+
+  if (isPackageExists('@vee-validate/yup') && !isPackageExists('yup')) {
+    console.log(
+      'You seem to be using @vee-validate/yup, but you have not installed yup. Please install it to use yup with vee-validate.'
+    );
+    return true;
+  }
+
+  if (isPackageExists('@vee-validate/yup') && isPackageExists('yup')) {
+    if (options.autoImports) {
+      addImports({
+        name: 'toTypedSchema',
+        as: 'toTypedSchema',
+        from: '@vee-validate/yup',
+      });
+    }
+
+    return true;
+  }
+
+  return false;
+}