Fix duplicate heading id

[styfle]

Marked version: 0.5.2

Markdown flavor: All

Description

This fixes several bugs involving headerIds: true.

• Fixes Hash links with "&" are not converted the same way as github links #857
• Fixes Duplicate Heading IDs #1280
• Fixes Add slugger option, remove headerIds / headerPrefix #1354
• Fixes Fix Heading ID for Unicode text #1374

This adds a new export marked.Slugger.

I added several more tests to cover duplicates as well as ampersands.

Contributor

• Test(s) exist to ensure functionality and minimize regression

Committer

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

• Draft GitHub release notes have been updated.
• CI is green (no forced merge required).
• Merge PR

[UziTech]

we also need to test for Flet/github-slugger#20

    expect(slugger.slug('test 1')).toBe('test-1');
    expect(slugger.slug('test')).toBe('test');
    expect(slugger.slug('test')).toBe('test-2');

and

  expect(slugger.slug('foo'), 'foo')
  expect(slugger.slug('foo'), 'foo-1')
  expect(slugger.slug('foo 1'), 'foo-1-1')
  expect(slugger.slug('foo-1'), 'foo-1-2')
  expect(slugger.slug('foo'), 'foo-2')

[styfle]

That's an interesting problem you found. I fixed this PR, thanks 👍

[UziTech]

Looks great 👍

[styfle]

@davisjam @joshbruce After this PR lands, I can do a new release. Can you take a look?

[joshbruce]

Just to make sure I'm up to speed on the header conversation and whatnot. We're adding slugger to fix a defect, which is header duplication. We are still experiencing issues with unicode characters like Japanese and other glyph languages. And we are still progressing toward dropping header ID generation in the future. Yeah?

[styfle]

@joshbruce This PR fixes non-latin char headings as well as duplicate IDs.

In the future we could drop support and rely on github-slugger. That PR #1354 (which was removing slugger from marked) was rejected. So I made this PR.

[tmorehouse]

@styfle @joshbruce @UziTech

We're receiving errors for this latest update (^0.5.2 -> ^0.6.0):

8:57:27 PM: WARNING in ./src/components/table/README.md
8:57:27 PM: Module build failed (from ./node_modules/markdown-loader/index.js):
8:57:27 PM: TypeError: Cannot read property 'slug' of undefined
8:57:27 PM: Please report this to https://github.com/markedjs/marked.
8:57:27 PM:     at Renderer.heading (/opt/build/repo/node_modules/marked/lib/marked.js:962:17)
8:57:27 PM:     at Parser.tok (/opt/build/repo/node_modules/markdown-loader/node_modules/marked/lib/marked.js:1179:28)
8:57:27 PM:     at Parser.parse (/opt/build/repo/node_modules/markdown-loader/node_modules/marked/lib/marked.js:1130:17)
8:57:27 PM:     at Function.Parser.parse (/opt/build/repo/node_modules/markdown-loader/node_modules/marked/lib/marked.js:1112:17)
8:57:27 PM:     at marked (/opt/build/repo/node_modules/markdown-loader/node_modules/marked/lib/marked.js:1543:19)
8:57:27 PM:     at Object.module.exports (/opt/build/repo/node_modules/markdown-loader/index.js:14:12)

[styfle]

Are you overwriting the renderer methods?
See the release notes for breaking changes.

https://github.com/markedjs/marked/releases/tag/v0.6.0

If so, try passing new Slugger()
If not, please file a new issue with steps to reproduce.

Thanks!

[tmorehouse]

We are adding a wrapper on the table renderer so that must be it. Will try restoring the slugger handler.

[tmorehouse]

It appears that markdown-loader is using 0.5.x, which is causing our issue (as we are passing it a new renderer instance with code and table overrides), but our renderer is v0.6.0, which has a different calling signature (the slugger argument), compared to v0.5.x