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

Support npm #2

Merged
merged 1 commit into from
Feb 22, 2016
Merged

Support npm #2

merged 1 commit into from
Feb 22, 2016

Conversation

jasonkarns
Copy link
Contributor

This is a minimal package.json.

name and version are required by npm to install.

private is not required, but is to prevent this module from accidentally being published to npm until/if desired. (I think it's advisable to leverage github for now.)

Of course, there is a lot of other metadata that would be useful in the package:
description, homepage, repository, bugs, license

However, since bpkg also uses package.json (currently, anyway), I added only the bare minimum properties at the moment.

I'm waiting to open a similar PR to bats-assert until any issues are discussed here, (since the bats-assert package.json will be virtually the same). The only difference is that the bats-assert package.json will include bats-core as a dependency (direct or peer, TBD)

@jasonkarns
Copy link
Contributor Author

This is sorta dependant on ztombol/bats-assert#3 since both bats-assert and bats-core need tagged releases. The released version will need set in the package.json as version

@jasonkarns
Copy link
Contributor Author

v0.1.0 was tagged so the package.json has been updated to reflect that version number.

This minimal package.json is now ready to merge. Adding all the extra metadata description, homepage, repository, bugs, license can be discussed separately if desired.

ztombol added a commit that referenced this pull request Feb 22, 2016
@ztombol ztombol merged commit 56127ed into ztombol:master Feb 22, 2016
@ztombol
Copy link
Owner

ztombol commented Feb 22, 2016

@jasonkarns Could you do the same for bats-assert and add the installation notes to bats-docs?

@jasonkarns
Copy link
Contributor Author

@ztombol yep!

@jasonkarns jasonkarns deleted the npm branch February 22, 2016 15:44
@ztombol
Copy link
Owner

ztombol commented Feb 22, 2016

@jasonkarns Thanks!

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.

2 participants