Commit ⋅ remarkjs/strip-markdown

Showing 1 of 10 files from the diff.

100.00% 100.00% ø

index.js changed.

Other files ignored by Codecov

package.json has changed.

types/tsconfig.json was deleted.

types/index.d.ts was deleted.

types/tslint.json was deleted.

.gitignore has changed.

types/test.ts was deleted.

tsconfig.json is new.

test.js has changed.

readme.md has changed.

@@ -1,5 +1,29 @@

Loading

1		-	// Expose modifiers for available node types.
2		-	// Node types not listed here are not changed (but their children are).
	1	+	/**
	2	+	* @typedef {import('mdast').Content} Content
	3	+	* @typedef {import('mdast').Root} Root
	4	+	* @typedef {Root\|Content} Node
	5	+	* @typedef {Node['type']} Type
	6	+	*
	7	+	* @callback Handler
	8	+	* @param {any} node
	9	+	* @returns {Node\|Node[]} node
	10	+	*
	11	+	* @typedef {Partial<Record<Type, Handler>>} Handlers
	12	+	*
	13	+	* @typedef Options
	14	+	* Configuration.
	15	+	* @property {Array.<Type>\|undefined} [keep]
	16	+	* List of node types to leave unchanged.
	17	+	* @property {Array.<Type\|[Type, Handler]>\|undefined} [remove]
	18	+	* List of additional node types to remove or replace.
	19	+	*/
	20	+
	21	+	/**
	22	+	* Expose modifiers for available node types.
	23	+	* Node types not listed here are not changed (but their children are).
	24	+	*
	25	+	* @type {Handlers}
	26	+	*/
