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

Clean up for v1 #30

Merged
merged 1 commit into from
Oct 21, 2021
Merged

Clean up for v1 #30

merged 1 commit into from
Oct 21, 2021

Conversation

jhoffner
Copy link
Member

  • Removed CM support. Utilize highlight function with CM directly if you wish to use this
  • Removed lineNumbers support, this may be added in later if a universal way of handling it is found
  • Simplified extensions, loadScript support was removed, extensions need to load their own resources
  • Removed Mermaid support, this can be added later as an external extension
  • marked upgraded from 0.6.2 -> 2.1.1
  • Removed findLanguage option, now just assumes anything unknown is a language

@jhoffner jhoffner self-assigned this Oct 20, 2021
@jhoffner jhoffner requested a review from kazk October 20, 2021 22:58
package.json Show resolved Hide resolved
package.json Outdated
@@ -1,6 +1,6 @@
{
"name": "marked-extensions",
"version": "0.5.0",
"version": "1.0.0",
Copy link
Member

@kazk kazk Oct 21, 2021

Choose a reason for hiding this comment

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

Wasn't expecting v1. I think we have more to discuss, clean up, and should make sure this can be actually used. I can also set up automation, so we don't need to commit dist/.

Copy link
Member

@kazk kazk Oct 21, 2021

Choose a reason for hiding this comment

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

I'll open issues that I think we need to resolve before v1.

Edit: https://github.com/codewars/marked-extensions/milestone/1

Copy link
Member Author

Choose a reason for hiding this comment

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

Yeah I went for v1 because it was technically breaking changes. Since we are going full milestone on this, @ggorlen you might want to chime in with your notes.

Copy link
Member

Choose a reason for hiding this comment

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

Minor bumps before v1 are breaking changes, so we don't need to jump to v1 for semver.

Copy link
Member Author

Choose a reason for hiding this comment

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

Ah good to know. I think we can stick with v1. I like the milestone on this, let's get all of the major issues out of the way now so that we don't end up kicking the can down the road. @ggorlen can you help tackle some of the milestone tasks Kaz filed?

Copy link
Member

Choose a reason for hiding this comment

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

Going for v1 sounds good, but let's keep the version in this PR, so we can bump the version before actually releasing (possibly by automation).

Suggested change
"version": "1.0.0",
"version": "0.5.0",

Copy link
Collaborator

@ggorlen ggorlen Oct 21, 2021

Choose a reason for hiding this comment

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

@jhoffner My notes are pretty much updating headers to match whatever format the language generator's spitting out. LG headers have gotten more complex and language-specific because I'm using type annotations for Python and PHP, syntax like const and & in C++, supporting languages like Dart, Elixir, R and Rust, as well as minor changes like ArrayList instead of List or T[] in Java and changing casing in Go. I can apply these changes to ME but I'm not sure how invasive it'll be on the current design or if it's even necessary to show the types inline exactly as they appear in the code.

Copy link
Member

Choose a reason for hiding this comment

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

@ggorlen Can you open a new issue to discuss? I also have some inputs for the generator that I'll probably open later.

src/index.js Outdated Show resolved Hide resolved
src/index.js Show resolved Hide resolved
@kazk

This comment has been minimized.

@kazk kazk marked this pull request as draft October 21, 2021 18:54
@changeset-bot
Copy link

changeset-bot bot commented Oct 21, 2021

🦋 Changeset detected

Latest commit: 2b3ee26

The changes in this PR will be included in the next version bump.

This PR includes changesets to release 1 package
Name Type
@codewars/marked-extensions Major

Not sure what this means? Click here to learn what changesets are.

Click here if you're a maintainer who wants to add another changeset to this PR

@kazk kazk changed the title Version 1.0.0 Clean up for v1 Oct 21, 2021
- Removed CM support. Utilize `highlight` function with CM directly if you wish to use this
- Removed lineNumbers support, this may be added in later if a universal way of handling it is found
- Simplified extensions, loadScript support was removed, extensions need to load their own resources
- Removed Mermaid support, this can be added later as an external extension
- Upgraded `marked` from 0.6.2 to 2.1.1 and added to peer dependencies
- Removed `findLanguage` option, now just assumes anything unknown is a language
@kazk kazk marked this pull request as ready for review October 21, 2021 20:51
@kazk kazk merged commit b69333f into master Oct 21, 2021
@kazk kazk deleted the v1 branch October 21, 2021 20:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants