Make sure option names are consistent and update TS definitions

reshape · Jun 1, 2019 · f8212e7 · f8212e7
1 parent f2abb7d
commit f8212e7
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 11 deletions.
diff --git a/README.md b/README.md
@@ -79,7 +79,7 @@ reshape({
 
 | Name                                | Description                                                                                                                                       | Default            |
 | ----------------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |
-| **replacementTag**                  | Tag used to replace the custom element tag name                                                                                                   | `div`              |
+| **defaultReplacementTag**           | Tag used to replace the custom element tag name                                                                                                   | `div`              |
 | **additionalTags**                  | Array of tags to be processed despite being a normal HTML tag                                                                                     | `[]`               |
 | **blacklist**                       | Array of tags that should never be processed                                                                                                      | `[]`               |
 | **replacementTagMap**               | Object containing custom tag ↔ replacement tag mappings in the format: `ReplacedTag: [ customTag1, customTag2, ... ]`. Overrides `replacementTag` | `{}`               |

diff --git a/index.d.ts b/index.d.ts
@@ -1,11 +1,16 @@
+export default function reshapeCustomElements(
+  options?: ReshapeCustomElementsOptions
+): Function
+
 export interface ReshapeCustomElementsOptions {
-  replacementTag: string
-  additionalTags: HtmlTags[]
+  defaultReplacementTag?: string
+  additionalTags?: HtmlTags[]
+  blacklist?: string[]
+  replacementTagMap?: ReplacementTagMap
+  replacementTagAttr?: string
 }
 
-export default function reshapeCustomElements(
-  options: ReshapeCustomElementsOptions
-): Function
+export type ReplacementTagMap = { [tag: string]: string[] }
 
 type HtmlTags =
   | 'a'

diff --git a/lib/index.js b/lib/index.js
@@ -2,12 +2,12 @@ const { modifyNodes } = require('reshape-plugin-util')
 
 module.exports = function reshapeCustomElements(options = {}) {
   const defaultReplacementTag =
-    options.replacementTag || options.defaultTag || 'div'
+    options.defaultReplacementTag || options.defaultTag || 'div'
   const additionalTags = options.additionalTags || options.skipTags || []
+  const blacklist = options.blacklist || []
+  const replacementTagMap = createLookupMap(options.replacementTagMap || {})
   const replacementTagAttr =
     options.replacementTagOverrideAttribute || 'data-replacement'
-  const replacementTagMap = createLookupMap(options.replacementTagMap || {})
-  const blacklist = options.blacklist || []
 
   return function(tree) {
     return modifyNodes(

diff --git a/test/test.js b/test/test.js
@@ -32,10 +32,10 @@ test('undefined options', t => {
   return compare(t, html, expected, undefined)
 })
 
-test('replacementTag', t => {
+test('defaultReplacementTag', t => {
   const html = '<custom class="custom">Test</custom>'
   const expected = '<span class="custom">Test</span>'
-  return compare(t, html, expected, { replacementTag: 'span' })
+  return compare(t, html, expected, { defaultReplacementTag: 'span' })
 })
 
 test('additionalTags option', t => {