Skip to content
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

specify input file + output file #56

Open
boneskull opened this issue Aug 23, 2014 · 2 comments
Open

specify input file + output file #56

boneskull opened this issue Aug 23, 2014 · 2 comments

Comments

@boneskull
Copy link
Contributor

Maybe related to #40 but regardless, I want to read path/to/foo.js and have it output into a file README.md.

@mrjoelkemp
Copy link
Contributor

+1 for having more granular control.

Throwing some ideas out there for possible implementations:

  1. Make the --output option more flexible to allow the user to specify an output directory or output file.
    • jsdox file.js -o readme.md
    • jsdox src/ -o docs/
    • jsdox file1.js -o docs/ (need to either prevent this case or assume this will create docs/file1.md)
  2. Have a new option that pipes the generated MD to stdout allowing a redirect to a custom file.
    • cat file1.js | jsdox -X > readme.md
    • -X is somewhat arbitrary (replicating JSDoc's outputting of the AST to stdout) and open to bikeshedding.

@psq
Copy link
Contributor

psq commented Aug 25, 2014

sounds good to me.

In the first case, only missing case is jsdox file.js -o readme.md, the other 2 should already work today.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants