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.

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

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

Conversation

wooorm
Copy link
Member

@wooorm wooorm commented Apr 11, 2021

PR depends on work on components branch (#563).

@wooorm wooorm added ☂️ area/types This affects typings 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have labels Apr 11, 2021
@codecov-io

This comment has been minimized.

Copy link
Member

@ChristianMurphy ChristianMurphy left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

this one sparks joy

src/ast-to-react.js Show resolved Hide resolved
package.json Show resolved Hide resolved
src/react-markdown.js Show resolved Hide resolved
src/rehype-filter.js Show resolved Hide resolved
Base automatically changed from components to main April 12, 2021 06:31
* 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
* 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
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
☂️ area/types This affects typings 🙉 open/needs-info This needs some more info 🦋 type/enhancement This is great to have
Development

Successfully merging this pull request may close these issues.

None yet

3 participants