@pinegrow/nuxt-module 3.0.0-beta.98 → 3.0.1

package/README.md

@@ -1,5 +1,68 @@
-# @pinegrow/nuxt-module
+<!-- [![@pinegrow/nuxt-module](https://tailwindcss.nuxtjs.org/social-card.png)](https://tailwindcss.nuxtjs.org) -->
 
-## Pinegrow Nuxt module
+# Pinegrow Nuxt Module
 
-http://www.pinegrow.com
+[![npm version][npm-version-src]][npm-version-href]
+[![npm downloads][npm-downloads-src]][npm-downloads-href]
+[![License][license-src]][license-href]
+
+[Nuxt](https://nuxt.com/) module for [Pinegrow](https://pinegrow.com) ⚡️
+
+Pinegrow Nuxt Module enables connection and interaction between your Vite Dev-Server and Pinegrow apps (currently only Vue Designer).
+
+-   [&nbsp;Learn more about Vue Designer](https://vuedesigner.com)
+
+## Features
+
+-   🎨&nbsp; Visually live-design your Vite-powered Nuxt apps
+-   ⚙️&nbsp; Smartly integrates into your Nuxt workflow in dev-mode only
+-   ✨&nbsp; Clean code 😃, No lock-in - You are in control of your projects and development workflow ❤️
+
+## Quick Setup
+
+1. Install: Add `@pinegrow/nuxt-module` to your project
+
+```bash
+# Using npm
+npm install -D @pinegrow/nuxt-module
+
+# Using pnpm
+pnpm add -D @pinegrow/nuxt-module
+```
+
+2. Configure: Add `@pinegrow/nuxt-module` to your Nuxt Integrations array `nuxt.config.{js,ts}`
+
+```js
+//nuxt.config.js (or) nuxt.config.ts
+
+export default defineNuxtConfig({
+	modules: [
+		'@pinegrow/nuxt-module',
+		//...
+	],
+	pinegrow: {
+		liveDesigner: {
+			// For options, refer to https://www.npmjs.com/package/@pinegrow/vite-plugin
+			//...
+		},
+	},
+	//...
+})
+```
+
+Now, open your project in your Pinegrow app (currently only Vue Designer). ✨
+
+## License
+
+[MIT License](./LICENSE)
+
+Copyright (c) Pinegrow
+
+<!-- Badges -->
+
+[npm-version-src]: https://img.shields.io/npm/v/@pinegrow/nuxt-module/latest.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-version-href]: https://npmjs.com/package/@pinegrow/nuxt-module
+[npm-downloads-src]: https://img.shields.io/npm/dm/@pinegrow/nuxt-module.svg?style=flat&colorA=18181B&colorB=28CF8D
+[npm-downloads-href]: https://npmjs.com/package/@pinegrow/nuxt-module
+[license-src]: https://img.shields.io/npm/l/@pinegrow/nuxt-module.svg?style=flat&colorA=18181B&colorB=28CF8D
+[license-href]: https://npmjs.com/package/@pinegrow/nuxt-module

package/dist/chunks/live-designer.mjs

@@ -1,6 +1,7 @@
 import pkg from '@pinegrow/vite-plugin';
 
 // import { liveDesigner } from '@pinegrow/vite-plugin/dev'
+
 const liveDesigner = pkg.liveDesigner;
 
 export { liveDesigner };

package/dist/module.d.ts

@@ -1,19 +1,15 @@
 import * as _nuxt_schema from '@nuxt/schema';
+import { LiveDesignerOptions } from '@pinegrow/vite-plugin';
 
-interface ModuleOptions {
+interface PinegrowNuxtModuleOptions {
+    /**
+     * Pinegrow Live Designer options
+     * For details, check https://pinegrow.com/vue-designer
+     */
     liveDesigner?: {
         [key in string]?: any;
-    } & {
-        repoRoot?: string;
-        configPath?: string;
-        plugins?: string[];
-        devtoolsKey?: string;
-        vscodeTunnelUrl?: string;
-        customTypes?: {
-            default?: {};
-        };
-    };
+    } & LiveDesignerOptions;
 }
-declare const _default: _nuxt_schema.NuxtModule<ModuleOptions>;
+declare const _default: _nuxt_schema.NuxtModule<PinegrowNuxtModuleOptions>;
 
-export { ModuleOptions, _default as default };
+export { PinegrowNuxtModuleOptions, _default as default };

package/dist/module.json

@@ -4,5 +4,5 @@
   "compatibility": {
     "nuxt": "^3.1.0"
   },
-  "version": "3.0.0-beta.97"
+  "version": "3.0.0"
 }

package/dist/module.mjs

@@ -43,52 +43,14 @@ const module = defineNuxtModule({
     liveDesigner: {
       // repoRoot: './',
       // configPath: './',
-      plugins: [],
       // devtoolsKey: 'devtools',
-      // vscodeTunnelUrl: 'https://vscode.dev/tunnel/hostname',
-      // iconsets: [],
       // routerHistoryMode: 'html5',
-      // mergeWithPackageJson: {
-      // 	dependencies: {},
-      // 	devDependencies: {},
-      // },
-      customTypes: {
-        // To apply type overrides to a specific component (overrides above default fn),
-        // ComponentName: { prop: { customType: 'icon' } },
-        // VRating: {
-        //   ripple: {
-        //     customType: "boolean",
-        //   },
-        // },
-        // VSelect: {
-        // 	variant: {
-        // 		customType: 'select',
-        // 		options: ['plain', 'outlined', 'underlined', 'solo'],
-        // 		default: ''
-        // 	},
-        // 	density: {
-        // 		customType: 'select',
-        // 		options: ['default', 'compact', 'comfortable']
-        // 	},
-        // 	disabled: {
-        // 		customType: 'boolean'
-        // 	},
-        // 	appendIcon: {
-        // 		customType: 'icon'
-        // 	},
-        // }
-        // To apply type overrides to all components,
-        // all: { prop: { customType: 'icon' } },
-        default: {
-          // density: {
-          //   customType: "select",
-          //   // add options when customType is 'select'
-          //   options: ["default", "compact", "comfortable"],
-          // },
-        }
-      },
+      plugins: [],
       tailwindcss: {
-        cssPath: "./assets/css/tailwind.css"
+        configPath: "@/tailwind.config.js",
+        cssPath: "@/assets/css/tailwind.css"
+        // restartOnConfigUpdate: false,
+        // restartOnThemeUpdate: false,
       }
     }
   },

package/dist/types.d.ts

@@ -1,10 +1,7 @@
 
-import { ModuleOptions } from './module'
+import {  } from './module'
 
-declare module '@nuxt/schema' {
-  interface NuxtConfig { ['pinegrow']?: Partial<ModuleOptions> }
-  interface NuxtOptions { ['pinegrow']?: ModuleOptions }
-}
 
 
-export { ModuleOptions, default } from './module'
+
+export { PinegrowNuxtModuleOptions, default } from './module'

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pinegrow/nuxt-module",
-	"version": "3.0.0-beta.98",
+	"version": "3.0.1",
 	"description": "Pinegrow Nuxt Module",
 	"author": "Pinegrow (http://pinegrow.com/)",
 	"license": "MIT",
@@ -12,6 +12,7 @@
 	"module": "./dist/module.cjs",
 	"exports": {
 		".": {
+			"types": "./dist/types.d.ts",
 			"import": "./dist/module.mjs",
 			"require": "./dist/module.cjs"
 		}
@@ -19,7 +20,11 @@
 	"types": "./dist/types.d.ts",
 	"keywords": [
 		"pinegrow",
-		"nuxt module"
+		"vue designer",
+		"vuedesigner",
+		"vue-designer",
+		"nuxt-module",
+		"@pinegrow/nuxt-module"
 	],
 	"scripts": {
 		"build": "npm run dev:prepare && npm run build:module",
@@ -35,7 +40,7 @@
 	},
 	"dependencies": {
 		"@nuxt/kit": "latest",
-		"@pinegrow/vite-plugin": "3.0.0-beta.98"
+		"@pinegrow/vite-plugin": "3.0.1"
 	},
 	"devDependencies": {
 		"@nuxt/module-builder": "latest",