@docusaurus/plugin-ideal-image 0.0.0-4317 → 0.0.0-4328

package/lib/index.d.ts

@@ -4,6 +4,7 @@
  * This source code is licensed under the MIT license found in the
  * LICENSE file in the root directory of this source tree.
  */
-import { LoadContext, Plugin } from '@docusaurus/types';
+import type { LoadContext, Plugin, OptionValidationContext, ValidationResult } from '@docusaurus/types';
 import type { PluginOptions } from '@docusaurus/plugin-ideal-image';
-export default function (_context: LoadContext, options: PluginOptions): Plugin<void>;
+export default function pluginIdealImage(_context: LoadContext, options: PluginOptions): Plugin<void>;
+export declare function validateOptions({ validate, options, }: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions>;

package/lib/index.js

@@ -6,16 +6,22 @@
  * LICENSE file in the root directory of this source tree.
  */
 Object.defineProperty(exports, '__esModule', {value: true});
+exports.validateOptions = void 0;
 const tslib_1 = require('tslib');
+const utils_validation_1 = require('@docusaurus/utils-validation');
 const path_1 = (0, tslib_1.__importDefault)(require('path'));
-function default_1(_context, options) {
+function pluginIdealImage(_context, options) {
   return {
     name: 'docusaurus-plugin-ideal-image',
     getThemePath() {
-      return path_1.default.resolve(__dirname, './theme');
+      return path_1.default.resolve(__dirname, '../lib/theme');
+    },
+    getTypeScriptThemePath() {
+      return path_1.default.resolve(__dirname, '../src/theme');
     },
     configureWebpack(_config, isServer) {
-      if (process.env.NODE_ENV !== 'production') {
+      const {disableInDev, ...loaderOptions} = options;
+      if (disableInDev && process.env.NODE_ENV !== 'production') {
         return {};
       }
       return {
@@ -35,7 +41,7 @@ function default_1(_context, options) {
                     // eslint-disable-next-line global-require
                     adapter: require('@docusaurus/responsive-loader/sharp'),
                     name: 'assets/ideal-img/[name].[hash:hex:7].[width].[ext]',
-                    ...options,
+                    ...loaderOptions,
                   },
                 },
               ],
@@ -46,4 +52,11 @@ function default_1(_context, options) {
     },
   };
 }
-exports.default = default_1;
+exports.default = pluginIdealImage;
+function validateOptions({validate, options}) {
+  const pluginOptionsSchema = utils_validation_1.Joi.object({
+    disableInDev: utils_validation_1.Joi.boolean().default(true),
+  }).unknown();
+  return validate(pluginOptionsSchema, options);
+}
+exports.validateOptions = validateOptions;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@docusaurus/plugin-ideal-image",
-  "version": "0.0.0-4317",
+  "version": "0.0.0-4328",
   "description": "Docusaurus Plugin to generate an almost ideal image (responsive, lazy-loading, and low quality placeholder).",
   "main": "lib/index.js",
   "types": "src/plugin-ideal-image.d.ts",
@@ -21,9 +21,10 @@
   },
   "license": "MIT",
   "dependencies": {
-    "@docusaurus/core": "0.0.0-4317",
-    "@docusaurus/lqip-loader": "0.0.0-4317",
+    "@docusaurus/core": "0.0.0-4328",
+    "@docusaurus/lqip-loader": "0.0.0-4328",
     "@docusaurus/responsive-loader": "1.5.0",
+    "@docusaurus/utils-validation": "0.0.0-4328",
     "@endiliey/react-ideal-image": "^0.0.11",
     "react-waypoint": "^10.1.0",
     "sharp": "^0.29.1",
@@ -31,7 +32,7 @@
     "webpack": "^5.61.0"
   },
   "devDependencies": {
-    "@docusaurus/types": "0.0.0-4317",
+    "@docusaurus/types": "0.0.0-4328",
     "fs-extra": "^10.0.0"
   },
   "peerDependencies": {
@@ -41,5 +42,5 @@
   "engines": {
     "node": ">=14"
   },
-  "gitHead": "2bb530c3c0e21f46fba7df4a7abe529480a24b22"
+  "gitHead": "fff574bab7bd31cf3b86f66f0ba7c49b5cd4d61e"
 }

package/src/index.ts

@@ -5,13 +5,19 @@
  * LICENSE file in the root directory of this source tree.
  */
 
-import {LoadContext, Plugin} from '@docusaurus/types';
+import type {
+  LoadContext,
+  Plugin,
+  OptionValidationContext,
+  ValidationResult,
+} from '@docusaurus/types';
 import type {PluginOptions} from '@docusaurus/plugin-ideal-image';
-import {Configuration} from 'webpack';
+import type {Configuration} from 'webpack';
+import {Joi} from '@docusaurus/utils-validation';
 
 import path from 'path';
 
-export default function (
+export default function pluginIdealImage(
   _context: LoadContext,
   options: PluginOptions,
 ): Plugin<void> {
@@ -19,11 +25,16 @@ export default function (
     name: 'docusaurus-plugin-ideal-image',
 
     getThemePath() {
-      return path.resolve(__dirname, './theme');
+      return path.resolve(__dirname, '../lib/theme');
+    },
+
+    getTypeScriptThemePath() {
+      return path.resolve(__dirname, '../src/theme');
     },
 
     configureWebpack(_config: Configuration, isServer: boolean) {
-      if (process.env.NODE_ENV !== 'production') {
+      const {disableInDev, ...loaderOptions} = options;
+      if (disableInDev && process.env.NODE_ENV !== 'production') {
         return {};
       }
 
@@ -44,7 +55,7 @@ export default function (
                     // eslint-disable-next-line global-require
                     adapter: require('@docusaurus/responsive-loader/sharp'),
                     name: 'assets/ideal-img/[name].[hash:hex:7].[width].[ext]',
-                    ...options,
+                    ...loaderOptions,
                   },
                 },
               ],
@@ -55,3 +66,13 @@ export default function (
     },
   };
 }
+
+export function validateOptions({
+  validate,
+  options,
+}: OptionValidationContext<PluginOptions>): ValidationResult<PluginOptions> {
+  const pluginOptionsSchema = Joi.object({
+    disableInDev: Joi.boolean().default(true),
+  }).unknown();
+  return validate(pluginOptionsSchema, options);
+}

package/src/plugin-ideal-image.d.ts

@@ -35,6 +35,10 @@ declare module '@docusaurus/plugin-ideal-image' {
      * JPEG compression quality
      */
     quality?: number;
+    /**
+     * Just use regular images in dev mode
+     */
+    disableInDev?: boolean;
   };
 }