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

package/README.md

@@ -30,13 +30,17 @@ 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({
-  plugins: [vue(), viteExamplesPlugin('/absolute/path/to/examples')],
+export default defineConfig(({ mode }) => {
+  const isProduction = mode === 'production'
+
+  return {
+    plugins: [vue(), viteExamplesPlugin(isProduction, '/absolute/path/to/examples')],
+  }
 })
 ```
 
@@ -74,7 +78,7 @@ export default defineConfig((ctx) => {
 ```js
   build: {
     vitePlugins: [
-      viteExamplesPlugin(ctx.appPaths.srcDir + '/examples'),
+      viteExamplesPlugin(ctx.isProd, ctx.appPaths.srcDir + '/examples'),
       // ...
     ],
   },
@@ -91,9 +95,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 },

package/dist/index.d.mts

@@ -1,4 +1,4 @@
-import { Plugin } from 'vite';
+import { Plugin } from '/home/jeff/git/github/jeff/md-plugins/node_modules/.pnpm/vite@6.0.7_@types+node@22.10.5_jiti@2.4.2_sass-embedded@1.83.0_terser@5.37.0/node_modules/vite/dist/node/index.d.ts';
 
 /**
  * Creates a Vite plugin for handling Markdown examples.
@@ -7,10 +7,18 @@ 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;
 

package/dist/index.d.ts

@@ -1,4 +1,4 @@
-import { Plugin } from 'vite';
+import { Plugin } from '/home/jeff/git/github/jeff/md-plugins/node_modules/.pnpm/vite@6.0.7_@types+node@22.10.5_jiti@2.4.2_sass-embedded@1.83.0_terser@5.37.0/node_modules/vite/dist/node/index.d.ts';
 
 /**
  * Creates a Vite plugin for handling Markdown examples.
@@ -7,10 +7,18 @@ 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;
 

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@md-plugins/vite-examples-plugin",
-  "version": "0.1.0-alpha.2",
+  "version": "0.1.0-alpha.5",
   "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",