feat: merge beta #947

kellyjosephprice · 2024-08-05T22:43:13Z

🧰 Changes

Merges beta into next!

🧬 QA & Testing

BREAKING CHANGE: This is a near complete rewrite of the library, and converts it to supporting MDX instead of markdown.

Co-authored-by: Jon Ursenbach <[email protected]>

feat: initial commit

Commits the dist directory, as well as emits types!

fix: dont raise

chore: mdx v1 build

| [![PR App][icn]][demo] | RM-9793 | | :--------------------: | :-----: | ## 🧰 Changes Changes how tables are saved as JSX. The align attribute is stored on the `Table` component, as well as the table cells: ``` <Table align={["center", "center"]}> <thead> <tr> <th style={{ textAlign: 'center' }}>Hi!</th> <th style={{ textAlign: 'center' }}>Hello!</th> </tr> </thead> <tbody> <tr> <td style={{ textAlign: 'center' }}>Bye!</td> <td style={{ textAlign: 'center' }}>Bye Bye!</td> </tr> </tbody> </Table> ``` It also includes some cleanup of code that's not being used, namely `html`, `esast`, and `hastFromHtml`. `hastFromHtml` was going to be used for search indexing, but I think we're going to switch to much simpler parsing of just the `hast`. ## 🧬 QA & Testing - [Broken on production][prod]. - [Working in this PR app][demo]. [demo]: https://markdown-pr-PR_NUMBER.herokuapp.com [prod]: https://SUBDOMAIN.readme.io [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg

## Version 6.75.0-beta.73 ### 🛠 Fixes & Updates * tables ([#938](#938)) ([1cbb175](1cbb175))

## Version 6.75.0-beta.74 ### 🛠 Fixes & Updates * use td ([47650a4](47650a4))

| [![PR App][icn]][demo] | RM-9793 | | :--------------------: | :-----: | ## 🧰 Changes Skips the align attrs if they're all null. I didn't realize markdown tables default to null, rather than a string: ``` | foo | | --- | ``` ## 🧬 QA & Testing - [Broken on production][prod]. - [Working in this PR app][demo]. [demo]: https://markdown-pr-PR_NUMBER.herokuapp.com [prod]: https://SUBDOMAIN.readme.io [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg

## Version 6.75.0-beta.75 ### 🛠 Fixes & Updates * skip null align ([#940](#940)) ([7880a89](7880a89))

| [![PR App][icn]][demo] | RM-9793 | | :--------------------: | :-----: | ## 🧰 Changes Fixes saving 'complex' tables. In a prior PR, I added a new node type `tableau` to represent tables with block content. This mostly worked for the editor, but not when doing `mdx(mdast(doc))`. This PR adds a transformer, so the a `tableau` is converted to a JSX table just like regular `table`'s. This also adds the check so, if a `tableau` no longer has block content, it's saved as markdown! ## 🧬 QA & Testing Hard to test outside the main app. - [Broken on production][prod]. - [Working in this PR app][demo]. [demo]: https://markdown-pr-PR_NUMBER.herokuapp.com [prod]: https://SUBDOMAIN.readme.io [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg

## Version 6.75.0-beta.76 ### 🛠 Fixes & Updates * saving tables ([#942](#942)) ([50c392e](50c392e))

| [![PR App][icn]][demo] | RM-9793 | | :--------------------: | :--------: | ## 🧰 Changes Fixes saving lists (other blocks too) in table headers. ## 🧬 QA & Testing Kind of hard to test outside the editor. But I've been testing by running `make mdx` and playing around in the styleguidist playground thingy. - [Broken on production][prod]. - [Working in this PR app][demo]. [demo]: https://markdown-pr-PR_NUMBER.herokuapp.com [prod]: https://SUBDOMAIN.readme.io [icn]: https://user-images.githubusercontent.com/886627/160426047-1bee9488-305a-4145-bb2b-09d8b757d38a.svg

## Version 6.75.0-beta.77 ### 🛠 Fixes & Updates * lists in table headers ([#943](#943)) ([6a2e80f](6a2e80f))

components/HTMLBlock/index.tsx

+import React, { useEffect } from 'react';
+import { renderToStaticMarkup } from 'react-dom/server';
+
+const MATCH_SCRIPT_TAGS = /<script\b[^>]*>([\s\S]*?)<\/script *>\n?/gim;


