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

未关闭
#151 3 条评论 2 个 reaction 已指派 0 人 在 GitHub 查看

维护者通常 1 天内回复

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
35/100
Issue 类型
功能
描述清晰度
基本清楚
活跃度
停滞
技术栈
rust, shell

调研方向

Start by reading the project's spell-checking entry points and tests to find how ignored words are currently configured; the issue does not name specific files. Then determine how directive comments could be associated with individual word occurrences and what syntax and scope they should support. Done means a documented directive can suppress one spelling occurrence while leaving other occurrences flagged, with tests covering both cases.

由索引模型根据 Issue 内容生成。

描述

enhancement feedback needed
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

主要语言
Rust
星标
925
派生
59
平均合并
53 分钟
30 天内合并 PR
10

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 没有 Pull Request 模板
  • 阅读贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

blopker/codebook 的其他 Issue

查看 blopker/codebook 的全部 Issue

相似的 Issue

更多 Rust Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。