(PDOC-252) Add describe features to puppet-strings face #183
Conversation
kris-bosland
force-pushed
the
fix/master/pdoc-252
branch
5 times, most recently
from
66d8871
to
caf4eed
Compare
| render_json(file) | ||
| end | ||
|
|
||
| # If outputting Markdown, render the output | ||
| if options[:markdown] | ||
| render_markdown(file) | ||
| end | ||
|
|
||
| if options[:describe] |
There was a problem hiding this comment.
If we want to have --describe as a generate option, we'll need to register it in the face https://github.com/puppetlabs/puppet-strings/blob/master/lib/puppet/face/strings.rb#L7
on further examination this is just something that the action passes to generate, i guess.
There was a problem hiding this comment.
Yes, I am just using it to carve out a space in the generate options, since I expect most of the describe options to not be applicable to the other modes. Probably a little awkward style wise.
| types/**/*.pp | ||
| lib/**/*.rb | ||
| ) | ||
| PuppetStrings::generate( |
There was a problem hiding this comment.
I wonder about trying to create a PuppetStrings::describe method separate from PuppetStrings::generate. We may be able to cut some of the cruft out to reduce load time.
There was a problem hiding this comment.
Any suggestions for stuff we don't need for describe @eputnam ?
There was a problem hiding this comment.
I forget now what I was thinking here. I guess that describe doesn't need to look at everything we list in generate normally? But as for what that is, I can't remember.
There was a problem hiding this comment.
Yeah, I guess the search_patterns I set up here are much less than the regular generate. I think for now I will focus on filling in missing data, then I will come back and look for performance improvements.
lib/puppet-strings/describe.rb
Outdated
| # @param [bool] list Create the summarized list instead of describing each type. | ||
| # @param [bool] providers Show details of the providers. | ||
| # @return [void] | ||
| def self.describe(describe_types = [], list = false, providers = false) |
There was a problem hiding this comment.
sort of a nit, but we've been calling the methods that create the final output render
kris-bosland
force-pushed
the
fix/master/pdoc-252
branch
from
caf4eed
to
a13eafc
Compare
kris-bosland
force-pushed
the
fix/master/pdoc-252
branch
from
a13eafc
to
ad83ff5
Compare
kris-bosland
changed the title
|
Hey @eputnam , I think this is ready for merge - it isn't a complete reimplementation of describe, but I think it makes more sense to do this work in several pull requests. This does pull in the missing pieces of the file type that we were looking at back in June. |
Hey @eputnam , here is that PR that I was talking about. LMK when you have had some time to look at this, and then I would like to talk about how I can pull in the data I need to finish describe features. Thanks!