diff --git a/README.md b/README.md index c048ab2..85f130f 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ # JSDoc Command Line Interface Wrapper - Wrapper for the [jsdoc][cli] command line tool for generating [JSDoc][] HTML + Wrapper for the [`jsdoc`][cli] command line tool for generating [JSDoc][] HTML output. Removes the existing destination directory if it exists, runs `jsdoc`, and emits the relative path to the generated `index.html` file. @@ -14,9 +14,9 @@ Source: ## Installation -You probably want to install the [jsdoc CLI][cli] first, though the wrapper will -kindly suggest you do so if it can't find it. Using [pnpm][] to install it once -for all your local projects: +You probably want to install the [`jsdoc` CLI][cli] first, though the wrapper will +kindly suggest you do so if it can't find it. Using [`pnpm`][pnpm] to install it +once for all your local projects: ```sh pnpm add -g jsdoc @@ -70,14 +70,14 @@ While admittedly minor annoyances, they're still annoyances: `jsdoc` doesn't have any command line options to deal with either of these issues. Not even `--verbose` nor `--debug` will show the path to `index.html`. -This wrapper resolves both of those minor annoyances. +This wrapper resolves both of these minor annoyances. ## Examples ### This project -This project's ['jsdoc' script](./package.json) uses [jsdoc.json](./jsdoc.json) -as its configuration file, resulting in: +[The 'jsdoc' script from this project's `package.json`](./package.json) uses +[`jsdoc.json`](./jsdoc.json) as its configuration file, resulting in: ```sh $ pnpm jsdoc @@ -198,7 +198,7 @@ I developed this while experimenting with JSDoc on the CLI was silent when it came to reporting where it emitted its output. My first version of the wrapper was a short [Bash][] script, which is available -here as [orig/jsdoc.sh](./orig/jsdoc.sh). It was short and to the point, and +here as [`orig/jsdoc.sh`](./orig/jsdoc.sh). It was short and to the point, and used variations of `sed` and `find` that I'd somehow never used before. (In fact, that's the main reason why I'm keeping it around, for reference.) @@ -207,6 +207,16 @@ as robust as the [Node.js][] version in this package. It also wasn't natively portable to Windows. So I decided to dig in and make it so, using it as a Node.js, JSDoc, and [npm packaging][] exercise as well. +## Copyright + +© 2023 Mike Bland <> () + +## License + +Licensed under the [Mozilla Public License, v. 2.0][mpl-20], included in this +repository as [LICENSE.txt](./LICENSE.txt). See the [MPL 2.0 FAQ][mpl-faq] for a +higher level explanation. + [JSDoc]: https://jsdoc.app/ [cli]: https://github.com/jsdoc/jsdoc [coveralls-jsdw]: https://coveralls.io/github/mbland/jsdoc-cli-wrapper?branch=main @@ -226,3 +236,5 @@ Node.js, JSDoc, and [npm packaging][] exercise as well. [Bash]: https://www.gnu.org/software/bash/ [Node.js]: https://nodejs.org/ [npm packaging]: https://docs.npmjs.com/packages-and-modules +[mpl-20]: https://mozilla.org/MPL/2.0/ +[mpl-faq]: https://www.mozilla.org/MPL/2.0/FAQ/ diff --git a/lib/index.js b/lib/index.js index 812dbc6..9a34a97 100644 --- a/lib/index.js +++ b/lib/index.js @@ -196,8 +196,8 @@ export function stripJsonComments(jsonStr) { inString = curChar !== '"' || escaped escaped = curChar === '\\' && !escaped } else if (inComment) { - if ((inComment === 'line' && curChar === '\n') || - (inComment === 'block' && prevChar === '*' && curChar === '/')) { + if ((curChar === '\n' && inComment === 'line') || + (curChar === '/' && inComment === 'block' && prevChar === '*')) { inComment = null } if (isNotWhitespace) curChar = ' '