@md-plugins/vite-examples-plugin 0.1.0-alpha.2 → 0.1.0-alpha.20

package/README.md

@@ -30,13 +30,20 @@ pnpm add @md-plugins/vite-examples-plugin
 
 To use the `viteExamplesPlugin`, configure it in your Vite project:
 
-```js
+```typescript
 import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
-import { viteExamplesPlugin } from '@md-plugin/vite-examples-plugin'
+import { viteExamplesPlugin, viteManualChunks } from 'vite-examples-plugin'
+
+export default defineConfig(({ mode }) => {
+  const isProduction = mode === 'production'
 
-export default defineConfig({
-  plugins: [vue(), viteExamplesPlugin('/absolute/path/to/examples')],
+  return {
+    plugins: [
+      vue(),
+      viteExamplesPlugin({ isProd: isProduction, path: '/absolute/path/to/examples' }),
+    ],
+  }
 })
 ```
 
@@ -47,13 +54,20 @@ import { defineConfig } from 'vite'
 import vue from '@vitejs/plugin-vue'
 import { viteExamplesPlugin, viteManualChunks } from '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,
+        },
       },
     },
   },
@@ -74,7 +88,7 @@ export default defineConfig((ctx) => {
 ```js
   build: {
     vitePlugins: [
-      viteExamplesPlugin(ctx.appPaths.srcDir + '/examples'),
+      viteExamplesPlugin({ isProd: ctx.isProd, path: ctx.appPaths.srcDir + '/examples' }),
       // ...
     ],
   },
@@ -91,9 +105,7 @@ import { viteExamplesPlugin, viteManualChunks } from '@md-plugins/vite-examples-
   build: {
     extendViteConf(viteConf, { isClient }) {
       if (ctx.prod && isClient) {
-        if (!viteConf.build) {
-          viteConf.build = {}
-        }
+        viteConf.build = viteConf.build || {}
         viteConf.build.chunkSizeWarningLimit = 650
         viteConf.build.rollupOptions = {
           output: { manualChunks: viteManualChunks },
@@ -196,6 +208,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/viteexamplesplugin/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

@@ -7,12 +7,23 @@ import { Plugin } from 'vite';
  * that creates the actual Vite plugin. The returned plugin resolves and loads
  * example code based on the production or development environment.
  *
+ * @param isProd - A boolean indicating whether the Vite build is in production mode.
+ *                 This parameter determines whether the plugin will use the `prodLoad` or `devLoad` function for loading example code.
+ *
  * @param path - The path to the directory containing the example files.
  *               This path will be used as the target folder for resolving examples.
+ *               The `targetFolder` variable is set to this value before creating the Vite plugin.
  *
  * @returns A function that creates a Vite plugin.
+ *          The returned function takes a boolean parameter `isProd` and returns a Vite plugin object.
+ *          The plugin object has a `name`, `enforce`, `resolveId`, and `load` property.
+ *          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

@@ -7,12 +7,23 @@ import { Plugin } from 'vite';
  * that creates the actual Vite plugin. The returned plugin resolves and loads
  * example code based on the production or development environment.
  *
+ * @param isProd - A boolean indicating whether the Vite build is in production mode.
+ *                 This parameter determines whether the plugin will use the `prodLoad` or `devLoad` function for loading example code.
+ *
  * @param path - The path to the directory containing the example files.
  *               This path will be used as the target folder for resolving examples.
+ *               The `targetFolder` variable is set to this value before creating the Vite plugin.
  *
  * @returns A function that creates a Vite plugin.
+ *          The returned function takes a boolean parameter `isProd` and returns a Vite plugin object.
+ *          The plugin object has a `name`, `enforce`, `resolveId`, and `load` property.
+ *          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

@@ -10,7 +10,7 @@ function devLoad(id) {
     return `export const code = import.meta.glob(${query}, { eager: true })
 export const source = import.meta.glob(${query}, { query: '?raw', import: 'default', eager: true })`;
   }
-  return void 0;
+  return undefined;
 }
 function prodLoad(id) {
   if (id.startsWith(resolvedIdPrefix)) {
@@ -25,7 +25,7 @@ import Raw${entry} from 'app/src/examples/${exampleId}/${entry}.vue?raw'`
     return importStatements + `
 export {${exportStatements}}`;
   }
-  return void 0;
+  return undefined;
 }
 function vitePlugin(isProd) {
   if (!targetFolder) {
@@ -39,12 +39,12 @@ function vitePlugin(isProd) {
       if (moduleIdRE.test(id)) {
         return "\0" + id;
       }
-      return void 0;
+      return undefined;
     },
     load: isProd ? prodLoad : devLoad
   };
 }
-function viteExamplesPlugin(isProd, path) {
+function viteExamplesPlugin({ isProd, path }) {
   targetFolder = path;
   return vitePlugin(isProd);
 }
@@ -60,7 +60,7 @@ function viteManualChunks(id) {
     const name = examplesMatch[1] || examplesMatch[2];
     return `e.${name}`;
   }
-  return void 0;
+  return undefined;
 }
 
 export { viteExamplesPlugin, viteManualChunks };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/vite-examples-plugin",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.20",
   "description": "A Vite plugin for @md-plugins for handling imported examples in markdown files.",
   "keywords": [
     "markdown-it",
@@ -37,9 +37,9 @@
   "publishConfig": {
     "access": "public"
   },
-  "dependencies": {
+  "devDependencies": {
     "tinyglobby": "^0.2.10",
-    "vite": "^6.0.6"
+    "vite": "^6.0.7"
   },
   "scripts": {
     "build": "unbuild",