`harper-ls` ignores comments between shebang and code

[mcecode]

I guess this behavior was introduced in #947. It could be a gotcha for people who like putting script descriptions after the shebang. Demo below:

Screencast.webm

[hippietrail]

I had a quick look and it was enough for me to realize I don't know much about how this code works. Text seems to come in blocks which have no guarantee that they're single lines and we're checking that certain text occurs anywhere within the block of, in the case of shebangs, at the start. But I don't quite follow where the blocks of text come from - somehow from Tree-sitter.

For a shebang to be a shebang it covers only the line it's on, and that line must be the first line of the file. False shebangs shouldn't be allowed to create edge cases IMHO.

[grantlemons]

I think this comes from merging the whitespace in TreeSitterMasker.

impl Masker for TreeSitterMasker {
    fn create_mask(&self, source: &[char]) -> Mask {
        let text: String = source.iter().collect();

        let Some(root) = self.parse_root(&text) else {
            return Mask::new_blank();
        };

        let mut comments_spans = Vec::new();

        self.extract_comments(&mut root.walk(), &mut comments_spans);
        let comments_spans = byte_spans_to_char_spans(comments_spans, &text);

        let mut mask = Mask::new_blank();

        for span in comments_spans {
            mask.push_allowed(span);
        }

        mask.merge_whitespace_sep(source); // Issue caused here

        mask
    }
}

And then using the following ignore condition in CommentMasker:

            Box::new(|text| {
                text.contains("spellchecker:ignore")
                    || text.contains("spellchecker: ignore")
                    || text.contains("spell-checker:ignore")
                    || text.contains("spell-checker: ignore")
                    || text.contains("spellcheck:ignore")
                    || text.contains("spellcheck: ignore")
                    || text.contains("harper:ignore")
                    || text.contains("harper: ignore")
                    || text.starts_with("#!") // Issue caused here
            }),

[github-actions]

This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 14 days. Thank you for your contribution!

[elijah-potter]

Can we just remove the offending line? Would it be as simple as not merging the white space?

[github-actions]

This issue has been marked 'stale' due to lack of recent activity. If there is no further activity, the issue will be closed in another 14 days. Thank you for your contribution!

[github-actions]

This issue has been closed due to inactivity. If you feel this is in error, please reopen the issue or file a new issue with the relevant details.