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

Add jsdoc-cli-wrapper.js #79

Merged
merged 3 commits into from
Dec 26, 2023
Merged

Add jsdoc-cli-wrapper.js #79

merged 3 commits into from
Dec 26, 2023

Conversation

mbland
Copy link
Owner

@mbland mbland commented Dec 26, 2023

This is a pure Node.js implementation of the original bin/jsdoc Bash shell wrapper. It's more robust and more portable, including to Windows.

My next move is to extract this into its own published npm package.

This is a pure Node.js implementation of the original bin/jsdoc Bash
shell wrapper. It's more robust and more portable, including to Windows.

My next move is to extract this into its own published npm package.
@mbland mbland self-assigned this Dec 26, 2023
For one thing, Windows can't interpret the `#!/usr/bin/env node` header,
nor can it grok the `bin/jsdoc-cli-wrapper.js` path directly.

Prefixing the script with `node` fixes the second problem. Updating
getPath() to detect the 'win32' platform and adding the .CMD extension
to the candidate path fixes the first. This is because 'pnpm install'
will create a CMD.EXE wrapper for the installed script on Windows.
Don't want to drag down the coverage percentage for the main
application. But I am about to break both jsdoc-cli-wrapper.js and
rollup-plugin-handlebars-precompile into their own npm packages very
soon.
@mbland mbland merged commit 82dded5 into main Dec 26, 2023
3 checks passed
@mbland mbland deleted the jsdoc-cli-wrapper-js branch December 26, 2023 21:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

1 participant