3	27		const defaults = {
4	28		heading: paragraph,
5	29		text,

@@ -18,13 +42,14 @@

Loading

  linkReference: children,

  code: empty,
  horizontalRule: empty,
  thematicBreak: empty,
  html: empty,
  table: empty,
  tableCell: empty,
  definition: empty,
  yaml: empty,

  // @ts-expect-error: custom frontmatter node.
  toml: empty,

  footnoteReference: empty,

@@ -33,6 +58,12 @@

Loading


const own = {}.hasOwnProperty

/**
 * Plugin to remove markdown formatting.
 *
 * @type {import('unified').Plugin<[Options?] | void[], Root>}
 * @returns {import('unified').Transformer<Root>}
 */
export default function stripMarkdown(options = {}) {
  const handlers = Object.assign({}, defaults)
  const remove = options.remove || []

@@ -50,11 +81,13 @@

Loading

    }
  }

  /** @type {Handlers} */
  let map = {}

  if (keep.length === 0) {
    map = handlers
  } else {
    /** @type {Type} */
    let key

    for (key in handlers) {

@@ -79,32 +112,48 @@

Loading

    }
  }

  // @ts-expect-error: assume content model (for root) matches.
  return one

  /**
   * @param {Node} node
   * @returns {Node|Node[]}
   */
  function one(node) {
    /** @type {Type} */
    const type = node.type
    /** @type {Node|Node[]} */
    let result = node

    if (type in map) {
      const result = map[type](node)
      node = Array.isArray(result) ? all(result) : result
      const handler = map[type]
      if (handler) result = handler(result)
    }

    if (node.children) {
      node.children = all(node.children)
    result = Array.isArray(result) ? all(result) : result

    if ('children' in result) {
      // @ts-expect-error: assume content models match.
      result.children = all(result.children)
    }

    return node
    return result
  }

  /**
   * @param {Node[]} nodes
   * @returns {Node[]}
   */
  function all(nodes) {
    const result = []
    let index = -1
    /** @type {Node[]} */
    const result = []

    while (++index < nodes.length) {
      const value = one(nodes[index])

      if (Array.isArray(value)) {
        result.push(...value.map((d) => one(d)))
        result.push(...value.flatMap((d) => one(d)))
      } else {
        result.push(value)
      }

@@ -114,16 +163,24 @@

Loading

  }
}

// Clean nodes: merges texts.
/**
 * Clean nodes: merges literals.
 *
 * @param {Node[]} values
 * @returns {Node[]}
 */
function clean(values) {
  const result = []
  let index = -1
  /** @type {Node[]} */
  const result = []
  /** @type {Node|undefined} */
  let previous

  while (++index < values.length) {
    const value = values[index]

    if (previous && value.type === previous.type && 'value' in value) {
      // @ts-expect-error: we just checked that they’re the same node.
      previous.value += value.value
    } else {
      result.push(value)

@@ -134,26 +191,49 @@

Loading

  return result
}

/**
 * @type {Handler}
 * @param {import('mdast').Image|import('mdast').ImageReference} node
 */
function image(node) {
  return {type: 'text', value: node.alt || node.title || ''}
  const title = 'title' in node ? node.title : ''
  return {type: 'text', value: node.alt || title || ''}
}

/**
 * @type {Handler}
 * @param {import('mdast').Text} node
 */
function text(node) {
  return {type: 'text', value: node.value}
}

/**
 * @type {Handler}
 * @param {import('mdast').Paragraph} node
 */
function paragraph(node) {
  return {type: 'paragraph', children: node.children}
}

/**
 * @type {Handler}
 * @param {Extract<Node, import('unist').Parent>} node
 */
function children(node) {
  return node.children || []
}

/**
 * @type {Handler}
 */
function lineBreak() {
  return {type: 'text', value: '\n'}
}

/**
 * @type {Handler}
 */
function empty() {
  return {type: 'text', value: ''}
}

Files		•	•	•	Coverage
index.js	239	239	0	0	100.00%
Project Totals (1 files)	239	239	0	0	100.00%

View CI Build Download

No yaml found.

Create your codecov.yml to customize your Codecov experience

Read the docs

Interact now

The inner-most circle is the entire project, moving away from the center are folders then, finally, a single file. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

The top section represents the entire project. Proceeding with folders and finally individual files. The size and color of each slice is representing the number of statements and the coverage, respectively.

SVG

Each block represents a single file in the project. The size and color of each block is represented by the number of statements and the coverage, respectively.

SVG

Learn more about the coverage sunburst graph

33	58
34	59		const own = {}.hasOwnProperty
35	60
	61	+	/**
	62	+	* Plugin to remove markdown formatting.
	63	+	*
	64	+	* @type {import('unified').Plugin<[Options?] \| void[], Root>}
	65	+	* @returns {import('unified').Transformer<Root>}
	66	+	*/
36	67		export default function stripMarkdown(options = {}) {
37	68		const handlers = Object.assign({}, defaults)
38	69		const remove = options.remove \|\| []

50	81		}
51	82		}
52	83
	84	+	/** @type {Handlers} */
53	85		let map = {}
54	86
55	87		if (keep.length === 0) {
56	88		map = handlers
57	89		} else {
	90	+	/** @type {Type} */
58	91		let key
59	92
60	93		for (key in handlers) {

79	112		}
80	113		}
81	114
	115	+	// @ts-expect-error: assume content model (for root) matches.
82	116		return one
83	117
	118	+	/**
	119	+	* @param {Node} node
	120	+	* @returns {Node\|Node[]}
	121	+	*/
84	122		function one(node) {
	123	+	/** @type {Type} */
85	124		const type = node.type
	125	+	/** @type {Node\|Node[]} */
	126	+	let result = node
86	127
87	128		if (type in map) {
88		-	const result = map[type](node)
89		-	node = Array.isArray(result) ? all(result) : result
	129	+	const handler = map[type]
	130	+	if (handler) result = handler(result)
90	131		}
91	132
92		-	if (node.children) {
93		-	node.children = all(node.children)
	133	+	result = Array.isArray(result) ? all(result) : result
	134	+
	135	+	if ('children' in result) {
	136	+	// @ts-expect-error: assume content models match.
	137	+	result.children = all(result.children)
94	138		}
95	139
96		-	return node
	140	+	return result
97	141		}
98	142
	143	+	/**
	144	+	* @param {Node[]} nodes
	145	+	* @returns {Node[]}
	146	+	*/
99	147		function all(nodes) {
100		-	const result = []
101	148		let index = -1
	149	+	/** @type {Node[]} */
	150	+	const result = []
102	151
103	152		while (++index < nodes.length) {
104	153		const value = one(nodes[index])
105	154
106	155		if (Array.isArray(value)) {
107		-	result.push(...value.map((d) => one(d)))
	156	+	result.push(...value.flatMap((d) => one(d)))
108	157		} else {
109	158		result.push(value)
110	159		}

114	163		}
115	164		}
116	165
117		-	// Clean nodes: merges texts.
	166	+	/**
	167	+	* Clean nodes: merges literals.
	168	+	*
	169	+	* @param {Node[]} values
	170	+	* @returns {Node[]}
	171	+	*/
118	172		function clean(values) {
119		-	const result = []
120	173		let index = -1
	174	+	/** @type {Node[]} */
	175	+	const result = []
	176	+	/** @type {Node\|undefined} */
121	177		let previous
122	178
123	179		while (++index < values.length) {
124	180		const value = values[index]
125	181
126	182		if (previous && value.type === previous.type && 'value' in value) {
	183	+	// @ts-expect-error: we just checked that they’re the same node.
127	184		previous.value += value.value
128	185		} else {
129	186		result.push(value)

134	191		return result
135	192		}
136	193
	194	+	/**
	195	+	* @type {Handler}
	196	+	* @param {import('mdast').Image\|import('mdast').ImageReference} node
	197	+	*/
137	198		function image(node) {
138		-	return {type: 'text', value: node.alt \|\| node.title \|\| ''}
	199	+	const title = 'title' in node ? node.title : ''
	200	+	return {type: 'text', value: node.alt \|\| title \|\| ''}
139	201		}
140	202
	203	+	/**
	204	+	* @type {Handler}
	205	+	* @param {import('mdast').Text} node
	206	+	*/
141	207		function text(node) {
142	208		return {type: 'text', value: node.value}
143	209		}
144	210
	211	+	/**
	212	+	* @type {Handler}
	213	+	* @param {import('mdast').Paragraph} node
	214	+	*/
145	215		function paragraph(node) {
146	216		return {type: 'paragraph', children: node.children}
147	217		}
148	218
	219	+	/**
	220	+	* @type {Handler}
	221	+	* @param {Extract<Node, import('unist').Parent>} node
	222	+	*/
149	223		function children(node) {
150	224		return node.children \|\| []
151	225		}
152	226
	227	+	/**
	228	+	* @type {Handler}
	229	+	*/
153	230		function lineBreak() {
154	231		return {type: 'text', value: '\n'}
155	232		}
156	233
	234	+	/**
	235	+	* @type {Handler}
	236	+	*/
157	237		function empty() {
158	238		return {type: 'text', value: ''}
159	239		}

18	42		linkReference: children,
19	43
20	44		code: empty,
21		-	horizontalRule: empty,
22	45		thematicBreak: empty,
23	46		html: empty,
24	47		table: empty,
25	48		tableCell: empty,
26	49		definition: empty,
27	50		yaml: empty,
	51	+
	52	+	// @ts-expect-error: custom frontmatter node.
28	53		toml: empty,
29	54
30	55		footnoteReference: empty,

Navigation	Overlay
`t` Navigate files	`h` Toggle hits
`y` Change url to tip of branch	`m` Toggle misses
`b / v` Jump to prev/next hit line	`p` Toggle partial
`z / x` Jump to prev/next missed or partial line	`1..9` Toggle flags
`shift + o` Open current page in GitHub	`a` Toggle all on
`/ or ?` Show keyboard shortcuts dialog	`c` Toggle context lines or commits

Updating our web app

No yaml found.