components/HTMLBlock/index.tsx

+  while ((match = MATCH_SCRIPT_TAGS.exec(html)) !== null) {
+    scripts.push(match[1]);
+  }
+  const cleaned = html.replace(MATCH_SCRIPT_TAGS, '');


.github/workflows/ci.yml

.gitignore

Makefile

erunion · 2024-08-08T19:17:51Z

package.json

    "@babel/plugin-proposal-class-properties": "^7.18.6",
-    "@babel/plugin-proposal-object-rest-spread": "^7.19.4",
-    "@babel/plugin-proposal-optional-chaining": "^7.18.9",
-    "@babel/plugin-transform-runtime": "^7.24.0",
-    "@babel/preset-env": "^7.24.0",
-    "@babel/preset-react": "^7.23.3",
-    "@commitlint/cli": "^19.0.3",
-    "@commitlint/config-conventional": "^19.0.3",
-    "@readme/eslint-config": "^13.5.0",
-    "@readme/stylelint-config": "^6.1.0",
+    "@babel/plugin-proposal-export-default-from": "^7.23.3",
+    "@babel/plugin-proposal-object-rest-spread": "^7.20.7",
+    "@babel/plugin-proposal-optional-chaining": "^7.21.0",
+    "@babel/plugin-proposal-private-methods": "^7.18.6",
+    "@babel/plugin-transform-runtime": "^7.21.4",


doesn't need to happen here but im curious which of these plugins are still needed

erunion · 2024-08-08T19:18:54Z

package.json

@@ -2,113 +2,132 @@
  "name": "@readme/markdown",
  "description": "ReadMe's React-based Markdown parser",
  "author": "Rafe Goldberg <[email protected]>",
-  "version": "6.87.1",
+  "version": "6.75.0-beta.77",


not sure how the package publishing stuff works here but should all of this qualify for a major v7 release since i assume it's all a pretty big breaking change?

Yes definitely, forgot to do that.

Ok, updated the commit body with BREAKING CHANGE:, hopefully that changes the major number 🤞🏼

erunion · 2024-08-08T19:20:00Z

package.json

+    "@commitlint/config-angular": "^17.4.4",
+    "@commitlint/config-conventional": "^17.4.4",
+    "@readme/eslint-config": "^14.0.0",
+    "@readme/markdown-legacy": "npm:@readme/markdown@^6.84.0",


without doing a v7 release this legacy package import is likely going to start importing the all of this new work

Once the migration is done, I can probably delete that.

erunion

LGTM

## Version 6.88.0 ### ⚠ BREAKING CHANGES * CHANGE: This is a near complete rewrite of the library, and converts it to supporting MDX instead of markdown. ### ✨ New & Improved * merge beta ([#947](#947)) ([b9502ad](b9502ad))

rafegoldberg · 2024-08-08T21:05:50Z

This PR was released!

🚀 Changes included in v6.88.0

rafegoldberg · 2024-08-28T14:49:57Z

(ooof, squash merging this caused us to loose all the linked PR-to-commit history from the last years worth of work on the beta branch… makes it real hard to track where/why certain changes were introduced.)

kellyjosephprice · 2024-08-28T16:12:11Z

(ooof, squash merging this caused us to loose all the linked PR-to-commit history from the last years worth of work on the beta branch… makes it real hard to track where/why certain changes were introduced.)

Yea, a lot of the commits were poor quality though.

kellyjosephprice and others added 30 commits April 4, 2023 11:32

feat: initial commit

201162a

build: wip

5cef967

docs: tweaks

6a4d831

build: npm run prepare\?

5e6c949

feat: compile + run

aa95a65

build: output types

5af1110

build: package updates

7f384ea

build: add back core-js

c1269d8

Update .eslintrc

0910b42

Co-authored-by: Jon Ursenbach <[email protected]>

ci: remove release + deploy actions

a98bd62

Merge pull request #1 from readmeio/feat/mdx

432a04e

feat: initial commit

build: dont build

e1cd2d1

build: emit types

0908196

build: wat

04212cc

Merge pull request #3 from readmeio/building

b022dc9

Commits the dist directory, as well as emits types!

fix: dont raise

c4e8a51

