[FEATURE]: Add directive comments to ignore a word on a per instance basis

[ghuh]

Feature Description

It would be nice to ignore a single instance of a spelling issue rather than project wide or globally. Similar to how shellcheck does it:

# shellcheck disable=SC2016
PS4='+$BASH_SOURCE:$LINENO:$FUNCNAME: '

Use Case

The use case here is sometimes you're calling code that you have no control over and a function name has a weird spelling (e.g. fzf's advanced configuration uses _fzf_comprun()). comprun is a word that generally I want to be flagged as a spelling error, but in that one case I'd like to ignore it

Proposed Solution

Probably something like how shellcheck does it:

# shellcheck disable=SC2016
PS4='+$BASH_SOURCE:$LINENO:$FUNCNAME: '

Alternative Solutions

No response

Examples

No response

Additional Context

No response

[blopker]

Hey! Thanks for the suggestion. I had a feeling this would come up at some point, but didn't want to address it until there was an actual need.

The main issue is that this is not a simple feature to implement. I'm also not sure if I like the comment-based approach that some other linter-type systems use, vs keeping everything in a config file.

My hope is that we can avoid it altogether by relying on Codebook's understanding of code semantics and not flagging these not-user-controlled words at all.

However, as always, the devil is in the details. Do you have a specific example of code that is not user controller which is getting flagged by Codebook that I can take a look at?

[ghuh]

Sure, here's the example i was referring to above where comprun is "misspelled":

_fzf_comprun() {
  local command=$1
  shift

  case "$command" in
    cd)           fzf --preview 'tree -C {} | head -200'   "$@" ;;
    export|unset) fzf --preview "eval 'echo \$'{}"         "$@" ;;
    ssh)          fzf --preview 'dig {}'                   "$@" ;;
    *)            fzf --preview 'bat -n --color=always {}' "$@" ;;
  esac
}

source

I think codebook is doing the right thing. If I were naming a function and had a misspelled word in it, I'd want codebook to alert me. It has no way of knowing I don't control the naming of this function.

That's why I feel like there needs to be some way for me to tell codebook to just ignore this one case.

[blopker]

I see, so this is some kind of hook that looks like a user-defined function, but need to be named in a way that the user does not control. It seems there are several _fzf_ hooks that will also cause this issue.

Yeah, I don't have a good general solution for that off the top of my head other than what you've already proposed.

I'll leave this request open in case more people run into this issue to collect feedback. However, in the meantime, I can suggest using Codebook's ignore_patterns setting in your codebook.toml file to ignore these hook lines specifically:

ignore_patterns = ['^_fzf_']

Hope this helps!