@pinegrow/vite-plugin 3.0.0-beta.110 → 3.0.0-beta.111

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@pinegrow/vite-plugin",
-	"version": "3.0.0-beta.110",
+	"version": "3.0.0-beta.111",
 	"description": "Pinegrow Vite Plugin",
 	"type": "module",
 	"files": [

package/types.d.ts

@@ -3,82 +3,62 @@ import type { Options as AutoImportComponentsOptions } from 'unplugin-vue-compon
 import type { Options as AutoImportAPIsOptions } from 'unplugin-auto-import/types'
 
 interface Options {
-	repoRoot?: string // relative path from the project root to the root of the monorepo
+	/**
+	 * Absolute path to the root of a monorepo.
+	 * Relative path from the project root to the root of a monorepo.
+	 */
+	repoRoot?: string
 
-	configPath?: string // relative path from project root to the custom config file when it's not auto-detected, for eg, './my-config.dev.js' or './docs/my-config.dev.js', defaults to viteServer.config.configFile
-
-	// pinegrow plugins
-	plugins?: string[]
-
-	// User can override the themePath in the plugin's options
-	// {
-	//   key: 'vuetify',
-	//   pluginPath: '...',
-	//   options: {
-	//     themePath: './src/themes' // directory or file, for eg, './src/themes/my-pg-theme.cjs'
-	//   }
-	// }
+	/**
+	 * Absolute path to a custom config file (for eg, vite-dev.config.js).
+	 * 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
+	 */
 	devtoolsKey?: string
-	// vscodeTunnelUrl?: string
 
-	// routerHistoryMode?: string // 'hash', 'html5' (default)
+	/**
+	 * Router history modes - 'html5', 'hash'
+	 * @default 'html5'
+	 */
 
-	// Adds to package.json, used when a package was installed (available in lock file) probably as a peer dependency, so not available in package.json
-	// mergeWithPackageJson?: {
-	// 	dependencies?: {}
-	// 	devDependencies?: {
-	// 		// vite: string;
-	// 	}
-	// }
+	routerHistoryMode?: string //
 
-	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' } },
-		defaultTypes?: {
-			// density: {
-			//   customType: "select";
-			//   // add options when customType is 'select'
-			//   options: ["default", "compact", "comfortable"];
-			// };
-		}
-	}
+	/**
+	 * Array of Pinegrow plugins (npm package names)
+	 */
+	plugins?: string[]
 
+	/**
+	 * Pinegrow TailwindCSS plugin options
+	 */
 	tailwindcss?: PinegrowTailwindCSSPluginOptions
-
-	autoImportComponents?: AutoImportComponentsOptions
-
-	autoImportAPIs?: AutoImportAPIsOptions
 }
 
 interface PinegrowVitePlugin {
+	/**
+	 * Pinegrow Live Designer options
+	 * For details, check https://pinegrow.com/vue-designer
+	 */
 	liveDesigner?: {
 		[key in string]?: any
 	} & Options
+
+	/**
+	 * unplugin-vue-components options for auto-importing local components and via resolvers
+	 * For details, check https://github.com/antfu/unplugin-vue-components#configuration
+	 */
+	autoImportComponents?: AutoImportComponentsOptions
+
+	/**
+	 * unplugin-auto-import options for auto-importing APIs using presets
+	 * For details, check https://github.com/antfu/unplugin-auto-import#configuration
+	 */
+	autoImportAPIs?: AutoImportAPIsOptions
 }
 
 declare function export_default(liveDesigner: Options): PinegrowVitePlugin