Format commitlint reports
@commitlint/format
Getting started
npm install --save @commitlint/format
Example
const format = require('@commitlint/format');
const output = format({
valid: false,
errorCount: 1,
warningCount: 1,
results: [
{
valid: false,
input: 'some: commit message',
errors: [
{
valid: false,
level: 2,
name: 'some-error',
message: 'This will show up red as it has level 2'
}
],
warnings: [
{
valid: true,
level: 0,
name: 'some-hint',
message: 'This will not show up as it has level 0'
},
{
valid: false,
level: 1,
name: 'some-warning',
message: 'This will show up yellow as it has level 1'
}
]
}
]
}, {
color: false
});
process.stdout.write(output);
Consult docs/api for comprehensive documentation.