@pinegrow/vite-plugin 3.0.0-beta.143 → 3.0.0-beta.145

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pinegrow/vite-plugin",
-	"version": "3.0.0-beta.143",
+	"version": "3.0.0-beta.145",
 	"description": "Pinegrow Vite Plugin",
 	"type": "module",
 	"files": [
@@ -12,9 +12,9 @@
 	"types": "./types.d.ts",
 	"exports": {
 		".": {
+			"types": "./types.d.ts",
 			"import": "./dist/index.cjs",
-			"require": "./dist/index.cjs",
-			"types": "./types.d.ts"
+			"require": "./dist/index.cjs"
 		},
 		"./dev": {
 			"import": "./src/index.js",
@@ -22,9 +22,6 @@
 		},
 		"./vue": {
 			"import": "./dist/vue/index.js"
-		},
-		"./pgia": {
-			"import": "./dist/pgia/index.js"
 		}
 	},
 	"keywords": [

package/types.d.ts

@@ -1,3 +1,5 @@
+// https://pinegrow.com/vue-designer
+
 import type { PinegrowTailwindCSSModuleOptions } from '@pinegrow/tailwindcss-plugin'
 import type { PluginOption as VitePluginOption } from 'vite'
 
@@ -20,46 +22,50 @@ interface PinegrowExternalPlugin {
 	 * Must return an absolute path
 	 *
 	 * Use path functions according to the project module type (commonjs/module)
-	 * For eg, path.resolve(__dirname, '../relative-path/my-lib.cjs')
+	 * For eg, path.resolve(__dirname, '../my-awesome-lib/web-types.json')
 	 * (or)
 	 * import { fileURLToPath, URL } from 'node:url'
 	 * fileURLToPath(new URL('./relative-path/web-types.json', import.meta.url)) // web-types of component library
-	 * fileURLToPath(new URL('./relative-path/my-lib.cjs', import.meta.url)) // pinegrow commonjs plugin
+	 * fileURLToPath(new URL('./my-awesome-lib/web-types.json', import.meta.url)) // pinegrow commonjs plugin
 	 */
 	pluginPath: string
 }
 
 export interface LiveDesignerOptions {
 	/**
-	 * Absolute path to the root of a monorepo.
+	 * When your project is part of a mono-repo
+	 * Absolute path to the root of a monorepo (or)
 	 * Relative path from the project root to the root of a monorepo.
 	 */
 	repoRoot?: string
 
 	/**
-	 * Absolute path to a custom config file (for eg, vite-dev.config.js).
+	 * When using a custom config file (for eg, vite-dev.config.js)
+	 * Absolute path to a custom config file (for eg, vite-dev.config.js) (or)
 	 * Relative path from the project root to a custom config file (for eg, vite-dev.config.js).
 	 */
 	configPath?: string
 
 	/**
 	 * Key of the devtools exposed on the window object.
-	 * For instructions, check Config Panel in Vue Designer
+	 * For instructions, check Config Panel > Devtools tab in Vue Designer
 	 */
 	devtoolsKey?: string
 
 	/**
 	 * Preferred format for icons in icon-picker - https://github.com/antfu/icones/blob/main/src/utils/case.ts
-	 * To see the different formats, go to https://icones.js.org/collection/mdi, turn off name copying mode if active, select an icon. In the bottom drawer, next to the icon-name & copy icon, there is dropup icon. Click the drop-up to see the different formats.
 	 * * @default 'unocss' // For eg, i-material-symbols-home
+	 * * When using Nuxt-Icon, you need to change this to 'iconify'
 	 *
 	 */
 	iconPreferredCase?:
 		| 'unocss'
+		| 'iconify'
 		| 'bare'
 		| 'barePascal'
-		| 'iconify'
 		| 'dash'
+		| 'slash'
+		| 'doubleHyphen'
 		| 'camel'
 		| 'pascal'
 		| 'component'
@@ -70,7 +76,7 @@ export interface LiveDesignerOptions {
 	 * @default 'html5'
 	 */
 
-	routerHistoryMode?: string //
+	routerHistoryMode?: string
 
 	/**
 	 * Array of Pinegrow plugins (npm package names)
@@ -80,6 +86,7 @@ export interface LiveDesignerOptions {
 
 	/**
 	 * Pinegrow TailwindCSS plugin options
+	 * For options, refer to https://www.npmjs.com/package/@pinegrow/tailwindcss-plugin
 	 */
 	tailwindcss?: PinegrowTailwindCSSModuleOptions
 }
@@ -87,7 +94,6 @@ export interface LiveDesignerOptions {
 interface PinegrowVitePlugin<VitePluginOption> {
 	/**
 	 * Pinegrow Live Designer options
-	 * For details, check https://pinegrow.com/vue-designer
 	 */
 	liveDesigner?: {
 		[key in string]?: any