Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Add a type property to the def tokenizer's return object #2001

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
Merged
UziTech merged 1 commit into from
Apr 10, 2021
Merged

Add a type property to the def tokenizer's return object #2001

UziTech merged 1 commit into from
Apr 10, 2021

Conversation

@sapristi
Copy link
Contributor

@sapristi sapristi commented Apr 9, 2021

Related to #2000

Marked version:

2.0.1

Markdown flavor: all

Description

Expectation

Markdown nodes all have a type property to ease working with the markdown tree.

Result

def nodes do not have a type property.

What was attempted

Using walkTokens in typescript, I have the need to discriminate between nodes; the https://www.npmjs.com/package/@types/marked package doesn't define a type member for the Def interface, seemingly because there is not one here either.

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.

@vercel
Copy link

vercel bot commented Apr 9, 2021 •
edited
Loading

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/4w5nnEqsuVHCgKGHPEwGncfHwnVd
✅ Preview: https://markedjs-git-fork-sapristi-patch-1-markedjs.vercel.app

@UziTech
Copy link
Member

UziTech commented Apr 9, 2021

@styfle @calculuschild would this be a breaking change?

@UziTech UziTech requested review from calculuschild and styfle April 9, 2021 06:49
UziTech
UziTech approved these changes Apr 9, 2021
View reviewed changes
Copy link
Member

@UziTech UziTech left a comment

Choose a reason for hiding this comment

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

LGTM

@calculuschild
Copy link
Contributor

calculuschild commented Apr 9, 2021

I don't see anything that would be breaking. I think adding information is usually ok; only if someone is depending on no type to detect def tokens but I doubt that is a common occurrence. LGTM.

styfle
styfle approved these changes Apr 10, 2021
View reviewed changes
Copy link
Member

@styfle styfle left a comment

Choose a reason for hiding this comment

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

Looks good 👍

Agreed, I don't think adding a new prop is considered breaking

@UziTech UziTech merged commit 009427f into markedjs:master Apr 10, 2021
github-actions bot pushed a commit that referenced this pull request Apr 10, 2021
@semantic-release-bot
chore(release): 2.0.2 [skip ci]
856c4ad 
## [2.0.2](v2.0.1...v2.0.2) (2021-04-10)

### Bug Fixes

* add type property on def token ([#2001](#2001)) ([009427f](009427f))
@github-actions
Copy link

github-actions bot commented Apr 10, 2021

🎉 This PR is included in version 2.0.2 🎉

The release is available on:

Your semantic-release bot 📦🚀

@sapristi sapristi deleted the patch-1 branch April 10, 2021 21:14
@sapristi
Copy link
Contributor Author

sapristi commented Apr 10, 2021

Thanks !

@sapristi sapristi mentioned this pull request Apr 10, 2021
Merged
5 tasks
UziTech pushed a commit that referenced this pull request Apr 11, 2021
fix: actually add a type property to the def token (#2002)
47e65cf 
Hmm I think I modified the wrong file (`lib/marked.js`) in the previous PR (see #2001) , this should be the right one ! Sorry for that.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@UziTech UziTech UziTech approved these changes

@styfle styfle styfle approved these changes

@calculuschild calculuschild calculuschild approved these changes

Assignees

No one assigned

Labels

released

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Set type member for all nodes

4 participants

@sapristi @UziTech @calculuschild @styfle