Fix Documentation build on Windows #51
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
patrickarlt
requested changes
Sep 21, 2017
docs/build-typedoc.js
Outdated
| @@ -13,7 +13,7 @@ const md = new MarkdownIt(); | |||
| (function generateTypeDoc() { | |||
| return new Promise((resolve, reject) => { | |||
| const typedoc = spawn( | |||
| "typedoc", | |||
| "typedoc.cmd", | |||
There was a problem hiding this comment.
This will cause a failure on Mac OS and Linux since the command doesn't have .cmd in it. Looks like nodejs/node-v0.x-archive#2318 might be to blame. You could try something like cross-spawn and see if that works. It should be a drop in replacement.
There was a problem hiding this comment.
cross-spawn does work, I can change it to that. Another option would be to switch from spawn to exec. I'm pretty sure it will work on Windows, and can go that route if you prefer
… suggestion
patrickarlt
approved these changes
Sep 22, 2017
|
Tested on my Windows and Mac, works! Thanks @hogpilot. |
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.
Fixes #50 by modifying docs/build-typedoc.js to run on Windows.
For whatever reason, node child processes that use
spawnmust include.cmdin the command name, for example:I'm not sure what effect this will have on Unix.
Also, I found that using
path.septo parse the package name was failing becausepath.sepis'\\'on Windows, but the string it is parsing uses/instead.