refactor: rename blacklistAttributes to blocklistAttributes

Author: cossssmin

README.md

@@ -117,7 +117,7 @@ You can run `npm run build` to compile them.
 |      **utilities**       | `{merge: _.mergeWith, template: _.template}`  | Object of utilities methods to be passed to `<script props>`. By default lodash `mergeWith` and `template`.                   |
 |  **elementAttributes**   |                     `{}`                      | An object with tag name and a function modifier of valid-attributes.js.                                                       |
 |  **safelistAttributes**  |         `['data-*']`                          | An array of attributes name to be added to default valid attributes.                                                          |
-| **blacklistAttributes**  |                     `[]`                      | An array of attributes name to be removed from default valid attributes.                                                      |
+| **blocklistAttributes**  |                     `[]`                      | An array of attributes name to be removed from default valid attributes.                                                      |
 
 ## Features
 
@@ -793,7 +793,7 @@ const options = {
   ],
 
   // Remove attributes from all tags that support it
-  blacklistAttributes: [
+  blocklistAttributes: [
     'role'
   ]
 }

docs-src/md/introduction.md

@@ -643,7 +643,7 @@ <h2 id="options" tabindex="-1">
                 </tr>
                 <tr>
                   <td style="text-align:center">
-                    <strong>blacklistAttributes</strong>
+                    <strong>blocklistAttributes</strong>
                   </td>
                   <td style="text-align:center">
                     <code>[]</code>
@@ -692,9 +692,9 @@ <h3 id="tag-names-and-x-tags" tabindex="-1">
             </p>
             <pre><code class="language-js">// index.js
 
