@md-plugins/vite-examples-plugin 0.1.0-alpha.9 → 0.1.0-beta.0

package/README.md

@@ -14,14 +14,12 @@ A Vite plugin that facilitates handling Vue example files in both development an
 Install the plugin via your preferred package manager:
 
 ```bash
-# npm
-npm install @md-plugins/vite-examples-plugin
-
-# yarn
-yarn add @md-plugins/vite-examples-plugin
-
-# pnpm
+# with pnpm
 pnpm add @md-plugins/vite-examples-plugin
+# with yarn
+yarn add @md-plugins/vite-examples-plugin
+# with npm
+npm install @md-plugins/vite-examples-plugin
 ```
 
 ## Usage
@@ -33,13 +31,16 @@ To use the `viteExamplesPlugin`, configure it in your Vite project:
 ```typescript
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
-import { viteExamplesPlugin, viteManualChunks } from 'vite-examples-plugin'
+import { viteExamplesPlugin, viteManualChunks } from '@md-plugins/vite-examples-plugin'
 
 export default defineConfig(({ mode }) => {
   const isProduction = mode === 'production'
 
   return {
-    plugins: [vue(), viteExamplesPlugin(isProduction, '/absolute/path/to/examples')],
+    plugins: [
+      vue(),
+      viteExamplesPlugin({ isProd: isProduction, path: '/absolute/path/to/examples' }),
+    ],
   }
 })
 ```
@@ -49,15 +50,22 @@ export default defineConfig(({ mode }) => {
 ```js
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
-import { viteExamplesPlugin, viteManualChunks } from 'vite-examples-plugin'
+import { viteExamplesPlugin, viteManualChunks } from '@md-plugins/vite-examples-plugin'
 
-export default defineConfig({
-  plugins: [vue(), viteExamplesPlugin('/absolute/path/to/examples')],
-  build: {
-    chunkSizeWarningLimit: 650,
-    rollupOptions: {
-      output: {
-        manualChunks: viteManualChunks,
+export default defineConfig(({ mode }) => {
+  const isProduction = mode === 'production'
+
+  return {
+    plugins: [
+      vue(),
+      viteExamplesPlugin({ isProd: isProduction, path: '/absolute/path/to/examples' }),
+    ],
+    build: {
+      chunkSizeWarningLimit: 650,
+      rollupOptions: {
+        output: {
+          manualChunks: viteManualChunks,
+        },
       },
     },
   },
@@ -69,7 +77,7 @@ export default defineConfig({
 1. Update `quasar.config.(js|ts)`:
 
 ```js
-import { viteExamplesPlugin } from '@md-plugin/vite-examples-plugin';
+import { viteExamplesPlugin } from '@md-plugins/vite-examples-plugin'
 
 export default defineConfig((ctx) => {
   // ...
@@ -78,7 +86,7 @@ export default defineConfig((ctx) => {
 ```js
   build: {
     vitePlugins: [
-      viteExamplesPlugin(ctx.isProd, ctx.appPaths.srcDir + '/examples'),
+      viteExamplesPlugin({ isProd: ctx.isProd, path: ctx.appPaths.srcDir + '/examples' }),
       // ...
     ],
   },
@@ -198,6 +206,10 @@ If the `targetFolder` is not defined when the plugin is initialized, an error wi
 throw new Error('targetFolder is not defined')
 ```
 
+## Documentation
+
+In case this README falls out of date, please refer to the [documentation](https://md-plugins.netlify.app/vite-plugins/vite-examples-plugin/overview) for the latest information.
+
 ## License
 
 This project is licensed under the MIT License. See the [LICENSE](LICENSE.md) file for details.

package/dist/index.d.mts

@@ -20,7 +20,10 @@ import { Plugin } from 'vite';
  *          The `resolveId` property resolves module IDs starting with "examples:" and returns a resolved ID.
  *          The `load` property loads example code based on the production or development environment.
  */
-declare function viteExamplesPlugin(isProd: boolean, path: string): Plugin;
+declare function viteExamplesPlugin({ isProd, path }: {
+    isProd: boolean;
+    path: string;
+}): Plugin;
 
 /**
  * A function to determine the manual chunk name for a given module ID.

package/dist/index.d.ts

@@ -20,7 +20,10 @@ import { Plugin } from 'vite';
  *          The `resolveId` property resolves module IDs starting with "examples:" and returns a resolved ID.
  *          The `load` property loads example code based on the production or development environment.
  */
-declare function viteExamplesPlugin(isProd: boolean, path: string): Plugin;
+declare function viteExamplesPlugin({ isProd, path }: {
+    isProd: boolean;
+    path: string;
+}): Plugin;
 
 /**
  * A function to determine the manual chunk name for a given module ID.

package/dist/index.mjs

@@ -44,7 +44,7 @@ function vitePlugin(isProd) {
     load: isProd ? prodLoad : devLoad
   };
 }
-function viteExamplesPlugin(isProd, path) {
+function viteExamplesPlugin({ isProd, path }) {
   targetFolder = path;
   return vitePlugin(isProd);
 }

package/package.json

@@ -1,26 +1,31 @@
 {
   "name": "@md-plugins/vite-examples-plugin",
-  "version": "0.1.0-alpha.9",
+  "version": "0.1.0-beta.0",
   "description": "A Vite plugin for @md-plugins for handling imported examples in markdown files.",
   "keywords": [
     "markdown-it",
     "quasarframework",
-    "vue",
     "utils",
     "vite",
-    "vite-plugin"
+    "vite-plugin",
+    "vue"
   ],
   "homepage": "https://github.com/md-plugins",
   "bugs": {
     "url": "https://github.com/md-plugins/md-plugins/issues"
   },
+  "license": "MIT",
+  "author": "hawkeye64 <galbraith64@gmail.com>",
   "repository": {
     "type": "git",
     "url": "git+https://github.com/md-plugins/md-plugins.git"
   },
-  "license": "MIT",
-  "author": "hawkeye64 <galbraith64@gmail.com>",
+  "files": [
+    "./dist"
+  ],
   "type": "module",
+  "module": "./dist/index.mjs",
+  "types": "./dist/index.d.ts",
   "exports": {
     ".": {
       "import": {
@@ -29,17 +34,14 @@
       }
     }
   },
-  "module": "./dist/index.mjs",
-  "types": "./dist/index.d.ts",
-  "files": [
-    "./dist"
-  ],
   "publishConfig": {
     "access": "public"
   },
+  "dependencies": {
+    "tinyglobby": "^0.2.16"
+  },
   "devDependencies": {
-    "tinyglobby": "^0.2.10",
-    "vite": "^6.0.7"
+    "vite": "^8.0.12"
   },
   "scripts": {
     "build": "unbuild",