sindresorhus/eslint-plugin-unicorn

Allow some strings in `string-content`

Open

#681 创建于 2020年4月11日

在 GitHub 查看
 (3 评论) (3 反应) (0 负责人)JavaScript (5,022 star) (468 fork)user submission
enhancementhelp wanted

描述

Rule: https://github.com/sindresorhus/eslint-plugin-unicorn/blob/master/docs/rules/string-content.md

Issues reported in https://github.com/xojs/xo/pull/439#issuecomment-598751860

I initially suggested this rule in https://github.com/sindresorhus/eslint-plugin-unicorn/issues/327 but I'm not able to use it for my original case because it applies to strings that shouldn't be changed.

I think this rule should instead be applied only in some cases, via whitelist.

An example would be:

  • use variable name, e.g. const description = 'More...'
  • use property name, e.g. {description: 'More...'}
  • use TypeScript type, e.g. FeatureMeta['description']
  • use AST like indent rule’s ignoreNodes (not sure if this is applicable)
  • use JSX attributes and textContent

This would probably replace the current tag-based blacklist.

贡献者指南

技术栈
javascriptnodejs
领域
developer experiencetooling
议题类型
feature
难度面向新贡献者的预计实现难度，1 表示很小改动，5 表示专家级工作。
3
预计时间有经验贡献者完成调查、实现、测试并准备 pull request 的粗略时间范围。
1-2 days
活动状态议题当前的可参与程度：新鲜、活跃、陈旧、阻塞或等待维护者输入。
stale
清晰度议题是否清楚说明期望改动、验收标准和下一步。
mostly clear
前置要求
ESLint rule developmentJavaScriptAST traversal
新手友好度1-100 的估计分数，表示该议题对首次贡献者的友好程度。
45
研究方向
Examine the current implementation of the `string content` rule in `docs/rules/string content.md` and the source file in `rules/string content.js`. Review the discussion in the linked XO PR #439 and issue #327. The goal is to replace the blacklist approach with a whitelist, allowing users to specify allowed strings based on variable names, property names, TypeScript types, or AST node types. Consider using an `ignoreNodes` option similar to ESLint's `indent` rule. Look at how the rule currently handles tagged templates and JSX elements to understand the existing logic.