reactioncommerce / reaction-cli

A command line tool for working with Reaction Commerce.
33 stars 20 forks source link

Document styles, plugins #47

Closed machikoyasuda closed 7 years ago

machikoyasuda commented 7 years ago

Add styles, plugins to readme.

jshimko commented 7 years ago

These are all internal functionality that I'm not sure we want people to be using (which is why they're not in the readme). For example, the config command would allow you to overwrite configs that Launchdock currently depends on. I originally only exposed these so they could be used in automation setups and I can see plenty of scenarios where people may want to use these for their own automation, but I don't think these API's are ready/stable enough to start recommending yet. The only reason you see them when you run reaction --help is because the arg parser library I used automatically assembles the help output and you can't customize it.

machikoyasuda commented 7 years ago

What about styles and plugins? I can take out config.

jshimko commented 7 years ago

They both automatically run every time you run reaction or reaction run. I guess we can add them, but I suspect it'll raise more questions than anything else. Nobody ever needs to manually run those commands unless they're doing something fairly advanced. I guess it doesn't hurt though. You certainly can't break anything with those commands.

machikoyasuda commented 7 years ago

I'm going to be documenting reaction plugin commands in the updated plugin tutorial, example: https://github.com/machikoyasuda/reaction-sticky-footer-plugin#make-this-plugin-yourself

aaronjudd commented 7 years ago

I'm with @jshimko those are private internal methods and should probably not be published/documented right now as they are likely to deprecate or change. I'd be careful with the specifics of plugin loading process, as we're going to be greatly overhauling those very soon, in a way that should be transparent (but not if we expose too much ;-) ).