feat: rename customOptionsFactory to optionsGenerator

Calvin-LL · Jan 11, 2021 · 678af94 · 678af94
1 parent 4a81bee
commit 678af94
Show file tree

Hide file tree

Showing 7 changed files with 37 additions and 41 deletions.
diff --git a/README.md b/README.md
@@ -85,12 +85,12 @@ import webpSrcSet from "./some_pic.jpg?srcset&format=webp";
 // webpSrcSet will be "00[...]5.webp 480w, 40[...]3.webp 1024w, 76[...]b.webp 1920w, a4[...]c.webp 2560w, b1[...]c.webp"
 ```
 
-| Name                                                | Type         | Default   | Description                                                                                  |
-| --------------------------------------------------- | ------------ | --------- | -------------------------------------------------------------------------------------------- |
-| **[`sizes`](#sizes)**                               | `(string)[]` | undefined | Sizes in the output srcset.                                                                  |
-| **[`scaleUp`](#scaleup)**                           | `boolean`    | `false`   | Whether or not to scale up the image when the desired width is greater than the image width. |
-| **[`customOptionsFactory`](#customoptionsfactory)** | `function`   | undefined | A function that returns the option to be passed on to the next loader.                       |
-| **[`esModule`](#esmodule)**                         | `boolean`    | `true`    | Whether the export is in ES modules syntax or CommonJS modules syntax                        |
+| Name                                        | Type         | Default   | Description                                                                                  |
+| ------------------------------------------- | ------------ | --------- | -------------------------------------------------------------------------------------------- |
+| **[`sizes`](#sizes)**                       | `(string)[]` | undefined | Sizes in the output srcset.                                                                  |
+| **[`scaleUp`](#scaleup)**                   | `boolean`    | `false`   | Whether or not to scale up the image when the desired width is greater than the image width. |
+| **[`optionsGenerator`](#optionsgenerator)** | `function`   | undefined | A function that returns the option to be passed on to the next loader.                       |
+| **[`esModule`](#esmodule)**                 | `boolean`    | `true`    | Whether the export is in ES modules syntax or CommonJS modules syntax                        |
 
 ### `sizes`
 
@@ -108,7 +108,7 @@ When true, if the desired width is greater than the image width, the size will n
 
 Note: this option has no effect on `"[number]x"` or `"original"`
 
-### `customOptionsFactory`
+### `optionsGenerator`
 
 If you wish to use a resize loader other than [webpack-image-resize-loader](https://github.com/Calvin-LL/webpack-image-resize-loader). You may customize how the width and scale is passed down to that loader`s options.
 
