refactor: rename the "attributes" option to "sources" (#345)

BREAKING CHANGE: rename the "attributes" option to "sources"

Author: cap-Bernardito

README.md

@@ -52,12 +52,12 @@ module.exports = {
 
 |                Name                 |        Type         |                   Default                    | Description                                      |
 | :---------------------------------: | :-----------------: | :------------------------------------------: | :----------------------------------------------- |
-|   **[`attributes`](#attributes)**   | `{Boolean\|Object}` |                    `true`                    | Enables/Disables attributes handling             |
+|      **[`sources`](#sources)**      | `{Boolean\|Object}` |                    `true`                    | Enables/Disables sources handling                |
 | **[`preprocessor`](#preprocessor)** |    `{Function}`     |                 `undefined`                  | Allows pre-processing of content before handling |
 |     **[`minimize`](#minimize)**     | `{Boolean\|Object}` | `true` in production mode, otherwise `false` | Tell `html-loader` to minimize HTML              |
 |     **[`esModule`](#esmodule)**     |     `{Boolean}`     |                    `true`                    | Enable/disable ES modules syntax                 |
 
-### `attributes`
+### `sources`
 
 Type: `Boolean|Object`
 Default: `true`
@@ -103,7 +103,7 @@ module.exports = {
         loader: 'html-loader',
         options: {
           // Disables attributes processing
-          attributes: false,
+          sources: false,
         },
       },
     ],
@@ -127,7 +127,7 @@ module.exports = {
         test: /\.html$/i,
         loader: 'html-loader',
         options: {
-          attributes: {
+          sources: {
             list: [
               // All default supported tags and attributes
               '...',
@@ -164,11 +164,11 @@ module.exports = {
 #### `list`
 
 Type: `Array`
-Default: [supported tags and attributes](#attributes).
+Default: [supported tags and attributes](#sources).
 
 Allows to setup which tags and attributes to process and how, and the ability to filter some of them.
 
-Using `...` syntax allows you to extend [default supported tags and attributes](#attributes).
+Using `...` syntax allows you to extend [default supported tags and attributes](#sources).
 
 For example:
 
@@ -182,7 +182,7 @@ module.exports = {
         test: /\.html$/i,
         loader: 'html-loader',
         options: {
-          attributes: {
+          sources: {
             list: [
               // All default supported tags and attributes
               '...',
@@ -253,7 +253,7 @@ module.exports = {
         test: /\.html$/i,
         loader: 'html-loader',
         options: {
-          attributes: {
+          sources: {
             list: [
               {
                 // Attribute name
@@ -290,7 +290,7 @@ module.exports = {
         test: /\.html$/i,
         loader: 'html-loader',
         options: {
-          attributes: {
+          sources: {
             list: [
               {
                 tag: 'meta',
@@ -331,7 +331,7 @@ module.exports = {
         test: /\.html$/i,
         loader: 'html-loader',
         options: {
-          attributes: {
+          sources: {
             urlFilter: (attribute, value, resourcePath) => {
               // The `attribute` argument contains a name of the HTML attribute.
               // The `value` argument contains a value of the HTML attribute.
@@ -621,24 +621,24 @@ require('html-loader!./file.html');
 ```
 
 ```js
-require('html-loader?{"attributes":{"list":[{"tag":"img","attribute":"data-src","type":"src"}]}}!./file.html');
+require('html-loader?{"sources":{"list":[{"tag":"img","attribute":"data-src","type":"src"}]}}!./file.html');
 
 // => '<img src="image.jpg" data-src="data:image/png;base64,..." >'
 ```
 
 ```js
-require('html-loader?{"attributes":{"list":[{"tag":"img","attribute":"src","type":"src"},{"tag":"img","attribute":"data-src","type":"src"}]}}!./file.html');
+require('html-loader?{"sources":{"list":[{"tag":"img","attribute":"src","type":"src"},{"tag":"img","attribute":"data-src","type":"src"}]}}!./file.html');
 
 // => '<img src="http://cdn.example.com/49eba9f/a992ca.jpg" data-src="data:image/png;base64,..." >'
 ```
 
 ```js
-require('html-loader?-attributes!./file.html');
+require('html-loader?-sources!./file.html');
 
 // => '<img src="image.jpg"  data-src="image2x.png" >'
 ```
 
-> :warning: `-attributes` sets `attributes: false`.
+> :warning: `-sources` sets `sources: false`.
 
 ### Process `script` and `link` tags
 

src/index.js

@@ -1,4 +1,4 @@
-import { sourcePlugin, minimizerPlugin } from './plugins';
+import { sourcesPlugin, minimizerPlugin } from './plugins';
 import {
   pluginRunner,
   normalizeOptions,
@@ -23,10 +23,10 @@ export default async function loader(content) {
   const imports = [];
   const replacements = [];
 
-  if (options.attributes) {
+  if (options.sources) {
     plugins.push(
-      sourcePlugin({
-        attributes: options.attributes,
+      sourcesPlugin({
+        sources: options.sources,
         resourcePath: this.resourcePath,
         context: this.context,
         imports,

src/options.json

@@ -2,7 +2,7 @@
   "title": "HTML Loader options",
   "type": "object",
   "definitions": {
-    "Attribute": {
+    "Source": {
       "anyOf": [
         {
           "type": "object",
@@ -30,10 +30,10 @@
         }
       ]
     },
-    "AttributeList": {
+    "SourcesList": {
       "type": "array",
       "items": {
-        "$ref": "#/definitions/Attribute"
+        "$ref": "#/definitions/Source"
       },
       "minItems": 1,
       "uniqueItems": true
@@ -43,14 +43,14 @@
     "preprocessor": {
       "instanceof": "Function"
     },
-    "attributes": {
+    "sources": {
       "anyOf": [
         { "type": "boolean" },
         {
           "type": "object",
           "properties": {
             "list": {
-              "$ref": "#/definitions/AttributeList"
+              "$ref": "#/definitions/SourcesList"
             },
             "urlFilter": {
               "instanceof": "Function"

src/plugins/index.js

@@ -1,4 +1,4 @@
-import sourcePlugin from './source-plugin';
+import sourcesPlugin from './sources-plugin';
 import minimizerPlugin from './minimizer-plugin';
 
-export { sourcePlugin, minimizerPlugin };
+export { sourcesPlugin, minimizerPlugin };

src/plugins/source-plugin.js renamed to src/plugins/sources-plugin.js

@@ -14,7 +14,7 @@ import {
 
 export default (options) =>
   function process(html) {
-    const { list, urlFilter: maybeUrlFilter } = options.attributes;
+    const { list, urlFilter: maybeUrlFilter } = options.sources;
     const sources = [];
     const urlFilter = getFilter(maybeUrlFilter, (value) =>
       isUrlRequestable(value)

src/utils.js

@@ -754,31 +754,31 @@ function smartMergeSources(array, factory) {
   return newArray;
 }
 
-function getAttributesOption(rawOptions) {
-  if (typeof rawOptions.attributes === 'undefined') {
+function getSourcesOption(rawOptions) {
+  if (typeof rawOptions.sources === 'undefined') {
     return { list: defaultAttributes };
   }
 
-  if (typeof rawOptions.attributes === 'boolean') {
-    return rawOptions.attributes === true ? { list: defaultAttributes } : false;
+  if (typeof rawOptions.sources === 'boolean') {
+    return rawOptions.sources === true ? { list: defaultAttributes } : false;
   }
 
   const sources = smartMergeSources(
-    rawOptions.attributes.list,
+    rawOptions.sources.list,
     () => defaultAttributes
   );
 
   return {
     list: sources,
-    urlFilter: rawOptions.attributes.urlFilter,
-    root: rawOptions.attributes.root,
+    urlFilter: rawOptions.sources.urlFilter,
+    root: rawOptions.sources.root,
   };
 }
 
 export function normalizeOptions(rawOptions, loaderContext) {
   return {
     preprocessor: rawOptions.preprocessor,
-    attributes: getAttributesOption(rawOptions),
+    sources: getSourcesOption(rawOptions),
     minimize: getMinimizeOption(rawOptions, loaderContext),
     esModule:
       typeof rawOptions.esModule === 'undefined' ? true : rawOptions.esModule,

test/__snapshots__/attributes-option.test.js.snap renamed to test/__snapshots__/sources-option.test.js.snap

@@ -1,111 +1,111 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
-exports[`validate options should throw an error on the "attributes" option with "[]" value 1`] = `
+exports[`validate options should throw an error on the "esModule" option with "true" value 1`] = `
+"Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
+ - options.esModule should be a boolean."
+`;
+
+exports[`validate options should throw an error on the "sources" option with "[]" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes should be one of these:
+ - options.sources should be one of these:
    boolean | object { list?, urlFilter? }
    Details:
-    * options.attributes should be a boolean.
-    * options.attributes should be an object:
+    * options.sources should be a boolean.
+    * options.sources should be an object:
       object { list?, urlFilter? }"
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"list":[]}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"list":[]}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.list should be an non-empty array."
+ - options.sources.list should be an non-empty array."
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"list":[{"tag":"","attribute":"src","type":"src"}]}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"list":[{"tag":"","attribute":"src","type":"src"}]}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.list[0].tag should be an non-empty string."
+ - options.sources.list[0].tag should be an non-empty string."
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"list":[{"tag":"img","attribute":"src","type":"src","filter":"test"}]}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"list":[{"tag":"img","attribute":"src","type":"src","filter":"test"}]}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.list[0].filter should be an instance of function."
+ - options.sources.list[0].filter should be an instance of function."
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"list":[{"tag":"img","attribute":"src","type":"src"},{"tag":"img","attribute":"src","type":"src"}]}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"list":[{"tag":"img","attribute":"src","type":"src"},{"tag":"img","attribute":"src","type":"src"}]}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.list should not contain the item '[object Object]' twice."
+ - options.sources.list should not contain the item '[object Object]' twice."
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"list":[{"tag":"img","attribute":"src"}]}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"list":[{"tag":"img","attribute":"src"}]}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.list[0] misses the property 'type'. Should be:
+ - options.sources.list[0] misses the property 'type'. Should be:
    \\"src\\" | \\"srcset\\""
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"unknown":true}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"unknown":true}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes has an unknown property 'unknown'. These properties are valid:
+ - options.sources has an unknown property 'unknown'. These properties are valid:
    object { list?, urlFilter? }"
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "{"urlFilter":false}" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "{"urlFilter":false}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes.urlFilter should be an instance of function."
+ - options.sources.urlFilter should be an instance of function."
 `;
 
-exports[`validate options should throw an error on the "attributes" option with "true" value 1`] = `
+exports[`validate options should throw an error on the "sources" option with "true" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.attributes should be one of these:
+ - options.sources should be one of these:
    boolean | object { list?, urlFilter? }
    Details:
-    * options.attributes should be a boolean.
-    * options.attributes should be an object:
+    * options.sources should be a boolean.
+    * options.sources should be an object:
       object { list?, urlFilter? }"
 `;
 
-exports[`validate options should throw an error on the "esModule" option with "true" value 1`] = `
-"Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
- - options.esModule should be a boolean."
-`;
-
 exports[`validate options should throw an error on the "unknown" option with "/test/" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "[]" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "{"foo":"bar"}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "{}" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "1" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "false" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "test" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;
 
 exports[`validate options should throw an error on the "unknown" option with "true" value 1`] = `
 "Invalid options object. HTML Loader has been initialized using an options object that does not match the API schema.
  - options has an unknown property 'unknown'. These properties are valid:
-   object { preprocessor?, attributes?, minimize?, esModule? }"
+   object { preprocessor?, sources?, minimize?, esModule? }"
 `;