-const options = { 
-  root: './src', 
-  matcher: [{tag: 'a-tag'}, {tag: 'another-one'}, {tag: new RegExp(`^app-`, 'i')}] 
+const options = {
+  root: './src',
+  matcher: [{tag: 'a-tag'}, {tag: 'another-one'}, {tag: new RegExp(`^app-`, 'i')}]
 };
 
 require('posthtml')(require('posthtml-components')(options))
@@ -710,8 +710,8 @@ <h3 id="tag-names-and-x-tags" tabindex="-1">
             <p>Setup PostHTML:</p>
             <pre><code class="language-js">// index.js
 
-const options = { 
-  root: './src', 
+const options = {
+  root: './src',
   tagPrefix: 'x-'
 };
 
@@ -759,9 +759,9 @@ <h3 id="multiple-folders" tabindex="-1">
 You can set up the plugin like below:
             </p>
             <pre><code class="language-js">// index.js
-const options = { 
-  root: './src', 
-  folders: ['components', 'layouts'] 
+const options = {
+  root: './src',
+  folders: ['components', 'layouts']
 };
 
 require('posthtml')(require('posthtml-components')(options))
@@ -991,7 +991,7 @@ <h3 id="stacks" tabindex="-1">
   &lt;fill:body&gt;Body content&lt;/fill:body&gt;
   &lt;fill:footer&gt;Footer content&lt;/fill:footer&gt;
 &lt;/x-modal&gt;
-  
+
 &lt;stack name=&quot;scripts&quot;&gt;&lt;/stack&gt;
 &lt;/body&gt;
 &lt;/html&gt;</code></pre>
@@ -1132,8 +1132,8 @@ <h3 id="props" tabindex="-1">
             <pre><code class="language-html">&lt;!-- src/modal.html --&gt;
 &lt;script props&gt;
   module.exports = {
-    title: props.title || 'Default title', 
-    size: props.size ? `modal-${props.size}` : '', 
+    title: props.title || 'Default title',
+    size: props.size ? `modal-${props.size}` : '',
     items: Array.isArray(props.items) ? props.items.concat(['first', 'second']) : ['first', 'second']
   }
 &lt;/script&gt;
@@ -1335,7 +1335,7 @@ <h3 id="advanced-attributes-configurations" tabindex="-1">
 
 const options = {
   root: './src',
-  
+
   // Add attributes to specific tag or override defaults
   elementAttributes: {
     DIV: (defaultAttributes) =&gt; {
@@ -1351,15 +1351,15 @@ <h3 id="advanced-attributes-configurations" tabindex="-1">
       return defaultAttributes;
     },
   },
-  
+
   // Add attributes to all tags, use '*' as wildcard for attribute name that starts with
   safelistAttributes: [
     'custom-attribute-name',
     'attribute-name-start-with-*'
   ],
 
   // Remove attributes from all tags that support it
-  blacklistAttributes: [
+  blocklistAttributes: [
     'role'
   ]
 }

docs/docs.html

@@ -80,7 +80,7 @@ module.exports = (options = {}) => tree => {
   // { TAG: (attributes) => { attributes[] = 'attribute-name'; return attributes; } }
   options.elementAttributes = isPlainObject(options.elementAttributes) ? options.elementAttributes : {};
   options.safelistAttributes = Array.isArray(options.safelistAttributes) ? options.safelistAttributes : [];
-  options.blacklistAttributes = Array.isArray(options.blacklistAttributes) ? options.blacklistAttributes : [];
+  options.blocklistAttributes = Array.isArray(options.blocklistAttributes) ? options.blocklistAttributes : [];
 
   // Merge customizer callback passed to lodash mergeWith
   //  for merge attribute `props` and all attributes starting with `merge:`

src/index.js

@@ -46,8 +46,8 @@ module.exports = (currentNode, attributes, props, options, aware) => {
 
   const nodeAttrs = parseAttrs(mainNode.attrs, options.attrsParserRules);
 
-  // Merge elementAttributes and blacklistAttributes with options provided
-  validAttributes.blacklistAttributes = union(validAttributes.blacklistAttributes, options.blacklistAttributes);
+  // Merge elementAttributes and blocklistAttributes with options provided
+  validAttributes.blocklistAttributes = union(validAttributes.blocklistAttributes, options.blocklistAttributes);
   validAttributes.safelistAttributes = union(validAttributes.safelistAttributes, options.safelistAttributes);
 
   // Merge or override elementAttributes from options provided
@@ -64,7 +64,7 @@ module.exports = (currentNode, attributes, props, options, aware) => {
   }
 
   // Attributes to be excluded
-  const excludeAttributes = union(validAttributes.blacklistAttributes, keys(props), keys(aware), keys(options.props), ['$slots']);
+  const excludeAttributes = union(validAttributes.blocklistAttributes, keys(props), keys(aware), keys(options.props), ['$slots']);
   // All valid HTML attributes for the main element
   const allValidElementAttributes = isString(mainNode.tag) && has(validAttributes.elementAttributes, mainNode.tag.toUpperCase()) ? validAttributes.elementAttributes[mainNode.tag.toUpperCase()] : [];
   // Valid HTML attributes without the excluded

src/process-attributes.js

@@ -3546,7 +3546,7 @@ module.exports = {
     ]
   },
 
-  // Safelist and blacklist attributes will be applied to all tags
+  // Safelist and blocklist attributes will be applied to all tags
 
   // Add additional attributes, use '*' in the end to check by startsWith
   // Example: 'start-with-*'
@@ -3556,5 +3556,5 @@ module.exports = {
   ],
 
   // Skip this attributes
-  blacklistAttributes: []
+  blocklistAttributes: []
 };

src/valid-attributes.js

@@ -100,15 +100,15 @@ test('Must work with tag without attributes', async () => {
   expect(html).toBe(expected);
 });
 
-test('Must use safelist and blacklist', async () => {
+test('Must use safelist and blocklist', async () => {
   const actual = `<component src="components/override-attributes.html" tabindex="-1" title="My button" custom-attribute="A custom attribute">My button</component>`;
   const expected = `<button custom-attribute="A custom attribute">My button</button>`;
 
   const html = await posthtml([plugin({
     root: './test/templates',
     tag: 'component',
     safelistAttributes: ['custom-attribute'],
-    blacklistAttributes: ['role', 'tabindex']
+    blocklistAttributes: ['role', 'tabindex']
   })]).process(actual).then(result => clean(result.html));
 
   expect(html).toBe(expected);