Change document-exported to traverse the code #533
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Instead of traversing over all input files this changes documentExported to traverse from the exports in the input files, loading, parsing and traversing the module specifier as needed. Fixes documentationjs#515
|
|
||
| /** | ||
| * Iterate through the abstract syntax tree, finding ES6-style exports, | ||
| * and inserting blank comments into documentation.js's processing stream. | ||
| * Through inference steps, these comments gain more information and are automatically | ||
| * documented as well as we can. | ||
| * @param {Function} parseToAst funtiont that parses to an ast |
|
One thing I "struggled" with in this PR is to propagate the filename and source. Babel can attach the filename to the location of all location objects. That way we do not need to pass in data... but we do need the |
|
Wow, okay - yeah, took me a little while to even figure out what this patch is doing. Very impressive. Merging - I've been doing mostly work and not much documentation.js recently, but have some free time in the next few days so am looking to knock out a lot of outstanding tasks. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Instead of traversing over all input files this changes
documentExported to traverse from the exports in the input files,
loading, parsing and traversing the module specifier as needed.
Fixes #515