Populate list/list item metadata by default

Author: rexxars

demo/dist/js/demo.js

@@ -1,6 +1,10 @@
 // Type definitions for react-markdown > v3.3.0
 // Project: https://github.com/rexxars/react-markdown
-// Definitions by: Ruslan Ibragimov <https://github.com/IRus>, Kohei Asai <[email protected]>, ClassicDarkChocolate<https://github.com/ClassicDarkChocolate>
+// Definitions by:
+// - Ruslan Ibragimov <https://github.com/IRus>
+// - Kohei Asai <[email protected]>
+// - ClassicDarkChocolate <https://github.com/ClassicDarkChocolate>
+// - Espen Hovlandsdal <https://espen.codes/>
 
 import {Component, ReactElement, ReactNode, ReactType} from 'react'
 
@@ -91,6 +95,7 @@ declare namespace ReactMarkdown {
     checked?: boolean | null
     children?: MarkdownAbstractSyntaxTree[]
     data?: {[key: string]: any}
+    index?: number
     depth?: number
     height?: number
     identifier?: string

index.d.ts

@@ -34,6 +34,7 @@
     "staticpath": "demo/dist"
   },
   "dependencies": {
+    "mdast-add-list-metadata": "^1.0.0",
     "prop-types": "^15.6.1",
     "remark-parse": "^5.0.0",
     "unified": "^6.1.5",

package.json

@@ -4,6 +4,7 @@ const xtend = require('xtend')
 const unified = require('unified')
 const parse = require('remark-parse')
 const PropTypes = require('prop-types')
+const addListMetadata = require('mdast-add-list-metadata')
 const naiveHtml = require('./plugins/naive-html')
 const disallowNode = require('./plugins/disallow-node')
 const astToReact = require('./ast-to-react')
@@ -43,7 +44,7 @@ function applyParserPlugin(parser, plugin) {
 }
 
 function determineAstPlugins(props) {
-  const plugins = [wrapTableRows]
+  const plugins = [wrapTableRows, addListMetadata()]
 
   let disallowedTypes = props.disallowedTypes
   if (props.allowedTypes) {

src/react-markdown.js

@@ -1149,6 +1149,29 @@ foo();
 </div>
 `;
 
+exports[`should pass depth, index and ordered props to list/listItem 1`] = `
+<div>
+  <ul>
+    <li>
+      foo
+      <ol
+        start="2"
+      >
+        <li>
+          bar
+        </li>
+        <li>
+          baz
+        </li>
+      </ol>
+    </li>
+    <li>
+      root
+    </li>
+  </ul>
+</div>
+`;
+
 exports[`should pass on raw source position to non-tag renderers if rawSourcePos option is enabled 1`] = `
 Position {
   "end": Object {

test/__snapshots__/react-markdown.test.js.snap

@@ -205,6 +205,23 @@ test('should handle ordered lists with a start index', () => {
   expect(component.toJSON()).toMatchSnapshot()
 })
 
+test('should pass depth, index and ordered props to list/listItem', () => {
+  const input = '- foo\n  2. bar\n  3. baz\n- root\n'
+  const renderers = {
+    listItem: item => {
+      expect(item.index).toBeGreaterThanOrEqual(0)
+      expect(item.ordered).not.toBeUndefined()
+      return Markdown.renderers.listItem(item)
+    },
+    list: item => {
+      expect(item.depth).toBeGreaterThanOrEqual(0)
+      return Markdown.renderers.list(item)
+    }
+  }
+  const component = renderer.create(<Markdown source={input} renderers={renderers} />)
+  expect(component.toJSON()).toMatchSnapshot()
+})
+
 test('should handle inline html with escapeHtml option enabled', () => {
   const input = 'I am having <strong>so</strong> much fun'
   const component = renderer.create(<Markdown source={input} />)

test/react-markdown.test.js

@@ -4226,6 +4226,12 @@ md5.js@^1.3.4:
     hash-base "^3.0.0"
     inherits "^2.0.1"
 
+mdast-add-list-metadata@^1.0.0:
+  version "1.0.0"
+  resolved "https://registry.yarnpkg.com/mdast-add-list-metadata/-/mdast-add-list-metadata-1.0.0.tgz#14821c46e54cdea0017d10bf8a99e1cecbc1bfab"
+  dependencies:
+    unist-util-visit-parents "1.1.2"
+
 mem-fs-editor@^3.0.0:
   version "3.0.2"
   resolved "https://registry.yarnpkg.com/mem-fs-editor/-/mem-fs-editor-3.0.2.tgz#dd0a6eaf2bb8a6b37740067aa549eb530105af9f"
@@ -6400,6 +6406,10 @@ unist-util-stringify-position@^1.0.0, unist-util-stringify-position@^1.1.1:
   version "1.1.1"
   resolved "https://registry.yarnpkg.com/unist-util-stringify-position/-/unist-util-stringify-position-1.1.1.tgz#3ccbdc53679eed6ecf3777dd7f5e3229c1b6aa3c"
 
+[email protected]:
+  version "1.1.2"
+  resolved "https://registry.yarnpkg.com/unist-util-visit-parents/-/unist-util-visit-parents-1.1.2.tgz#f6e3afee8bdbf961c0e6f028ea3c0480028c3d06"
+
 unist-util-visit@^1.1.0:
   version "1.2.0"
   resolved "https://registry.yarnpkg.com/unist-util-visit/-/unist-util-visit-1.2.0.tgz#9dc78d1f95cd242e865f7f93f327d3296bb9a718"