From 5f9114fd3e0e667a5740f8ea7d0aa0c740af0e6e Mon Sep 17 00:00:00 2001
From: Christian Murphy <christian.murphy.42@gmail.com>
Date: Sat, 28 Mar 2020 01:28:57 -0700
Subject: [PATCH] parse: add tsdocs for parser options, note `pedantic` is
 deprecated

Related-to GH-470.
Related-to GH-477.
Closes GH-480.

Reviewed-by: Titus Wormer <tituswormer@gmail.com>
---
 packages/remark-parse/types/index.d.ts | 62 ++++++++++++++++++++++++++
 1 file changed, 62 insertions(+)

diff --git a/packages/remark-parse/types/index.d.ts b/packages/remark-parse/types/index.d.ts
index d61b070b5..8a69d55ed 100644
--- a/packages/remark-parse/types/index.d.ts
+++ b/packages/remark-parse/types/index.d.ts
@@ -21,10 +21,72 @@ declare namespace remarkParse {
   type Parser = RemarkParser
 
   interface RemarkParseOptions {
+    /**
+     * GFM mode
+     *
+     * Turns on:
+     * * Fenced code blocks
+     * * Autolinking of URLs
+     * * Deletions (strikethrough)
+     * * Task lists
+     * * Tables
+     *
+     * @defaultValue `true`
+     */
     gfm: boolean
+
+    /**
+     * CommonMark mode
+     *
+     * Allows:
+     * * Empty lines to split blockquotes
+     * * Parentheses (`(` and `)`) around link and image titles
+     * * Any escaped ASCII punctuation character
+     * * Closing parenthesis (`)`) as an ordered list marker
+     * * URL definitions (and footnotes, when enabled) in blockquotes
+     *
+     * Disallows:
+     * * Indented code blocks directly following a paragraph
+     * * ATX headings (# Hash headings) without spacing after opening hashes or and before closing hashes
+     * * Setext headings (`Underline headings\n---`) when following a paragraph
+     * * Newlines in link and image titles
+     * * White space in link and image URLs in auto-links (links in brackets, `<` and `>`)
+     * * Lazy blockquote continuation, lines not preceded by a greater than character (`>`), for lists, code, and thematic breaks
+     *
+     * @defaultValue `false`
+     */
     commonmark: boolean
+
+    /**
+     * Footnotes mode
+     *
+     * Enables reference footnotes and inline footnotes.
+     * Both are wrapped in square brackets and preceded by a caret (`^`),
+     * and can be referenced from inside other footnotes.
+     *
+     * @defaultValue `false`
+     */
     footnotes: boolean
+
+    /**
+     * Defines which HTML elements are seen as block level.
+     *
+     * @defaultValue blocks listed in <https://github.com/remarkjs/remark/blob/master/packages/remark-parse/lib/block-elements.js>
+     */
     blocks: string[]
+
+    /**
+     * Pedantic mode
+     *
+     * Turns on:
+     * * Emphasis (`_alpha_`) and importance (`__bravo__`) with underscores in words
+     * * Unordered lists with different markers (`*`, `-`, `+`)
+     * * If commonmark is also turned on, ordered lists with different markers (`.`, `)`)
+     * * And removes less spaces in list items (at most four, instead of the whole indent)
+     *
+     * @defaultValue `false`
+     * @deprecated pedantic mode is buggy. It won’t be in micromark, which will be the basis of a future version of remark.
+     */
     pedantic: boolean
   }