feat: add explanation for ignore directives

[chengr4]

Hi,

This is my first contribute in deno codebase. I feel nervous and hope it can go well.

This PR is for #1076.

Please check my updates and slowly guide me to the right direction 🙏. Thanks in advance

TODO

• Add test case for test_parse_global_ignore_directives (done at 2024.01.20)
• Feature: add multi-line

[CLAassistant]

All committers have signed the CLA.

[bartlomieju]

Looks like a good start. Please run tools/format.ts to format the code and make CI happy.

[chengr4]

hi @bartlomieju,
I fixed CI and added test cases for test_parse_global_ignore_directives. Please check it out when you get time, and tell me anything I missed 🙏.

BTW, There are two things I have zero confidence.

1. Variable Naming: eg. comment_text_without_reason and IGNORE_COMMENT_REASON_RE <= I hope these are ok.

let comment_text =
        IGNORE_COMMENT_CODE_RE.replace_all(&comment_text_without_reason, ",");

About adding & in front of comment_text_without_reason, I only followed the instruction of the compiler and hope it was the best practice.

[bartlomieju]

This looks good, I have only one worry - it will be easy to make comments over 80 or 100 characters with explanation. I wonder if we could figure out a way to make these comment multi-line.

Could you try to add a test case for something like:

// deno-lint-ignore no-explicit-any no-empty no-debugger -- super, duper, very long
// reason for ignoring
function foo(): any {}

[chengr4]

I tried the test case you gave. it was able to be passed.
but dlint with real TS file did not work.

Do you want to finish multi-line issue in this PR? Or we can open a new issue for it with new PR.

P.s. A small question: Is it common to add comments under 'lint ignore' (Is it common in Node.js)? I personally have never seen it before.

[bartlomieju]

Yeah, we can do multi-line support in a follow up. Let's land it as is.

[bartlomieju]

hi @bartlomieju, I fixed CI and added test cases for test_parse_global_ignore_directives. Please check it out when you get time, and tell me anything I missed 🙏.

BTW, There are two things I have zero confidence.

1. Variable Naming: eg. comment_text_without_reason and IGNORE_COMMENT_REASON_RE <= I hope these are ok.

let comment_text =
        IGNORE_COMMENT_CODE_RE.replace_all(&comment_text_without_reason, ",");

About adding & in front of comment_text_without_reason, I only followed the instruction of the compiler and hope it was the best practice.

Yeah, these seems fine 👍

[chengr4]

Sorry, I pressed the button accidentally. I didn't intend to rush you 😓.

[bartlomieju]

LGTM, nice work @chengr4!