Confusing content of "message" parameter when using assert()

[damien-rembert]

Hello,

Not sure if this is a convention but it seems like the error messages that are used with Node's assert sometimes describe the expected situation rather than the actual one.

For example:

    const result = linter.lintResult.files[0].updatedSource;
    const expectedResult = normalizeNewLines(check.after);
    const effectiveDiff = getDiff(expectedResult, result, source);
    assert(effectiveDiff.length === 0, "Code has been formatted correctly");

I think this is a bit confusing, I would expect the error message to describe the situation when the asserted value is falsy since this is when the message will be displayed (in that case "Code was not formatted correctly).

There are other occurrences which is why I assume this was done on purpose.

        assert(linter.outputString.includes("warning"), "Output string contains warning");
        assert(linter.lintResult.summary.totalFoundWarningNumber > 0, "Warnings found");
        assert(linter.lintResult.summary.totalFoundInfoNumber > 0, "Infos found");

Looking at the docs, assert() is an alias of ok(), the message seems to describe the situation when the asserted value is falsy:

assert.ok(false, 'it\'s false');
// AssertionError: it's false

I guess either option can make sense so this issue is mainly asking the expected content of the message parameter when using assert() in this project.
Thanks!

[github-actions]

This issue has been automatically marked as stale because it has not had recent activity.
It will be closed in 14 days if no further activity occurs.
Thank you for your contributions.

If you think this issue should stay open, please remove the O: stale 🤖 label or comment on the issue.