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

Strip comments before parsing JSON config files #10

Merged
merged 1 commit into from
Dec 30, 2023

Strip comments before parsing JSON config files

ea0fbec
Select commit
Loading
Failed to load commit list.
Sign in for the full log view
Merged

Strip comments before parsing JSON config files #10

Strip comments before parsing JSON config files
ea0fbec
Select commit
Loading
Failed to load commit list.
GitHub Actions / Test Results succeeded Dec 30, 2023 in 0s

Test Results ✅

Tests passed successfully

✅ TESTS-TestSuites.xml

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

Test suite Passed Failed Skipped Time
test/analyzeArgv.test.js 9✅ 25ms
test/findFile.test.js 3✅ 10ms
test/getPath.test.js 3✅ 7ms
test/main.test.js 4✅ 539ms
test/runJsdoc.test.js 5✅ 291ms
test/stripJsonComments.test.js 9✅ 9ms

✅ 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 '/'