Skip to content

Commit

Permalink
add more messages to verbose logs
Browse files Browse the repository at this point in the history 
file names given to and received the library are logged independently
linters’s success messages are logged to stdout and fail to stderr
  • Loading branch information
meisam committed Aug 3, 2023
1 parent df9cf88 commit 4ab0678
Show file tree
Hide file tree
Showing 2 changed files with 82 additions and 37 deletions.
91 changes: 57 additions & 34 deletions markdownlint.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -116,48 +116,64 @@ function prepareFileList(files, fileExtensions, previousResults) {
}

function printResult(lintResult) {
const results = Object.keys(lintResult).flatMap(file =>
lintResult[file].map(result => {
if (options.json) {
const results = Object.keys(lintResult)
.flatMap(file => {
if (lintResult[file].length > 0) {
return lintResult[file].map(result => {
if (options.json) {
return {
fileName: file,
...result
};
}

return {
file: file,
lineNumber: result.lineNumber,
column: (result.errorRange && result.errorRange[0]) || 0,
names: result.ruleNames.join('/'),
description: result.ruleDescription + (result.errorDetail ? ' [' + result.errorDetail + ']' : '') + (result.errorContext ? ' [Context: "' + result.errorContext + '"]' : '')
};
});
}

if (options.verbose && !options.json) {
return {
fileName: file,
...result
file: file
};
}

return {
file: file,
lineNumber: result.lineNumber,
column: (result.errorRange && result.errorRange[0]) || 0,
names: result.ruleNames.join('/'),
description: result.ruleDescription + (result.errorDetail ? ' [' + result.errorDetail + ']' : '') + (result.errorContext ? ' [Context: "' + result.errorContext + '"]' : '')
};
return null;
})
);
.filter(Boolean);

let lintResultString = '';
let lintResultStrings = [];
if (results.length > 0) {
if (options.json) {
// Note: process.exit(1) will end abruptly, interrupting asynchronous IO
// streams (e.g., when the output is being piped). Just set the exit code
// and let the program terminate normally.
// @see {@link https://nodejs.org/dist/latest-v8.x/docs/api/process.html#process_process_exit_code}
// @see {@link https://github.com/igorshubovych/markdownlint-cli/pull/29#issuecomment-343535291}
process.exitCode = exitCodes.lintFindings;
results.sort((a, b) => a.fileName.localeCompare(b.fileName) || a.lineNumber - b.lineNumber || a.ruleDescription.localeCompare(b.ruleDescription));
lintResultString = JSON.stringify(results, null, 2);
} else {
results.sort((a, b) => a.file.localeCompare(b.file) || a.lineNumber - b.lineNumber || a.names.localeCompare(b.names) || a.description.localeCompare(b.description));

lintResultString = results
.map(result => {
lintResultStrings = results.map(result => {
if (result.lineNumber) {
process.exitCode = exitCodes.lintFindings;
const {file, lineNumber, column, names, description} = result;
const columnText = column ? `:${column}` : '';
return `${file}:${lineNumber}${columnText} ${names} ${description}`;
})
.join('\n');
}
}

// Note: process.exit(1) will end abruptly, interrupting asynchronous IO
// streams (e.g., when the output is being piped). Just set the exit code
// and let the program terminate normally.
// @see {@link https://nodejs.org/dist/latest-v8.x/docs/api/process.html#process_process_exit_code}
// @see {@link https://github.com/igorshubovych/markdownlint-cli/pull/29#issuecomment-343535291}
process.exitCode = exitCodes.lintFindings;
return `${result.file}: ✔`;
});
lintResultString = lintResultStrings.join('\n');
}
}

if (options.output) {
Expand All @@ -169,7 +185,17 @@ function printResult(lintResult) {
process.exitCode = exitCodes.failedToWriteOutputFile;
}
} else if (lintResultString && !options.quiet) {
console.error(lintResultString);
if (options.json) {
console.error(lintResultString);
} else {
for (const line of lintResultStrings) {
if (line.endsWith(': ✔')) {
console.log(line);
} else {
console.error(line);
}
}
}
}
}

Expand All @@ -192,7 +218,7 @@ program
.option('-q, --quiet', 'do not write issues to STDOUT')
.option('-r, --rules [file|directory|glob|package]', 'include custom rule files', concatArray, [])
.option('-s, --stdin', 'read from STDIN (does not work with files)')
.option('-v, --verbose', 'write file names to STDOUT')
.option('-v, --verbose', 'verbose mode')
.option('--enable [rules...]', 'Enable certain rules, e.g. --enable MD013 MD041 --')
.option('--disable [rules...]', 'Disable certain rules, e.g. --disable MD013 MD041 --');

Expand All @@ -202,11 +228,10 @@ if (options.quiet && options.verbose) {
options.verbose = false;
}

if (options.verbose) {
console.log(pkg.name, "version", pkg.version);
if (options.verbose && !options.output) {
console.log(pkg.name, 'version', pkg.version);
}


function tryResolvePath(filepath) {
try {
if (path.basename(filepath) === filepath && path.extname(filepath) === '') {
Expand Down Expand Up @@ -266,10 +291,8 @@ const files = prepareFileList(program.args, ['md', 'markdown']).filter(value =>
const ignores = prepareFileList(options.ignore, ['md', 'markdown'], files);
const customRules = loadCustomRules(options.rules);
const diff = files.filter(file => !ignores.some(ignore => ignore.absolute === file.absolute)).map(paths => paths.original);
if (options.verbose) {
for (const file of diff) {
console.log('checking', file);
}
if (options.verbose && !options.stdin) {
console.log('files to check:', diff.join(' '));
}

function lintAndPrint(stdin, files) {
Expand Down Expand Up @@ -314,7 +337,7 @@ function lintAndPrint(stdin, files) {
const fixResult = markdownlint.sync(fixOptions);
const fixes = fixResult[file].filter(error => error.fixInfo);
if (fixes.length > 0) {
if (options.verbose) {
if (options.verbose && !options.output) {
console.log('fixing', file);
}

Expand Down
28 changes: 25 additions & 3 deletions test/test.js
View file
Original file line number Diff line number Diff line change
Expand Up @@ -827,14 +827,16 @@ test('configuration can be .cjs in the ESM (module) workspace', async t => {

test('--verbose flag for correct file', async t => {
const result = await execa('../markdownlint.js', ['--verbose', 'correct.md'], {stripFinalNewline: false});
t.true(result.stdout.includes('checking correct.md'));
t.true(result.stdout.includes('files to check: correct.md'));
t.true(result.stdout.includes('correct.md: ✔'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});

test('--verbose flag with --fix for correct file', async t => {
const result = await execa('../markdownlint.js', ['--fix', '--verbose', 'correct.md'], {stripFinalNewline: false});
t.true(result.stdout.includes('checking correct.md'));
t.true(result.stdout.includes('files to check: correct.md'));
t.true(result.stdout.includes('correct.md: ✔'));
t.true(!result.stdout.includes('fixing correct.md'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
Expand All @@ -847,10 +849,30 @@ test('--verbose flag with --fix for incorrect file', async t => {
await execa('../markdownlint.js', ['--fix', '--verbose', '--config', 'test-config.json', path.resolve(fixFileD)], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.true(error.stdout.includes('checking ' + path.resolve(fixFileD)));
t.true(error.stdout.includes('files to check: ' + path.resolve(fixFileD)));
t.true(error.stdout.includes('fixing ' + path.resolve(fixFileD)));
t.is(error.stderr.match(errorPattern).length, 2);
t.is(error.exitCode, 1);
fs.unlinkSync(fixFileD);
}
});

test('--quiet overrides --verbose', async t => {
try {
await execa('../markdownlint.js', ['--quiet', '--verbose', '--config', 'test-config.json', 'incorrect.md'], {stripFinalNewline: false});
t.fail();
} catch (error) {
t.is(error.stdout, '');
t.is(error.stderr, '');
t.is(error.exitCode, 1);
}
});

test('--stdin and --verbose with valid input logs stdin as source', async t => {
const input = ['# Heading', '', 'Text', ''].join('\n');
const result = await execa('../markdownlint.js', ['--verbose', '--stdin'], {input, stripFinalNewline: false});
t.true(result.stdout.includes('stdin: ✔'));
t.true(!result.stdout.includes('files to check:'));
t.is(result.stderr, '');
t.is(result.exitCode, 0);
});

0 comments on commit 4ab0678

Please sign in to comment.