fix: Convert to ESM #2227

benmccann · 2021-10-07T03:06:57Z

Marked version: master

Markdown flavor: all

Description

Converts the source code to ESM to be more modern and allow Rollup to better handle it. Rollup will still convert the final code to be UMD / ESM, but will do so more efficiently resulting in smaller output files

Contributor

Test(s) exist to ensure functionality and minimize regression (if no tests added, list tests covering this PR); or,
no tests required for this PR.
If submitting new feature, it has been documented in the appropriate places.

Committer

In most cases, this should be a different person than the contributor.

CI is green (no forced merge required).
Squash and Merge PR following conventional commit guidelines.

vercel · 2021-10-07T03:07:02Z

This pull request is being automatically deployed with Vercel (learn more).
To see the status of your deployment, click below or on the icon next to each commit.

🔍 Inspect: https://vercel.com/markedjs/markedjs/4GVhinkD5B8e9yGBnM2czZnEa748
✅ Preview: https://markedjs-git-fork-benmccann-esm-named-only-markedjs.vercel.app

test/helpers/helpers.js

test/unit/marked-spec.js

UziTech · 2021-10-08T00:50:08Z

We could probably remove lib/marked.esm.js with this update. Or make it just a file that exports src/marked.js

benmccann · 2021-10-08T04:43:42Z

Ok, I've added "type": "module" and converted all the tests to ESM as well

We could probably remove lib/marked.esm.js with this update. Or make it just a file that exports src/marked.js

We could, but I actually think it might be preferable to keep as is so that we know the UMD and ESM versions have the same exposed APIs. I think it could be easier to document and explain that way.

lib/marked.js

benmccann · 2021-10-20T17:25:20Z

@UziTech I was wondering if you had any other thoughts about this? Is it something we could move forward with in the near future to avoid merge conflicts from accruing?

UziTech · 2021-10-20T19:35:16Z

Looks like vercel is failing because npm run build:docs is failing. That will need to be fixed before this is merged.

benmccann · 2021-10-20T20:12:10Z

Ok, thanks for letting me know. I didn't have permission to see the Vercel link, so didn't know what was wrong. I've updated it so that it's working now

UziTech · 2021-10-22T23:44:39Z

I'll take a look at this soon and make sure all the ways of importing marked works or see where we would have to update our docs.

UziTech · 2021-10-24T03:34:42Z

Can you fix the npm run bench command? it seems to have some issues with ESM.

calculuschild

Seems fine except for a bunch of random whitespace being be added between words in the documentation.

I really don't have experience in this side of JavaScript with module packaging and stuff though, so I don't know how useful my review is.

man/marked.1.txt

benmccann · 2021-10-31T17:13:42Z

I think that might have been from @UziTech 's changes. I'm not sure if perhaps that file is autogenerated from something, but I just manually updated it

UziTech · 2021-10-31T19:11:45Z

That is auto generated but we can edit it manually.

marked/Makefile

Lines 12 to 13 in e93f800

    
           man/marked.1.txt: 
        
           	groff -man -Tascii man/marked.1 | col -b > man/marked.1.txt

benmccann · 2021-11-01T15:47:14Z

Cool. Do we need to wait for @davisjam, @joshbruce and @styfle to weigh in before merging?

UziTech · 2021-11-01T15:58:39Z

I was just giving a little bit of time for anyone to weigh in. I'll merge this later today if there is no issues.

# [4.0.0](v3.0.8...v4.0.0) (2021-11-02) ### Bug Fixes * Convert to ESM ([#2227](#2227)) ([4afb228](4afb228)) ### BREAKING CHANGES * - Default export removed. Use `import { marked } from 'marked'` or `const { marked } = require('marked')` instead. - `/lib/marked.js` removed. Use `/marked.min.js` in script tag instead. - When using marked in a script tag use `marked.parse(...)` instead of `marked(...)`

github-actions · 2021-11-02T14:43:07Z

🎉 This PR is included in version 4.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

markedjs/marked#2227

jimmywarting · 2022-03-26T21:13:36Z

Ty 4 this!

vercel bot had a problem deploying to Preview October 7, 2021 03:07 Failure

benmccann force-pushed the esm-named-only branch from 624246e to 82ad1c6 Compare October 7, 2021 13:15

vercel bot had a problem deploying to Preview October 7, 2021 13:15 Failure

vercel bot had a problem deploying to Preview October 7, 2021 13:42 Failure

UziTech reviewed Oct 7, 2021

View reviewed changes

test/helpers/helpers.js Outdated Show resolved Hide resolved

UziTech reviewed Oct 7, 2021

View reviewed changes

test/unit/marked-spec.js Outdated Show resolved Hide resolved

UziTech mentioned this pull request Oct 8, 2021

Add an exports map to package.json. #2231

Closed

5 tasks

