remark-parse - npm Package Compare versions

Comparing version 7.0.0 to 7.0.1

package.json

 {
   "name": "remark-parse",
-  "version": "7.0.0",
+  "version": "7.0.1",
   "description": "remark plugin to parse Markdown",
@@ -5,0 +5,0 @@ "license": "MIT",

readme.md

@@ -80,16 +80,17 @@ # remark-parse
 *   [API](#api)
-    *   [processor().use(parse\[, options\])](#processoruseparse-options)
-    *   [parse.Parser](#parseparser)
+    *   [`processor().use(parse[, options])`](#processoruseparse-options)
+    *   [`parse.Parser`](#parseparser)
 *   [Extending the Parser](#extending-the-parser)
-    *   [Parser#blockTokenizers](#parserblocktokenizers)
-    *   [Parser#blockMethods](#parserblockmethods)
-    *   [Parser#inlineTokenizers](#parserinlinetokenizers)
-    *   [Parser#inlineMethods](#parserinlinemethods)
-    *   [function tokenizer(eat, value, silent)](#function-tokenizereat-value-silent)
-    *   [tokenizer.locator(value, fromIndex)](#tokenizerlocatorvalue-fromindex)
-    *   [eat(subvalue)](#eatsubvalue)
-    *   [add(node\[, parent\])](#addnode-parent)
-    *   [add.test()](#addtest)
-    *   [add.reset(node\[, parent\])](#addresetnode-parent)
+    *   [`Parser#blockTokenizers`](#parserblocktokenizers)
+    *   [`Parser#blockMethods`](#parserblockmethods)
+    *   [`Parser#inlineTokenizers`](#parserinlinetokenizers)
+    *   [`Parser#inlineMethods`](#parserinlinemethods)
+    *   [`function tokenizer(eat, value, silent)`](#function-tokenizereat-value-silent)
+    *   [`tokenizer.locator(value, fromIndex)`](#tokenizerlocatorvalue-fromindex)
+    *   [`eat(subvalue)`](#eatsubvalue)
+    *   [`add(node[, parent])`](#addnode-parent)
+    *   [`add.test()`](#addtest)
+    *   [`add.reset(node[, parent])`](#addresetnode-parent)
     *   [Turning off a tokenizer](#turning-off-a-tokenizer)
+*   [Security](#security)
 *   [Contribute](#contribute)
@@ -122,7 +123,7 @@ *   [License](#license)
 
-*   [Fenced code blocks](https://help.github.com/articles/github-flavored-markdown/#fenced-code-blocks)
-*   [Autolinking of URLs](https://help.github.com/articles/github-flavored-markdown/#url-autolinking)
-*   [Deletions (strikethrough)](https://help.github.com/articles/github-flavored-markdown/#strikethrough)
-*   [Task lists](https://help.github.com/articles/writing-on-github/#task-lists)
-*   [Tables](https://help.github.com/articles/github-flavored-markdown/#tables)
+*   [Fenced code blocks](https://help.github.com/articles/creating-and-highlighting-code-blocks#fenced-code-blocks)
+*   [Autolinking of URLs](https://help.github.com/articles/autolinked-references-and-urls)
+*   [Deletions (strikethrough)](https://help.github.com/articles/basic-writing-and-formatting-syntax#styling-text)
+*   [Task lists](https://help.github.com/articles/basic-writing-and-formatting-syntax#task-lists)
+*   [Tables](https://help.github.com/articles/organizing-information-with-tables)
 
@@ -483,2 +484,12 @@ ###### `options.commonmark`
 
+## Security
+
+As Markdown is sometimes used for HTML, and improper use of HTML can open you up
+to a [cross-site scripting (XSS)][xss] attack, use of remark can also be unsafe.
+When going to HTML, use remark in combination with the [**rehype**][rehype]
+ecosystem, and use [`rehype-sanitize`][sanitize] to make the tree safe.
+
+Use of remark plugins could also open you up to other attacks.
+Carefully assess each plugin and the risks involved in using them.
+
 ## Contribute
@@ -583,1 +594,7 @@
 [remark-disable-tokenizers]: https://github.com/zestedesavoir/zmarkdown/tree/master/packages/remark-disable-tokenizers
+
+[xss]: https://en.wikipedia.org/wiki/Cross-site_scripting
+
+[rehype]: https://github.com/rehypejs/rehype
+
+[sanitize]: https://github.com/rehypejs/rehype-sanitize

types/index.d.ts

 // TypeScript Version: 3.0
 
 import {Node, Parent, Position} from 'unist'
-import {Parser, Attacher} from 'unified'
+import {Parser, Plugin} from 'unified'
 
@@ -16,3 +16,3 @@ declare class RemarkParser implements Parser {
 declare namespace remarkParse {
-  interface Parse extends Attacher<[Partial<RemarkParseOptions>]> {
+  interface Parse extends Plugin<[Partial<RemarkParseOptions>?]> {
     (options: Partial<RemarkParseOptions>): void
@@ -19,0 +19,0 @@ Parser: typeof RemarkParser

No alert changes

Improved metrics

Total package byte prevSize

112727

increased by0.61%

Number of lines in readme file

597

increased by2.93%

No dependency changes