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
publish to npm #7
Comments
actually, thinking about how I'd like to consume this information, it would be pretty nice if we had:
then someone could use the conventional-changelog-config-spec to populate a command line builder like yargs. |
If you include the schema as a JSON file (as opposed to .js) at a public URL, people can add the following to their config and get editor support: You can also support tooling for JS API consumers via declaration files. You can write the spec as declaration files and extract the JSON schema from there, or vice versa. For example. Either way, you can write the spec once and include both in the published You can also extract an even simpler format from the JSON schema, something like |
[@cspotcode 👍 – I'm going to work on adding the spec using the JSON Schema format. I think the benefit of being able to rely on the tooling in that ecosystem will be great for keeping things in sync. Thanks for the input! I'll put a PR together soon! |
@jbottigliero trust your opinion on the topic; my upstream requirement is ideally being able to populate yargs defaults, descriptions, and types from the JSON. |
- Adds JSON Schema version of the spec (for npm module usage) - Adds basic tests for ensuring JSON Schema spec compliance (using AJV) see #7
- Updates license to MIT (to match other conventional-changelog packages. - Adds keywords. - Removes org scope from name. see #7
Closed a bit prematurely, since it's not actually published yet. Just opened up a PR (#9) that makes some final tweaks to the |
- Updates license to MIT (to match other conventional-changelog packages. - Adds keywords. - Removes org scope from name. see #7
Alright, the conventional-changelog-config-spec should now be available via I have a few follow-up PRs and issues I want to open here, but this should unblock work in other |
@jbottigliero awesome work \o/ I'll start working on getting this update added to standard-version ASAP. |
Good luck @cspotcode |
Good luck |
@jbottigliero here's a thought I have for configuring
standard-version
(and potentially other tools).What if we publish this spec as an npm module, and
index.js
is just the schema with default values for everything:Then we can pull
conventional-changelog-config-spec
in as a dependency forstandard-version
and use it to decide which configuration options need to be passed along to dependencies -- it also allows us to populate default values for all the options.The text was updated successfully, but these errors were encountered: