sindresorhus/eslint-plugin-unicorn

Allow some strings in `string-content`

Chiusa

#681 aperta il 11 apr 2020

Vedi su GitHubGuida contributor
 (3 commenti) (3 reazioni) (0 assegnatari)JavaScript (468 fork)user submission
enhancementhelp wanted

Metriche repository

Star
 (5022 stelle)
Metriche merge PR
 (Merge medio 1g 16h) (399 PR mergiate in 30 g)

Descrizione

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.

Guida contributor

Direzione di ricerca
Esamina l'implementazione corrente della regola `string content` in `docs/rules/string content.md` e il file sorgente in `rules/string content.js`. Rivedi la discussione nella XO PR #439 collegata e nell'issue #327. L'obiettivo è sostituire l'approccio della blacklist con una whitelist, consentendo agli utenti di specificare le stringhe consentite in base ai nomi delle variabili, ai nomi delle proprietà, ai tipi TypeScript o ai tipi di nodi AST. Considera l'uso di un'opzione `ignoreNodes` simile alla regola `indent` di ESLint. Osserva come la regola gestisce attualmente i template con tag e gli elementi JSX per comprendere la logica esistente.
Tech stack
javascriptnodejs
Dominio
developer experiencetooling
Tipo issue
Funzionalità
DifficoltàQuanto dovrebbe essere impegnativa per un nuovo contributor.
3
Tempo stimatoTempo stimato per completare e verificare uno scope piccolo.
1-2 giorni
Stato attivitàQuanto è probabile che la issue sia ancora attiva e reviewable.
Datata
ChiarezzaQuanto chiaramente la issue descrive problema, scope e risultato atteso.
Abbastanza chiara
Prerequisiti
ESLint rule developmentJavaScriptAST traversal
Adatta ai principiantiQuanto la issue è adatta a contributor alla prima esperienza.
45