notform-nuxt 2.1.0 → 2.1.2

package/README.md

@@ -1,15 +1,106 @@
-# notform-nuxt
+<div align="center">
+<h1>notform-nuxt</h1>
+<p><strong>NotForm, seamlessly integrated with Nuxt.</strong></p>
+<p>
+<a href="https://npmx.dev/package/notform-nuxt" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/npm/v/notform-nuxt.svg?style=plastic&label=NPM%20Version&color=blue" alt="NPM Version"></a>
+<a href="https://npmx.dev/package/notform-nuxt" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/npm/dw/notform-nuxt.svg?style=plastic&label=NPM%20Downloads&color=blue" alt="NPM Downloads"></a>
+<a href="https://npmx.dev/package/notform-nuxt" target="_blank" rel="noopener noreferrer"><img src="https://img.shields.io/npm/unpacked-size/notform-nuxt?style=plastic&label=NPM%20Unpacked%20Size&color=blue" alt="NPM Unpacked Size"></a>
+</p>
+</div>
 
-[![npm version](https://img.shields.io/npm/v/notform-nuxt.svg?style=plastic)](https://npmx.dev/package/notform-nuxt)
-[![npm downloads](https://img.shields.io/npm/dm/notform-nuxt.svg?style=plastic)](https://npmx.dev/package/notform)
-[![NPM Unpacked Size](https://img.shields.io/npm/unpacked-size/notform-nuxt?style=plastic)](https://npmx.dev/package/notform)
+<br>
 
-**Official Nuxt module for NotForm**
+`notform-nuxt` is the official Nuxt module for [NotForm](../core). It provides auto-imports for NotForm composables and components, making form development in Nuxt applications seamless and type-safe.
 
-`notform-nuxt` provides seamless integration for NotForm in Nuxt applications, including auto-imports and Nuxt-specific optimizations.
+## Installation
+
+```bash
+pnpm add notform
+pnpm add -D notform-nuxt
+```
+
+## Setup
+
+Add `notform-nuxt` to the `modules` section of your `nuxt.config.ts`:
+
+```ts
+export default defineNuxtConfig({
+  modules: ['notform-nuxt'],
+})
+```
+
+That's it — all NotForm composables and components are now auto-imported in your Nuxt application.
+
+## What the Module Does
+
+1. **Auto-imports composables** — `useNotForm`, `NotForm`, `NotField`, `NotMessage`, `NotArrayField` are available everywhere without manual imports.
+2. **Auto-imports components** — All NotForm components are globally available in your templates.
+3. **Type-safe** — Full TypeScript support with auto-completion for all NotForm APIs.
+
+## Usage
+
+After installing the module, you can use NotForm directly in your components:
+
+```vue
+<script setup lang="ts">
+import { z } from 'zod'
+
+const schema = z.object({
+  email: z.string().email('Invalid email'),
+  name: z.string().min(1, 'Name is required'),
+})
+
+const form = useNotForm({
+  onSubmit: (values) => {
+    console.log('Form submitted:', values)
+  },
+  schema,
+})
+</script>
+
+<template>
+  <NotForm
+    :form="form"
+    @submit="form.submit"
+  >
+    <NotField path="name">
+      <input
+        v-model="form.values.name"
+        type="text"
+      >
+
+      <NotMessage path="name" />
+    </NotField>
+
+    <NotField path="email">
+      <input
+        v-model="form.values.email"
+        type="email"
+      >
+
+      <NotMessage path="email" />
+    </NotField>
+
+    <button type="submit">
+      Submit
+    </button>
+  </NotForm>
+</template>
+```
+
+No imports needed — everything is auto-imported by the module.
+
+## Prerequisites
+
+- [Nuxt](https://nuxt.com/) v4 or later
+- [NotForm](../core) core package
 
 ## Documentation
 
 For detailed guides, API reference, and examples, visit:
 **[notformdocs.vercel.app](https://notformdocs.vercel.app/getting-started/nuxt-module)**
 
+## License
+
+[MIT](../../LICENSE) &copy; [Favour Emeka](https://github.com/favorodera)
+

package/dist/module.json

@@ -1,10 +1,10 @@
 {
-  "name": "notform-nuxt",
-  "configKey": "notform",
   "compatibility": {
     "nuxt": ">=4.0.0"
   },
-  "version": "2.1.0",
+  "configKey": "notform",
+  "name": "notform-nuxt",
+  "version": "2.1.2",
   "builder": {
     "@nuxt/module-builder": "1.0.2",
     "unbuild": "unknown"

package/dist/module.mjs

@@ -1,4 +1,4 @@
-import { defineNuxtModule, createResolver, addComponent, addImports } from '@nuxt/kit';
+import { defineNuxtModule, addComponent, addImports } from '@nuxt/kit';
 
 const components = [
   "NotForm",
@@ -6,40 +6,26 @@ const components = [
   "NotArrayField",
   "NotMessage"
 ];
-const composables = [
-  "useNotForm"
-];
 const module$1 = defineNuxtModule({
   meta: {
-    name: "notform-nuxt",
-    configKey: "notform",
     compatibility: {
       nuxt: ">=4.0.0"
-    }
+    },
+    configKey: "notform",
+    name: "notform-nuxt"
   },
-  // Module factory
-  setup(_options, nuxt) {
-    const { resolve } = createResolver(import.meta.url);
-    const componentsRuntime = resolve("./runtime/components");
-    const composablesRuntime = resolve("./runtime/composables");
-    nuxt.options.vite.optimizeDeps = nuxt.options.vite.optimizeDeps ||= {};
-    nuxt.options.vite.optimizeDeps.exclude = nuxt.options.vite.optimizeDeps.exclude ||= [];
-    if (!nuxt.options.vite.optimizeDeps.exclude.includes("notform")) {
-      nuxt.options.vite.optimizeDeps.exclude.push("notform");
-    }
-    components.forEach((name) => {
+  setup() {
+    for (const name of components) {
       addComponent({
-        name,
         export: name,
-        filePath: componentsRuntime
-      });
-    });
-    composables.forEach((composable) => {
-      addImports({
-        name: composable,
-        as: composable,
-        from: composablesRuntime
+        filePath: "notform",
+        name
       });
+    }
+    addImports({
+      as: "useNotForm",
+      from: "notform",
+      name: "useNotForm"
     });
   }
 });

package/package.json

@@ -1,14 +1,15 @@
 {
   "name": "notform-nuxt",
-  "version": "2.1.0",
+  "type": "module",
+  "version": "2.1.2",
   "private": false,
   "publishConfig": {
     "access": "public"
   },
-  "type": "module",
   "description": "Official notform nuxt module - Vue Forms Without the Friction",
   "author": "Favour Emeka <favorodera@gmail.com>",
   "license": "MIT",
+  "funding": "https://github.com/sponsors/favorodera",
   "homepage": "https://notformdocs.vercel.app/",
   "repository": {
     "type": "git",
@@ -17,6 +18,14 @@
   "bugs": {
     "url": "https://github.com/favorodera/notform/issues"
   },
+  "keywords": [
+    "notform-nuxt",
+    "nuxt",
+    "form",
+    "nuxt form",
+    "validator",
+    "nuxt form validator"
+  ],
   "exports": {
     ".": {
       "types": "./dist/types.d.mts",
@@ -34,31 +43,29 @@
   "files": [
     "dist"
   ],
+  "engines": {
+    "node": ">=22.0.0",
+    "pnpm": ">=11.0.0"
+  },
+  "peerDependencies": {
+    "notform": "^2.1.0",
+    "nuxt": "^4.0.0"
+  },
   "dependencies": {
-    "@nuxt/kit": "^4.4.2",
-    "notform": "2.1.0"
+    "@nuxt/kit": "4.4.8",
+    "notform": "2.1.2"
   },
   "devDependencies": {
+    "@favorodera/eslint-config": "^0.1.4",
     "@nuxt/module-builder": "^1.0.2",
-    "@nuxt/schema": "^4.4.2",
-    "nuxt": "^4.4.2",
-    "vue-tsc": "^3.2.6"
-  },
-  "engines": {
-    "node": ">=22.0.0"
+    "@nuxt/schema": "^4.4.8",
+    "nuxt": "4.4.8",
+    "vue-tsc": "^3.3.5"
   },
-  "keywords": [
-    "notform-nuxt",
-    "nuxt",
-    "form",
-    "nuxt form",
-    "validator",
-    "nuxt form validator"
-  ],
   "scripts": {
     "dev": "nuxt prepare && nuxt-module-build build --stub",
     "build": "nuxt prepare && nuxt-module-build build",
-    "typecheck": "nuxt prepare && vue-tsc --noEmit",
-    "lint": "eslint . --fix"
+    "typecheck": "nuxt prepare && nuxt typecheck",
+    "lint": "nuxt prepare && eslint . --fix"
   }
 }

package/dist/runtime/components.d.ts

@@ -1 +0,0 @@
-export { NotForm, NotField, NotArrayField, NotMessage } from 'notform';

package/dist/runtime/components.js

@@ -1 +0,0 @@
-export { NotForm, NotField, NotArrayField, NotMessage } from "notform";

package/dist/runtime/composables.d.ts

@@ -1 +0,0 @@
-export { useNotForm } from 'notform';

package/dist/runtime/composables.js

@@ -1 +0,0 @@
-export { useNotForm } from "notform";