@@ -122,12 +122,12 @@ If you wish to use a resize loader other than [webpack-image-resize-loader](http
 }
 ```
 
-For example, if `sizes` is `["10w", "1x", "2x", "original"]`, `customOptionsFactory` will be called with
+For example, if `sizes` is `["10w", "1x", "2x", "original"]`, `optionsGenerator` will be called with
 
-- `customOptionsFactory(10, undefined, existingOptions)` for `10w`
-- `customOptionsFactory(undefined, 1, existingOptions)` for `1x`
-- `customOptionsFactory(undefined, 2, existingOptions)` for `2x`
-- `customOptionsFactory(undefined, undefined, existingOptions)` for `"original"`
+- `optionsGenerator(10, undefined, existingOptions)` for `10w`
+- `optionsGenerator(undefined, 1, existingOptions)` for `1x`
+- `optionsGenerator(undefined, 2, existingOptions)` for `2x`
+- `optionsGenerator(undefined, undefined, existingOptions)` for `"original"`
 
 ### `esModule`
 

diff --git a/src/helpers/getRequireStringWithModifiedResizeLoaderOptions.ts b/src/helpers/getRequireStringWithModifiedResizeLoaderOptions.ts
@@ -13,7 +13,7 @@ export default function getRequireStringWithModifiedResizeLoaderOptions(
   loaderIndex: number,
   options: { width?: number; scale?: number },
   resizeLoaderName: string,
-  customOptionsFactory: FullOptions["customOptionsFactory"]
+  optionsGenerator: FullOptions["optionsGenerator"]
 ): string {
   const resizeLoaderResolvedPath = require.resolve(resizeLoaderName);
   const resizeLoader = loaders.find(
@@ -31,18 +31,14 @@ export default function getRequireStringWithModifiedResizeLoaderOptions(
   const resizeLoaderRequest = resizeLoader.request;
   const resizeLoaderPath = resizeLoader.path;
 
-  if (customOptionsFactory)
+  if (optionsGenerator)
     return remainingRequest.replace(
       resizeLoaderRequest,
       resizeLoaderPath +
         "?" +
         escapeJsonStringForLoader(
           JSON.stringify(
-            customOptionsFactory(
-              options.width,
-              options.scale,
-              resizeLoaderOptions
-            )
+            optionsGenerator(options.width, options.scale, resizeLoaderOptions)
           )
         )
     );

diff --git a/src/index.ts b/src/index.ts
@@ -15,7 +15,7 @@ export interface Options {
   readonly sizes?: (`${number}w` | `${number}x` | "original")[];
   readonly scaleUp?: boolean;
   readonly resizeLoader?: string;
-  readonly customOptionsFactory?: (
+  readonly optionsGenerator?: (
     width: number | undefined,
     scale: number | undefined,
     existingOptions: Record<string, any> | undefined
@@ -104,7 +104,7 @@ async function generateSrcSetString(
         loaderIndex,
         {},
         options.resizeLoader,
-        options.customOptionsFactory
+        options.optionsGenerator
       )}${requireEnd}${separator}`;
 
       continue;
