Skip to content

improve the log function #102

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

Merged
merged 1 commit into from
Apr 29, 2023
Merged

improve the log function #102

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
43 changes: 27 additions & 16 deletions src/openAPIGenerator.js
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,19 @@ class OpenAPIGenerator {
this.logOutput = log;
this.serverless = serverless
this.options = options
this.defaultLog = 'notice';

this.logTypes = {
NOTICE: 'notice',
DEBUG: 'debug',
ERROR: 'error',
WARNING: 'warning',
INFO: 'info',
VERBOSE: 'verbose',
SUCCESS: 'success',
}

this.defaultLog = this.logTypes.NOTICE;

this.commands = {
openapi: {
commands: {
Expand Down Expand Up @@ -81,7 +93,7 @@ class OpenAPIGenerator {
})
}

log(type = this.defaultLog, str) {
log(str, type = this.defaultLog) {
switch(this.serverless.version[0]) {
case '2':
let colouredString = str
Expand All @@ -105,7 +117,7 @@ class OpenAPIGenerator {
}

async generate() {
this.log(this.defaultLog, chalk.bold.underline('OpenAPI v3 Document Generation'))
this.log(chalk.bold.underline('OpenAPI v3 Document Generation'))
this.processCliInput()

const validOpenAPI = await this.generationAndValidation()
Expand All @@ -129,9 +141,9 @@ class OpenAPIGenerator {
}
try {
fs.writeFileSync(this.config.file, output);
this.log('success', 'OpenAPI v3 Documentation Successfully Written')
this.log('OpenAPI v3 Documentation Successfully Written', this.logTypes.SUCCESS)
} catch (err) {
this.log('error', `ERROR: An error was thrown whilst writing the openAPI Documentation`)
this.log(`ERROR: An error was thrown whilst writing the openAPI Documentation`, this.logTypes.ERROR)
throw new this.serverless.classes.Error(err)
}
}
Expand All @@ -141,36 +153,36 @@ class OpenAPIGenerator {

await generator.parse()
.catch(err => {
this.log('error', `ERROR: An error was thrown generating the OpenAPI v3 documentation`)
this.log(`ERROR: An error was thrown generating the OpenAPI v3 documentation`, this.logTypes.ERROR)
throw new this.serverless.classes.Error(err)
})

await generator.validate()
.catch(err => {
this.log('error', `ERROR: An error was thrown validating the OpenAPI v3 documentation`)
this.log(`ERROR: An error was thrown validating the OpenAPI v3 documentation`, this.logTypes.ERROR)
this.validationErrorDetails(err)
throw new this.serverless.classes.Error(err)
})


this.log('success', 'OpenAPI v3 Documentation Successfully Generated')
this.log('OpenAPI v3 Documentation Successfully Generated', this.logTypes.SUCCESS)

return generator.openAPI
}

createPostman(openAPI) {
const postmanGeneration = (err, result) => {
if (err) {
this.log('error', `ERROR: An error was thrown when generating the postman collection`)
this.log(`ERROR: An error was thrown when generating the postman collection`, this.logTypes.ERROR)
throw new this.serverless.classes.Error(err)
}

this.log('success', 'postman collection v2 Documentation Successfully Generated')
this.log('postman collection v2 Documentation Successfully Generated', this.logTypes.SUCCESS)
try {
fs.writeFileSync(this.config.postmanCollection, JSON.stringify(result.output[0].data))
this.log('success', 'postman collection v2 Documentation Successfully Written')
this.log('postman collection v2 Documentation Successfully Written', this.logTypes.SUCCESS)
} catch (err) {
this.log('error', `ERROR: An error was thrown whilst writing the postman collection`)
this.log(`ERROR: An error was thrown whilst writing the postman collection`, this.logTypes.ERROR)
throw new this.serverless.classes.Error(err)
}
}
Expand Down Expand Up @@ -204,7 +216,6 @@ class OpenAPIGenerator {
((config.format === 'yaml') ? 'openapi.yml' : 'openapi.json');

this.log(
this.defaultLog,
`${chalk.bold.green('[OPTIONS]')}
openApiVersion: "${chalk.bold.green(String(config.openApiVersion))}"
format: "${chalk.bold.green(config.format)}"
Expand All @@ -217,9 +228,9 @@ class OpenAPIGenerator {
}

validationErrorDetails(validationError) {
this.log('error', `${chalk.bold.yellow('[VALIDATION]')} Failed to validate OpenAPI document: \n`);
this.log('error', `${chalk.bold.yellow('Context:')} ${JSON.stringify(validationError.options.context[validationError.options.context.length-1], null, 2)}\n`);
this.log('error', `${chalk.bold.yellow('Error Message:')} ${JSON.stringify(validationError.message, null, 2)}\n`);
this.log(`${chalk.bold.yellow('[VALIDATION]')} Failed to validate OpenAPI document: \n`, this.logTypes.ERROR);
this.log(`${chalk.bold.yellow('Context:')} ${JSON.stringify(validationError.options.context[validationError.options.context.length-1], null, 2)}\n`, this.logTypes.ERROR);
this.log(`${chalk.bold.yellow('Error Message:')} ${JSON.stringify(validationError.message, null, 2)}\n`, this.logTypes.ERROR);
}
}

Expand Down