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

plugins: rename plugins to "assemble-middleware-*"? #504

Closed
11 of 14 tasks
jonschlinkert opened this issue Apr 29, 2014 · 24 comments
Closed
11 of 14 tasks

plugins: rename plugins to "assemble-middleware-*"? #504

jonschlinkert opened this issue Apr 29, 2014 · 24 comments

Comments

@jonschlinkert
Copy link
Member

I propose that we rename all of the plugins to assemble-middleware-foo instead of contrib.

IMO, since v0.5.0 plugins aren't backwards compatible anyway, this shouldn't be an issue. npm will still have the contrib plugins for anyone who needs them. Also, GitHub automatically sets up redirects when repos are renamed (all URLs, including git endpoints).

Any thoughts? Am I missing something?


middleware that need to be renamed:

  • assemble-contrib-anchors
  • assemble-contrib-contextual
  • assemble-contrib-decompress
  • assemble-contrib-download
  • assemble-contrib-drafts
  • assemble-contrib-i18n
  • assemble-contrib-lunr
  • assemble-contrib-navigation
  • assemble-contrib-pagination
  • assemble-contrib-permalinks
  • assemble-contrib-rss
  • assemble-contrib-sitemap
  • assemble-contrib-toc
  • assemble-contrib-wordcount

For each, we'll need to:

  • change the repo name on github (github redirects URLs from the old name)
  • change the name in package.json
  • rebuild README with Verb
  • update the name in code banners in javascript files
  • publish to npm
  • push to github

Missing anything?

@jonschlinkert jonschlinkert added this to the v0.5.0 milestone Apr 29, 2014
@Melindrea
Copy link
Collaborator

I think that it would make it clearer. The grunt-contrib- isn't very confusing because they are all plugins, but assemble doesn't have that.

@jonschlinkert
Copy link
Member Author

very good points! thanks!

@jonschlinkert jonschlinkert modified the milestone: v0.5.0 Apr 29, 2014
@jonschlinkert jonschlinkert changed the title rename plugins to "assemble-plugin-*" plugins: rename plugins to "assemble-plugin-*"? Apr 29, 2014
@doowb
Copy link
Member

doowb commented Apr 29, 2014

I think these should be assemble-middleware-* instead because they fit the description of middleware better than a plugin.

@LaurentGoderre
Copy link

Can you explain this 'rebuil with verbs'?

@LaurentGoderre
Copy link

Perhaps the strategy for changing the plugins should be more explicit. For instance, all plugins in their instance should branch out the code to a branch called v4.x or something.

@Melindrea
Copy link
Collaborator

@doowb I like that, though will there be both be middleware and plugins? Because if so, the difference should be clarified somewhere.

@jonschlinkert
Copy link
Member Author

Can you explain this 'rebuil with verbs'?

@LaurentGoderre I updated the description above.

Perhaps the strategy for changing the plugins should be more explicit.

That's the plan! here are three related issues:

I'll be updating these with more info, over the next day or so. the goal is to have a complete strategy for updating plugins, helper and documentation in general

@doowb
Copy link
Member

doowb commented Apr 29, 2014

@Melindrea: I was just talking to @jonschlinkert and we're planning on middleware and plugins, but we'll probably push that off to the next version. I think we need to come up with a better definition between the differences and where they should be used.

@LaurentGoderre when I'm updating a plugin/helper of v0.5, I usually create a new branch named by the next minor version since this will be a breaking change. handlebars-helper-rel is a good example (even though it's a helper and not a plugin). This way, it can be tested by pointing directly to the repo without pushing it up to npm.

@jonschlinkert responded while I was typing... so his stuff too 😉

@jonschlinkert
Copy link
Member Author

so in a nutshell, no. we'll just do one. middleware seems correct to me as well.

@Melindrea
Copy link
Collaborator

👍 I like the term middleware.

@LaurentGoderre
Copy link

@doowb I feel that the opposite should be true. While master point to the latest, there should be a branch poiting to the "old" version.

@jonschlinkert
Copy link
Member Author

@LaurentGoderre not while the master is still the current version. there shouldn't be a branch for any version but the "next" one. tags serve that purpose. perhaps we should continue this on another issue though?

@LaurentGoderre
Copy link

Sorry about that....I thought that npm handle deprecation through the package.json since it doesn`t there probably is not need forr the backwards branch

@jonschlinkert
Copy link
Member Author

no prob @LaurentGoderre! I appreciate the precaution!

@jonschlinkert
Copy link
Member Author

is it going to be assemble-middleware-* then?

@Melindrea
Copy link
Collaborator

👍

@jonschlinkert jonschlinkert changed the title plugins: rename plugins to "assemble-plugin-*"? plugins: rename plugins to "assemble-middleware-*"? May 2, 2014
@LaurentGoderre
Copy link

Btw, as we rename, do you deprecate the previous module on npm?

@jonschlinkert
Copy link
Member Author

no but it's not a bad idea.

@LaurentGoderre
Copy link

What is cool is that you can customize the message telling the users what the new package name is.

https://www.npmjs.org/doc/cli/npm-deprecate.html

@LaurentGoderre
Copy link

BTW, I can't rename the repo itself because I have push rights only but I can start the work if you rename it.

@doowb
Copy link
Member

doowb commented May 2, 2014

Actually, I was deprecating the old modules when I renamed them. I put a message saying that it was renamed to assemble-middleware-*. They can still be installed, but you just get a deprecation notice.

@LaurentGoderre
Copy link

Yeah that's perfect!

@jonschlinkert
Copy link
Member Author

👍

@jonschlinkert
Copy link
Member Author

closing based on age and since we've made a lot of changes since this was created

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants