sindresorhus/eslint-plugin-unicorn

Allow some strings in `string-content`

Open

#681 opened on Apr 11, 2020

View on GitHub
 (3 comments) (3 reactions) (0 assignees)JavaScript (5,022 stars) (468 forks)user submission
enhancementhelp wanted

Description

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.

Contributor guide

Tech stack
javascriptnodejs
Domain
developer experiencetooling
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
ESLint rule developmentJavaScriptAST traversal
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
45
Research direction
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.