@@ -127,7 +127,7 @@ async function generateSrcSetString(
       loaderIndex,
       resizeLoaderOption,
       options.resizeLoader,
-      options.customOptionsFactory
+      options.optionsGenerator
     )}${requireEnd} ${size}${separator}`;
   }
 

diff --git a/src/options.json b/src/options.json
@@ -18,7 +18,7 @@
       "description": "Name of resize loader. Default to \"webpack-image-resize-loader\".",
       "type": "string"
     },
-    "customOptionsFactory": {
+    "optionsGenerator": {
       "description": "A function that returns the option to be passed on to webpack-image-resize-loader.",
       "instanceof": "Function"
     },

diff --git a/test/e2e/customOptionsFactory-option.test.ts → test/e2e/optionsGenerator-option.test.ts b/test/e2e/customOptionsFactory-option.test.ts → test/e2e/optionsGenerator-option.test.ts
@@ -1,10 +1,10 @@
 import WISLWebpackTestCompiler from "./helpers/WISLWebpackTestCompiler";
 
 describe.each([4, 5] as const)(
-  'v%d "customOptionsFactory" option',
+  'v%d "optionsGenerator" option',
   (webpackVersion) => {
     it("should work with a function", async () => {
-      const mockCustomOptionsFactory: (
+      const mockOptionsGenerator: (
         width: number | undefined,
         scale: number | undefined,
         existingOptions: Record<string, any>
@@ -18,18 +18,18 @@ describe.each([4, 5] as const)(
       const bundle = await compiler.compile({
         loaderOptions: {
           sizes: ["2x", "original", "1x", "300w"],
-          customOptionsFactory: (
+          optionsGenerator: (
             width: number | undefined,
             scale: number | undefined,
             existingOptions: Record<string, any>
-          ) => mockCustomOptionsFactory(width, scale, existingOptions),
+          ) => mockOptionsGenerator(width, scale, existingOptions),
         },
       });
 
       expect(bundle.execute("main.js")).toMatchSnapshot("result");
 
-      expect(mockCustomOptionsFactory).toHaveBeenCalled();
-      expect(mockCustomOptionsFactory).toMatchSnapshot();
+      expect(mockOptionsGenerator).toHaveBeenCalled();
+      expect(mockOptionsGenerator).toMatchSnapshot();
     });
   }
 );
diff --git a/test/e2e/validate-options.test.ts b/test/e2e/validate-options.test.ts
@@ -16,7 +16,7 @@ describe.each([4, 5] as const)("v%d validate options", (webpackVersion) => {
       success: ["webpack-image-resize-loader"],
       failure: [3],
     },
-    customOptionsFactory: {
+    optionsGenerator: {
       success: [() => ({})],
       failure: [true],
     },

diff --git a/test/unit/getRequireStringWithModifiedResizeLoaderOptions.test.ts b/test/unit/getRequireStringWithModifiedResizeLoaderOptions.test.ts
@@ -28,15 +28,15 @@ it("should handle resizeLoaderPath options being string", () => {
   ];
   const loaderIndex = 0;
   const options = {};
-  const customOptionsFactory = undefined;
+  const optionsGenerator = undefined;
 
   const result = getRequireStringWithModifiedResizeLoaderOptions(
     remainingRequest,
     loaders,
     loaderIndex,
     options,
     resizeLoaderName,
-    customOptionsFactory
+    optionsGenerator
   );
 
   expect(result).toMatchInlineSnapshot(
@@ -72,15 +72,15 @@ it("should handle resizeLoaderPath options being object", () => {
   ];
   const loaderIndex = 0;
   const options = {};
-  const customOptionsFactory = undefined;
+  const optionsGenerator = undefined;
 
   const result = getRequireStringWithModifiedResizeLoaderOptions(
     remainingRequest,
     loaders,
     loaderIndex,
     options,
     resizeLoaderName,
-    customOptionsFactory
+    optionsGenerator
   );
 
   expect(result).toMatchInlineSnapshot(
@@ -116,15 +116,15 @@ it("should handle resizeLoaderPath options being undefined", () => {
   ];
   const loaderIndex = 0;
   const options = {};
-  const customOptionsFactory = undefined;
+  const optionsGenerator = undefined;
 
   const result = getRequireStringWithModifiedResizeLoaderOptions(
     remainingRequest,
     loaders,
     loaderIndex,
     options,
     resizeLoaderName,
-    customOptionsFactory
+    optionsGenerator
   );
 
   expect(result).toMatchInlineSnapshot(
@@ -160,7 +160,7 @@ it("should throw if resizeLoader not found", () => {
   ];
   const loaderIndex = 0;
   const options = {};
-  const customOptionsFactory = undefined;
+  const optionsGenerator = undefined;
 
   expect(() =>
     getRequireStringWithModifiedResizeLoaderOptions(
@@ -169,14 +169,14 @@ it("should throw if resizeLoader not found", () => {
       loaderIndex,
       options,
       "file-loader",
-      customOptionsFactory
+      optionsGenerator
     )
   ).toThrowErrorMatchingInlineSnapshot(
     `"Can't find file-loader in the list of loaders"`
   );
 });
 
-it("should handle customOptionsFactory", () => {
+it("should handle optionsGenerator", () => {
   const urlLoaderPath = require.resolve("url-loader");
   const resizeLoaderName = "webpack-image-resize-loader";
   const resizeLoaderPath = require.resolve(resizeLoaderName);
@@ -204,15 +204,15 @@ it("should handle customOptionsFactory", () => {
   ];
   const loaderIndex = 0;
   const options = {};
-  const customOptionsFactory = (): Record<string, any> => ({ test: "true" });
+  const optionsGenerator = (): Record<string, any> => ({ test: "true" });
 
   const result = getRequireStringWithModifiedResizeLoaderOptions(
     remainingRequest,
     loaders,
     loaderIndex,
     options,
     resizeLoaderName,
-    customOptionsFactory
+    optionsGenerator
   );
 
   expect(result).toMatchInlineSnapshot(