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

Split CLI as separate module #14

Closed
zrrrzzt opened this issue Jul 2, 2015 · 7 comments
Closed

Split CLI as separate module #14

zrrrzzt opened this issue Jul 2, 2015 · 7 comments

Comments

@zrrrzzt
Copy link
Contributor

zrrrzzt commented Jul 2, 2015

I've always had one module containing both CLI and module. However, after reading this I think it would be better to keep them apart.

$ npm install wcag

Would install the module

$ npm install wcag-cli -g

would install the CLI (much as it is today)

It would still be possible to enable use of wcag as CLI handle

$ wcag <url> --key=<key>
@contolini
Copy link
Member

Considering I still haven't added the API to the readme, this makes sense to me. Couple questions:

  • Would this repo become the API or the CLI?
  • Should we remove node- from the repo name?

@zrrrzzt
Copy link
Contributor Author

zrrrzzt commented Jul 2, 2015

node- makes perfectly sense on GitHub but I would not use it on npm.
So my idea is something like node-wcag (this repo) as the module and node-wcag-cli (wcag-cli on npm) as the new repo.

We haven't discussed versioning. I'm a big fan of semver at the moment so a 1.0.0 release of this repo/module would indicate breaking API changes and what we should do when we separate the CLI.
The CLI will depend on the module so minutes later we might release the wcag-cli 1.0.0.

I'm not in a hurry so we could start the split after we have solved the pending issues here.

@contolini
Copy link
Member

👍 to semver. Let's tie up this module's loose ends and follow your 1.0.0 plan.

@zrrrzzt
Copy link
Contributor Author

zrrrzzt commented Jul 17, 2015

If we still agree to do this: can you setup a node-wcag-cli repo? We can just copy this repo and take it from there.

@contolini
Copy link
Member

@zrrrzzt On it.

@contolini
Copy link
Member

Alright, I straight up copied it, including its history: https://github.com/cfpb/node-wcag-cli

@zrrrzzt
Copy link
Contributor Author

zrrrzzt commented Jul 17, 2015

👍 Great. I'll start cleaning it up.

@zrrrzzt zrrrzzt closed this as completed Jul 17, 2015
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

No branches or pull requests

2 participants