Skip to content
This repository was archived by the owner on Mar 8, 2019. It is now read-only.

Conversation

Radiergummi
Copy link
Contributor

This PR adds support for parsing source strings instead of file paths. Therefore, it exports two methods: parseFile and parseSource. It would be easy to keep the parse method in main.js as an alias to parseFile to preserve compatibility.
This feature is quite helpful for documentation generators that process files in separate modules at an earlier stage.

Note: Please ignore the README changes, they are specific to my fork.

@rafaesc
Copy link
Member

rafaesc commented Nov 27, 2017

Hi @Radiergummi, thanks for PR,

I would like to know why you want parseSource, I think that isn't necessary because parsing extract the source.

Regards

@Radiergummi
Copy link
Contributor Author

Hi @rafaesc, I am working on a documentation framework called Phoenix that splits reading, parsing and writing in separate steps, basically. I know this might sound like a pretty special use case, but considering the change is around 20 lines of code on your side and is not a breaking one, I think it wouldn't hurt to add a little flexibility.
I'd be happy to write the tests for this too.

@rafaesc
Copy link
Member

rafaesc commented Nov 28, 2017

Hi @Radiergummi,

Nice work, ok, I will update this repository for fix an issue and the same time I publish your changes.

Regards,

@Radiergummi
Copy link
Contributor Author

Alright, that's perfect, thank you so much! I'll credit you in the Readme once the VueComponentParser is ready 😊

@rafaesc rafaesc merged commit e0eec07 into vue-styleguidist:master Dec 1, 2017
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants