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

Rename project from mdast to remark 🎉 #113

Closed
wooorm opened this issue Dec 15, 2015 · 9 comments
Closed

Rename project from mdast to remark 🎉 #113

wooorm opened this issue Dec 15, 2015 · 9 comments
Assignees
Labels
🦋 type/enhancement This is great to have
Milestone

Comments

@wooorm
Copy link
Member

wooorm commented Dec 15, 2015

I just received push-access to the remark project on npm (by the amazing @phated!), which means, the mdast project can step away from the hard-to-pronaunce name towards a much more easily pronounceable remark.

I long coveted this name (in lieu of retext), ever since I forked into mdast more than a year ago.

Just in time for 3.0.0, but it will mean everything needs to be renamed, from mdastrc and mdastignore files, to all prefixed plug-ins.

This will also give me the opportunity to separate the AST specification from the API and CLI: mdast, similarly to NLCST for retext, will still be used as a definition for the nodes used by mdast, uhm, I mean, remark.

@wooorm wooorm self-assigned this Dec 15, 2015
@wooorm wooorm added this to the 3.0.0 milestone Dec 15, 2015
@wooorm
Copy link
Member Author

wooorm commented Dec 15, 2015

@why-jay
Copy link

why-jay commented Dec 15, 2015

Congrats! Nice name.

@ben-eb
Copy link
Contributor

ben-eb commented Dec 15, 2015

Nice! What do you suggest for plugin renaming?

@wooorm
Copy link
Member Author

wooorm commented Dec 15, 2015

Thanks @chcokr, @ben-eb.

  • I suggest upping a new major release, released with the new name. In the case of mdast-midas@1.1.0, that would go to remark-midas@2.0.0.
  • Then, create a near-empty project with a README pointing to to remark-midas and a deprecation notice, and publish it at mdast-midas@2.0.0 (yes, a major bump too).
  • Use npm deprecate mdast-midas@2.0.0 'Renamed to remark-midas without API changes'

That would ensure no users get any deprecation notices normally, but if they are in the process of updating their dependencies, they’ll get one and hopefully rename their dependency. 😄

I know it’s quite a lot to ask, hope you all don’t mind. Furthermore, I hope the new naming will make the ecosystem better! 🎉

@eush77
Copy link
Contributor

eush77 commented Dec 15, 2015

This will also give me the opportunity to separate the AST specification from the API and CLI: mdast, similarly to NLCST for retext, will still be used as a definition for the nodes used by mdast

Does it mean that the preferred name prefix for util packages will be changed to just mdast- after rename? And for example mdast-util-to-string will be renamed to mdast-to-string to be more in line with nlcst-to-string? I guess that could result in some confusion during the transition period.

@denysdovhan
Copy link

My congratulations! Cool name!

BTW: If you know there is also a remark slideshow tool 😏

@dthree
Copy link

dthree commented Dec 15, 2015

👍

@wooorm
Copy link
Member Author

wooorm commented Dec 15, 2015

@dthree @denysdovhan Yes, thanks! Cool right? And yeah, I saw the project. Luckily I got the access to npm 👍

@eush77 Yes, that’s the gist of it (see my previous comments for more info). I definitely share your concerns, but I feel that the long run will certainly be worth it. And, importantly, better now than later 👌

@rhysd
Copy link

rhysd commented Dec 16, 2015

Congrats! I got it.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
🦋 type/enhancement This is great to have
Development

No branches or pull requests

7 participants