Refactor code-style

Author: wooorm

lib/index.js

@@ -5,27 +5,39 @@
  * @typedef {import('hast').Properties} Properties
  * @typedef {Parent['children'][number]|Root} Node
  *
- * @typedef {Properties[string]} PropertyValue Possible property values
- * @typedef {string|number|boolean} PrimitivePropertyValue Possible primitive HTML attribute values
- * @typedef {string|[string, ...PrimitivePropertyValue[]]} AttributeValue
- * @typedef {Object.<string, Array.<PrimitivePropertyValue>>} AttributeMap
+ * @typedef {Properties[string]} PropertyValue
+ *   Possible property values
+ * @typedef {string|number|boolean} PrimitivePropertyValue
+ *   Possible primitive HTML attribute values
+ * @typedef {string|[string, ...Array<PrimitivePropertyValue>]} AttributeValue
+ * @typedef {Record<string, Array<PrimitivePropertyValue>>} AttributeMap
  *
  * @typedef Schema Sanitization configuration
- * @property {Object<string, Array<AttributeValue>>} [attributes] Map of tag names to allowed property names. The special '*' key defines property names allowed on all elements
- * @property {Object<string, Object<string, PropertyValue>>} [required] Map of tag names to required property names and their default property value
- * @property {Array.<string>} [tagNames] List of allowed tag names
- * @property {Object<string, Array.<string>>} [protocols] Map of protocols to allow in property values
- * @property {Object<string, Array.<string>>} [ancestors] Map of tag names to their required ancestor elements
- * @property {Array.<string>} [clobber] List of allowed property names which can clobber
- * @property {string} [clobberPrefix] Prefix to use before potentially clobbering property names
- * @property {Array.<string>} [strip] Names of elements to strip from the tree
- * @property {boolean} [allowComments] Whether to allow comments
- * @property {boolean} [allowDoctypes] Whether to allow doctypes
+ * @property {Record<string, Array<AttributeValue>>} [attributes]
+ *   Map of tag names to allowed property names. The special '*' key defines property names allowed on all elements
+ * @property {Record<string, Record<string, PropertyValue>>} [required]
+ *   Map of tag names to required property names and their default property value
+ * @property {Array<string>} [tagNames]
+ *   List of allowed tag names
+ * @property {Record<string, Array<string>>} [protocols]
+ *   Map of protocols to allow in property values
+ * @property {Record<string, Array<string>>} [ancestors]
+ *   Map of tag names to their required ancestor elements
+ * @property {Array<string>} [clobber]
+ *   List of allowed property names which can clobber
+ * @property {string} [clobberPrefix]
+ *   Prefix to use before potentially clobbering property names
+ * @property {Array<string>} [strip]
+ *   Names of elements to strip from the tree
+ * @property {boolean} [allowComments]
+ *   Whether to allow comments
+ * @property {boolean} [allowDoctypes]
+ *   Whether to allow doctypes
  *
- * @typedef {(schema: Schema, value: any, node: any, stack: Array.<string>) => unknown} Handler
- * @typedef {Object.<string, Handler>} NodeDefinition
+ * @typedef {(schema: Schema, value: any, node: any, stack: Array<string>) => unknown} Handler
+ * @typedef {Record<string, Handler>} NodeDefinition
  * @typedef {((schema: Schema, node: Node) => NodeDefinition|undefined)} NodeDefinitionGetter
- * @typedef {Object.<string, NodeDefinition|NodeDefinitionGetter>} NodeSchema
+ * @typedef {Record<string, NodeDefinition|NodeDefinitionGetter>} NodeSchema
  */
 
 import {defaultSchema} from './schema.js'
