Skip to content

Add --bail cli flag, exit with non-zero status if scanning results in error, fixes: #370 #371

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.

Sign up for GitHub

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

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add --bail cli flag, exit with non-zero status if scanning results in error, fixes: #370 #371

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f0946af
Add --bail cli flag, fixes: #370
vidhill Jul 14, 2023
f125363
Merge remote-tracking branch 'upstream/master' into feature/add-bail-…
vidhill Aug 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
37 changes: 26 additions & 11 deletions bin/swagger-jsdoc.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,14 +16,15 @@ program
'Input swagger definition.'
)
.option('-o, --output [swaggerSpec.json]', 'Output swagger specification.')
.option('-b, --bail', 'Exit with failure status (1) if generation errors.')
.parse(process.argv);

if (!process.argv.slice(2).length) {
program.help();
process.exit();
}

const { definition } = program;
const { definition, bail: bailOnError } = program;
const output = program.output || 'swagger.json';

if (!definition) {
Expand Down Expand Up @@ -71,16 +72,30 @@ if (!program.args.length) {

const format = path.extname(output);

const result = swaggerJsdoc({
swaggerDefinition,
apis: program.args,
format,
});
function doGeneration(failOnErrors) {
const result = swaggerJsdoc({
failOnErrors,
swaggerDefinition,
apis: program.args,
format,
});

if (format === '.json') {
fs.writeFileSync(output, JSON.stringify(result, null, 2));
} else {
fs.writeFileSync(output, result);
if (format === '.json') {
fs.writeFileSync(output, JSON.stringify(result, null, 2));
} else {
fs.writeFileSync(output, result);
}

console.log('Swagger specification is ready.');
}

console.log('Swagger specification is ready.');
if (bailOnError === true) {
try {
doGeneration(bailOnError);
} catch (err) {
console.log('Swagger specification generation failed \n\n', err.message);
process.exit(1);
}
} else {
doGeneration(false);
}