Merge pull request #4 from readmeio/fix/dont-raise

79d1809

fix: dont raise

feat: mdx v1

3250aff

chore: more deps + config

b6cd0f1

chore: fix some build stuff

7147bad

fix: types error

518f698

chore: reactProcessor

a74109c

chore: ??

2e86b60

renders!

8e0c57c

callouts!

2fc53f4

chore: cleanup

ca4a841

Merge pull request #9 from readmeio/feat/mdx-v1-build

b15f02d

chore: mdx v1 build

fix: errors

b6ed87e

fix: more errors

2518d47

chore: cleanup

5bef7c4

kellyjosephprice and others added 11 commits July 11, 2024 20:48

build(release): 🚀 v6.75.0-beta.73 🦉

617c05a

## Version 6.75.0-beta.73 ### 🛠 Fixes & Updates * tables ([#938](#938)) ([1cbb175](1cbb175))

fix: use td

47650a4

build(release): 🚀 v6.75.0-beta.74 🦉

047a1c4

## Version 6.75.0-beta.74 ### 🛠 Fixes & Updates * use td ([47650a4](47650a4))

build(release): 🚀 v6.75.0-beta.75 🦉

3806119

## Version 6.75.0-beta.75 ### 🛠 Fixes & Updates * skip null align ([#940](#940)) ([7880a89](7880a89))

build(release): 🚀 v6.75.0-beta.76 🦉

1b86106

## Version 6.75.0-beta.76 ### 🛠 Fixes & Updates * saving tables ([#942](#942)) ([50c392e](50c392e))

build(release): 🚀 v6.75.0-beta.77 🦉

8ee0ca1

## Version 6.75.0-beta.77 ### 🛠 Fixes & Updates * lists in table headers ([#943](#943)) ([6a2e80f](6a2e80f))

Merge branch 'beta' into feat/merge-beta

73456a4

github-advanced-security bot found potential problems Aug 5, 2024

View reviewed changes

kellyjosephprice added 3 commits August 5, 2024 16:07

cleanup

0b2d2c0

test: snaps

b969729

tests: skip

d753d3d

kellyjosephprice marked this pull request as ready for review August 6, 2024 21:45

kellyjosephprice requested review from erunion, domharrington and rafegoldberg August 8, 2024 19:08

erunion reviewed Aug 8, 2024

View reviewed changes

kellyjosephprice added 2 commits August 8, 2024 12:37

ci: try latest node

e696ff0

chore: cleanup workaround

dc5b852

erunion approved these changes Aug 8, 2024

View reviewed changes

kellyjosephprice merged commit b9502ad into next Aug 8, 2024
12 of 13 checks passed

kellyjosephprice deleted the feat/merge-beta branch August 8, 2024 20:39

rafegoldberg added the released label Aug 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

feat: merge beta #947

feat: merge beta #947

kellyjosephprice commented Aug 5, 2024 •

edited

Loading

erunion Aug 8, 2024

erunion Aug 8, 2024

kellyjosephprice Aug 8, 2024

kellyjosephprice Aug 8, 2024

erunion Aug 8, 2024

kellyjosephprice Aug 8, 2024

erunion left a comment •

edited

Loading

rafegoldberg commented Aug 8, 2024

rafegoldberg commented Aug 28, 2024

kellyjosephprice commented Aug 28, 2024

feat: merge beta #947

feat: merge beta #947

Conversation

kellyjosephprice commented Aug 5, 2024 • edited Loading

🧰 Changes

🧬 QA & Testing

erunion Aug 8, 2024

Choose a reason for hiding this comment

erunion Aug 8, 2024

Choose a reason for hiding this comment

kellyjosephprice Aug 8, 2024

Choose a reason for hiding this comment

kellyjosephprice Aug 8, 2024

Choose a reason for hiding this comment

erunion Aug 8, 2024

Choose a reason for hiding this comment

kellyjosephprice Aug 8, 2024

Choose a reason for hiding this comment

erunion left a comment • edited Loading

Choose a reason for hiding this comment

rafegoldberg commented Aug 8, 2024

This PR was released!

rafegoldberg commented Aug 28, 2024

kellyjosephprice commented Aug 28, 2024

kellyjosephprice commented Aug 5, 2024 •

edited

Loading

erunion left a comment •

edited

Loading