@@ -49,8 +61,10 @@ const nodeSchema = {
 /**
  * Utility to sanitize a tree
  *
- * @param {Node} node Hast tree to sanitize
- * @param {Schema} [schema] Schema defining how to sanitize - defaults to Github style sanitation
+ * @param {Node} node
+ *   Hast tree to sanitize
+ * @param {Schema} [schema]
+ *   Schema defining how to sanitize - defaults to Github style sanitation
  */
 export function sanitize(node, schema) {
   /** @type {Node} */
@@ -85,8 +99,8 @@ export function sanitize(node, schema) {
  *
  * @param {Schema} schema
  * @param {Node} node
- * @param {Array.<string>} stack
- * @returns {Node|Array.<Node>|undefined}
+ * @param {Array<string>} stack
+ * @returns {Node|Array<Node>|undefined}
  */
 function one(schema, node, stack) {
   const type = node && node.type
@@ -149,12 +163,12 @@ function one(schema, node, stack) {
  * Sanitize `children`.
  *
  * @type {Handler}
- * @param {Array.<Node>} children
+ * @param {Array<Node>} children
  * @param {Node} node
- * @returns {Array.<Node>}
+ * @returns {Array<Node>}
  */
 function all(schema, children, node, stack) {
-  /** @type {Array.<Node>} */
+  /** @type {Array<Node>} */
   const results = []
 
   if (Array.isArray(children)) {
@@ -222,7 +236,7 @@ function handleProperties(schema, properties, node, stack) {
   for (key in props) {
     if (own.call(props, key)) {
       let value = props[key]
-      /** @type {Array.<PrimitivePropertyValue>} */
+      /** @type {Array<PrimitivePropertyValue>} */
       let definition
 
       if (own.call(allowed, key)) {
@@ -338,14 +352,14 @@ function allow(_, value) {
  * Sanitize a property value which is a list.
  *
  * @param {Schema} schema
- * @param {Array.<unknown>} values
+ * @param {Array<unknown>} values
  * @param {string} prop
- * @param {Array.<PrimitivePropertyValue>} definition
- * @returns {Array.<string|number>}
+ * @param {Array<PrimitivePropertyValue>} definition
+ * @returns {Array<string|number>}
  */
 function handlePropertyValues(schema, values, prop, definition) {
   let index = -1
-  /** @type {Array.<string|number>} */
+  /** @type {Array<string|number>} */
   const result = []
 
   while (++index < values.length) {
@@ -366,7 +380,7 @@ function handlePropertyValues(schema, values, prop, definition) {
  * @param {Schema} schema
  * @param {unknown} value
  * @param {string} prop
- * @param {Array.<PropertyValue>} definition
+ * @param {Array<PropertyValue>} definition
  * @returns {PropertyValue}
  */
 function handlePropertyValue(schema, value, prop, definition) {
@@ -431,7 +445,7 @@ function safeProtocol(schema, value, prop) {
 /**
  * Create a map from a list of props or a list of properties and values.
  *
- * @param {Array.<AttributeValue>} values
+ * @param {Array<AttributeValue>} values
  * @returns {AttributeMap}
  */
 function toPropertyValueMap(values) {

readme.md

@@ -122,7 +122,7 @@ console.log(tree)
 ###### `attributes`
 
 Map of tag names to allowed [*property names*][name]
-(`Object.<Array.<string>>`).
+(`Record<string, Array<string>>`).
 
 The special `'*'` key defines [*property names*][name] allowed on all
 [*elements*][element].
@@ -180,7 +180,7 @@ span: [
 ###### `required`
 
 Map of tag names to required [*property names*][name] and their default
-[*property value*][value] (`Object.<Object.<*>>`).
+[*property value*][value] (`Record<string, Record<string, *>>`).
 If the defined keys do not exist in an [*element*][element]’s
 [*properties*][properties], they are added and set to the specified value.
 
@@ -196,7 +196,7 @@ required: {
 
 ###### `tagNames`
 
-List of allowed tag names (`Array.<string>`).
+List of allowed tag names (`Array<string>`).
 
 ```js
 tagNames: [
@@ -213,7 +213,7 @@ tagNames: [
 ###### `protocols`
 
 Map of protocols to allow in [*property values*][value]
-(`Object.<Array.<string>>`).
+(`Record<string, Array<string>>`).
 
 ```js
 protocols: {
@@ -226,7 +226,7 @@ protocols: {
 ###### `ancestors`
 
 Map of tag names to their required [*ancestor*][ancestor] [*elements*][element]
-(`Object.<Array.<string>>`).
+(`Record<string, Array<string>>`).
 
 ```js
 ancestors: {
@@ -238,7 +238,7 @@ ancestors: {
 
 ###### `clobber`
 
-List of allowed [*property names*][name] which can clobber (`Array.<string>`).
+List of allowed [*property names*][name] which can clobber (`Array<string>`).
 
 ```js
 clobber: ['name', 'id']
@@ -255,7 +255,7 @@ clobberPrefix: 'user-content-'
 ###### `strip`
 
 Names of [*elements*][element] to strip from the [*tree*][tree]
-(`Array.<string>`).
+(`Array<string>`).
 
 By default, unsafe *elements* are replaced by their [*children*][child].
 Some *elements*, should however be entirely stripped from the *tree*.

test.js

@@ -702,7 +702,7 @@ function toString() {
  * @param {import('tape').Test} t
  * @param {string} tagName
  * @param {string} prop
- * @param {{valid: Object.<string, string>, invalid: Object.<string, string>}} all
+ * @param {{valid: Record<string, string>, invalid: Record<string, string>}} all
  */
 function testAllUrls(t, tagName, prop, all) {
   testUrls(t, tagName, prop, all.valid, true)
@@ -715,7 +715,7 @@ function testAllUrls(t, tagName, prop, all) {
  * @param {import('tape').Test} t
  * @param {string} tagName
  * @param {string} prop
- * @param {Object.<string, string>} urls
+ * @param {Record<string, string>} urls
  * @param {boolean} valid
  */
 function testUrls(t, tagName, prop, urls, valid) {