Chore: Rename Option to Config

Author: thomasthiebaud

src/options.ts renamed to src/config.ts

@@ -29,7 +29,7 @@ export interface UserProfiles {
   svgFilters?: boolean
 }
 
-export interface DOMOptions {
+export interface DOMConfig {
   ADD_ATTR?: string[]
   ADD_TAGS?: string[]
   ALLOW_DATA_ATTR?: boolean
@@ -51,32 +51,32 @@ export interface DOMOptions {
   WHOLE_DOCUMENT?: boolean
 }
 
-export interface Options {
-  dom?: DOMOptions
+export interface Config {
+  dom?: DOMConfig
   eventHandlers?: SelectorsToEventHandlers
 }
 
 /**
  * Options that cannot be overidden by the user because they are used internaly by the library
  */
-const mandatoryOptions: Options = {
+const mandatoryConfig: Config = {
   dom: {
     RETURN_DOM: false,
     RETURN_DOM_FRAGMENT: true,
     RETURN_DOM_IMPORT: false,
   },
 }
 
-const defaultOptions: Options = {
+const defaultConfig: Config = {
   dom: {
     ADD_ATTR: ['key'],
   },
 }
 
-export function getOptions(options?: Partial<Options>): Options {
-  if (options) {
-    return deepMerge(defaultOptions, deepMerge(options, mandatoryOptions))
+export function getConfig(config?: Partial<Config>): Config {
+  if (config) {
+    return deepMerge(defaultConfig, deepMerge(config, mandatoryConfig))
   } else {
-    return deepMerge(defaultOptions, mandatoryOptions)
+    return deepMerge(defaultConfig, mandatoryConfig)
   }
 }

src/dom.ts

@@ -1,6 +1,6 @@
 import * as dompurify from 'dompurify'
 
-import { Options } from './options'
+import { Config } from './config'
 
 export enum NodeType {
   ELEMENT_NODE = 1,
@@ -21,6 +21,6 @@ export function getAttributes(elementAttributes: NamedNodeMap) {
   return attributes
 }
 
-export function parse(html: string, options: Options): DocumentFragment {
-  return dompurify.sanitize(html, options.dom) as DocumentFragment
+export function parse(html: string, config: Config): DocumentFragment {
+  return dompurify.sanitize(html, config.dom) as DocumentFragment
 }

src/index.ts

@@ -1,14 +1,14 @@
+import { Config, getConfig } from './config'
 import * as dom from './dom'
 import { addEventHandlers } from './event'
-import { getOptions, Options } from './options'
 import { render } from './react'
 
-export function parse(html: string, userOptions?: Options): React.ReactNode[] {
+export function parse(html: string, userOptions?: Config): React.ReactNode[] {
   if (typeof html !== 'string') {
     throw new TypeError('First argument must be a string.')
   }
 
-  const options = getOptions(userOptions)
+  const options = getConfig(userOptions)
   const document = dom.parse(html, options)
 
   if (options.eventHandlers) {

tests/options.spec.ts renamed to tests/config.spec.ts

@@ -1,9 +1,9 @@
-import { getOptions } from '../src/options'
+import { getConfig } from '../src/config'
 
 describe('Options', () => {
   describe('#getOptions', () => {
     it('should get default options', () => {
-      const defaultOptions = getOptions()
+      const defaultOptions = getConfig()
       expect(defaultOptions).toEqual({
         dom: {
           ADD_ATTR: ['key'],
@@ -15,7 +15,7 @@ describe('Options', () => {
     })
 
     it('should merge user options and default options', () => {
-      const options = getOptions({
+      const options = getConfig({
         dom: {
           ADD_TAGS: ['script'],
         },
@@ -32,7 +32,7 @@ describe('Options', () => {
     })
 
     it('should not be possible to override mandatory options set internaly by the library', () => {
-      const options = getOptions({
+      const options = getConfig({
         dom: {
           RETURN_DOM_FRAGMENT: false,
         },

tests/dom.spec.ts

@@ -1,10 +1,10 @@
+import { getConfig } from '../src/config'
 import { parse } from '../src/dom'
-import { getOptions } from '../src/options'
 
 describe('DOM', () => {
   describe('#parse', () => {
     it('should sanitize input', () => {
-      const document = parse('This is a <a onclick="console.log(\"WAZAAAA\")">test</a> <script/>', getOptions())
+      const document = parse('This is a <a onclick="console.log(\"WAZAAAA\")">test</a> <script/>', getConfig())
       const children = document.childNodes
       expect(children.length).toEqual(3)
       expect(children.item(0).textContent).toEqual('This is a ')