Skip to content

Merge pull request #10 from mbland/strip-json-comments #23

Merge pull request #10 from mbland/strip-json-comments

Merge pull request #10 from mbland/strip-json-comments #23

GitHub Actions / Test Results succeeded Dec 30, 2023 in 1s

Test Results ✅

Tests passed successfully

✅ TESTS-TestSuites.xml

33 tests were completed in 2s with 33 passed, 0 failed and 0 skipped.

Test suite Passed Failed Skipped Time
test/analyzeArgv.test.js 9✅ 15ms
test/findFile.test.js 3✅ 16ms
test/getPath.test.js 3✅ 6ms
test/main.test.js 4✅ 587ms
test/runJsdoc.test.js 5✅ 315ms
test/stripJsonComments.test.js 9✅ 10ms

✅ test/analyzeArgv.test.js

✅ analyzeArgv > empty argv returns defaults
✅ analyzeArgv > destination not set if flag not followed by valid arg
✅ analyzeArgv > -d or --destination sets destination
✅ analyzeArgv > last -d wins
✅ analyzeArgv > -h, --help, -v, or --version sets willGenerate to false
✅ analyzeArgv > -c or --configure sets destination if opts defined
✅ analyzeArgv > last -c with opts defined wins
✅ analyzeArgv > -c with opts.destination undefined resets destination
✅ analyzeArgv > -d overrides -c

✅ test/findFile.test.js

✅ findFile > find file at root of tree
✅ findFile > find files using breadth-first search
✅ findFile > rejects when file not found

✅ test/getPath.test.js

✅ getPath > finds command on POSIX system
✅ getPath > finds command on Windows system
✅ getPath > rejects when command isn't found

✅ test/main.test.js

✅ jsdoc-cli-wrapper > success without index.html path
✅ jsdoc-cli-wrapper > error without index.html path
✅ jsdoc-cli-wrapper > success with index.html path
✅ jsdoc-cli-wrapper > emit internal error

✅ test/runJsdoc.test.js

✅ runJsdoc > emits error if jsdoc not found
✅ runJsdoc > returns success on -h, doesn't delete existing dir
✅ runJsdoc > deletes existing output and returns error
✅ runJsdoc > replaces existing output and returns success
✅ runJsdoc > deletes existing output and returns success

✅ test/stripJsonComments.test.js

✅ stripJsonComments > handles empty string
✅ stripJsonComments > doesn't modify basic object without comments
✅ stripJsonComments > doesn't modify properly escaped strings
✅ stripJsonComments > doesn't modify strings containing comment patterns
✅ stripJsonComments > replaces line comments, preserves existing whitespace
✅ stripJsonComments > replaces block comments, preserves existing whitespace
✅ stripJsonComments > replaces mixed comments and trailing commas before ] or }
✅ stripJsonComments > reopens block comment if character after "*/" is '*'
✅ stripJsonComments > opens a line comment if character after "*/" is '/'