search

puppetlabs / puppet-strings

The next generation Puppet documentation extraction and presentation tool.
http://puppetlabs.github.io/puppet-strings/
Apache License 2.0
90 stars 84 forks source link

Implement JSON Schema generation for lookup data #277

Closed seanmil closed 1 year ago

seanmil commented 3 years ago

Generate https://json-schema.org data for all class parameters to support validation of all Hiera automatic parameter lookup based parameters based on the defined Puppet data types associated with each parameter. The resulting schema also includes parameter descriptions based on the documentation which can be displayed by IDEs as users are working.

If run against a Puppet environment the resulting schema will also have all data type aliases resolved and included in the schema, with supporting documentation.

seanmil commented 3 years ago

I'm sure there is more tweaking this could use - particularly around the output formatting in the description/markdownDescription data, but it's a decent chunk of code and I wanted to get out there for some feedback and to let folks kick the tires.

jpogran commented 3 years ago

@seanmil just converting this to a draft while you work on this and we get some feedback

CLAassistant commented 3 years ago

CLA assistant check
All committers have signed the CLA.

chelnak commented 2 years ago

Hey @seanmil - is this something that you are still interested in working on?

chelnak commented 1 year ago

Closing this PR due to inactivity.

Please feel free to submit again in the future if this is a feature that you'd like to pick back up.

Thank you 😄