Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add JSDoc based types #566

Merged
merged 4 commits into from
Apr 14, 2021
Merged

Add JSDoc based types #566

merged 4 commits into from
Apr 14, 2021

Commits on Apr 12, 2021

  1. Replace renderers with components 

    * Replace `renderers` w/ `components`
* Replace `allowNode` w/ `allowElement`, which is now given a hast
  element (as the first parameter)
* Replace `allowedTypes` w/ `allowedElements`
* Replace `disallowedTypes` w/ `disallowedElements`
* Change signature of `linkTarget` and `transformLinkUri`, which are now
  given hast children (as the second parameter)
* Change signature of `transformImageUri`, which is now given the `alt`
  string as the second parameter (instead of the fourth)
* Replace `plugins` w/ `remarkPlugins` (backwards compatible change)
* Add `rehypePlugins`
* Change `includeNodeIndex` to `includeElementIndex`: it still sets an
  `index`, but that value now represents the number of preceding elements,
  it also sets a `siblingCount` (instead of `parentChildCount`) with
  the number of sibling elements in the parent
* The `columnAlignment` prop is no longer given to table elements:
  it’s available as `style` on `th` and `td` elements instead
* The `spread` prop is no longer given to list elements: it’s already
  handled
    @wooorm
    wooorm committed Apr 12, 2021
    Configuration menu
    Copy the full SHA
    ff3651a View commit details
    Browse the repository at this point in the history

  2. Remove buggy HTML parsers from core 

    * If you want HTML, add [`rehype-raw`](https://github.com/rehypejs/rehype-raw)
  to `rehypePlugins` and it’ll work without bugs!
* Remove `allowDangerousHtml` (previously called `escapeHtml`) option:
  pass `rehype-raw` to allow HTML instead
* Remove `with-html.js`, `plugins/html-parser.js` entries from library
* Remove naïve HTML parser too:
  either use `rehype-raw` to properly support HTML, or don’t allow it at all
    @wooorm
    wooorm committed Apr 12, 2021
    Configuration menu
    Copy the full SHA
    9d9b13a View commit details
    Browse the repository at this point in the history

  3. Update docs, tests

    @wooorm
    wooorm committed Apr 12, 2021
    Configuration menu
    Copy the full SHA
    a1711d2 View commit details
    Browse the repository at this point in the history

  4. Add JSDoc based types

    @wooorm
    wooorm committed Apr 12, 2021
    Configuration menu
    Copy the full SHA
    3b6651d View commit details
    Browse the repository at this point in the history