vercel bot had a problem deploying to Preview October 8, 2021 02:55 Failure

vercel bot had a problem deploying to Preview October 8, 2021 03:34 Failure

vercel bot had a problem deploying to Preview October 8, 2021 03:36 Failure

benmccann changed the title ~~Convert source to ESM~~ Convert to ESM Oct 8, 2021

benmccann force-pushed the esm-named-only branch from ac583ce to 1435b2c Compare October 8, 2021 03:41

vercel bot had a problem deploying to Preview October 8, 2021 03:41 Failure

vercel bot had a problem deploying to Preview October 8, 2021 04:00 Failure

vercel bot had a problem deploying to Preview October 8, 2021 04:16 Failure

vercel bot had a problem deploying to Preview October 8, 2021 04:36 Failure

UziTech reviewed Oct 8, 2021

View reviewed changes

lib/marked.js Show resolved Hide resolved

vercel bot had a problem deploying to Preview October 8, 2021 15:16 Failure

benmccann mentioned this pull request Oct 9, 2021

SvelteKit compatibility sveltejs/svelte-repl#181

Merged

vercel bot deployed to Preview October 20, 2021 20:05 View deployment

benmccann force-pushed the esm-named-only branch from 7ae77a6 to de27d69 Compare October 20, 2021 20:08

vercel bot deployed to Preview October 20, 2021 20:08 View deployment

calculuschild approved these changes Oct 31, 2021

View reviewed changes

man/marked.1.txt Outdated Show resolved Hide resolved

man/marked.1.txt Outdated Show resolved Hide resolved

vercel bot deployed to Preview October 31, 2021 17:11 View deployment

benmccann and others added 11 commits November 1, 2021 08:33

Convert source to ESM

6569d4d

make suggested changes

11faa4b

use require to make loading spec synchronous

152c014

remove default exports

c2e5449

fix bench

21d9ad0

fix demo

9ba8780

fix marked binary

fe59550

lint

88c2233

update docs

7e77752

update man

24c7513

remove extraneous whitespace

b1d8416

benmccann force-pushed the esm-named-only branch from df8e644 to b1d8416 Compare November 1, 2021 15:33

vercel bot deployed to Preview November 1, 2021 15:33 View deployment

UziTech changed the title ~~Convert to ESM~~ fix: Convert to ESM Nov 2, 2021

UziTech merged commit 4afb228 into markedjs:master Nov 2, 2021

github-actions bot added the released label Nov 2, 2021

This was referenced Nov 10, 2021

documentation to show ESM import and usage #1692

Closed

fix: Set commonJS code as main in package.json #2276

Merged

XuluWarrior added a commit to XuluWarrior/jsonresume-theme-kards that referenced this pull request Dec 3, 2021

marked v4 has moved to ESM

9d31cf3

markedjs/marked#2227

XuluWarrior added a commit to XuluWarrior/jsonresume-theme-orbit-original that referenced this pull request Dec 3, 2021

marked v4 has moved to ESM

ab3e817

markedjs/marked#2227

XuluWarrior added a commit to XuluWarrior/jsonresume-theme-orbit that referenced this pull request Jan 1, 2022

marked v4 has moved to ESM

4b48c93

markedjs/marked#2227

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

fix: Convert to ESM #2227

fix: Convert to ESM #2227

benmccann commented Oct 7, 2021 •

edited

vercel bot commented Oct 7, 2021 •

edited

UziTech commented Oct 8, 2021

benmccann commented Oct 8, 2021

benmccann commented Oct 20, 2021

UziTech commented Oct 20, 2021

benmccann commented Oct 20, 2021

UziTech commented Oct 22, 2021

UziTech commented Oct 24, 2021

calculuschild left a comment

benmccann commented Oct 31, 2021

UziTech commented Oct 31, 2021

benmccann commented Nov 1, 2021

UziTech commented Nov 1, 2021

github-actions bot commented Nov 2, 2021

jimmywarting commented Mar 26, 2022

fix: Convert to ESM #2227

fix: Convert to ESM #2227

Conversation

benmccann commented Oct 7, 2021 • edited

Description

Contributor

Committer

vercel bot commented Oct 7, 2021 • edited

UziTech commented Oct 8, 2021

benmccann commented Oct 8, 2021

benmccann commented Oct 20, 2021

UziTech commented Oct 20, 2021

benmccann commented Oct 20, 2021

UziTech commented Oct 22, 2021

UziTech commented Oct 24, 2021

calculuschild left a comment

Choose a reason for hiding this comment

benmccann commented Oct 31, 2021

UziTech commented Oct 31, 2021

benmccann commented Nov 1, 2021

UziTech commented Nov 1, 2021

github-actions bot commented Nov 2, 2021

jimmywarting commented Mar 26, 2022

benmccann commented Oct 7, 2021 •

edited

vercel bot commented Oct 7, 2021 •

edited