microsoft / microsoft/TypeScript

Add a compiler option to error on destructuring a string as an array

Ouverte
#61,106 3 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Awaiting More Feedback Suggestion
Langage dominant
Go
Étoiles
111k
Forks
14.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

🔍 Search Terms

string destructuring

✅ Viability Checklist
⭐ Suggestion
{
  "compilerOptions": {
    "allowDestructureStringAsArray": false
  }
}
declare const source: string
const [item] = source
//        ^^^^^ Error: destructuring string as array is not allowed
📃 Motivating Example

The codebase is everchanging. Someone might do a refactor that change an expression from returning an array of strings to returning a single string. TypeScript which was supposed to catch mistakes like this would fail.

-return Object.entries(myObject)
+return Object.keys()
   .sort(([k1], [k2]) => k1.localeCompare(k2))

As you can see in the above example, the developer forgot to also update the .sort line, but TypeScript didn't alert it. This mistake is easy to catch in small code, but real code is much bigger and similar mistake would be harder to detect.

💻 Use Cases
  1. What do you want to use this for? Catching mistake during refactoring or code editing.
  2. What shortcomings exist with current approaches? There is no "current approaches".
  3. What workarounds are you using in the meantime? There is no workaround, eslint doesn't have such rule, and I doubt it cares about TypeScript's types.

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Piste de recherche

L’issue ne nomme aucun fichier, test ni point d’entrée du compilateur. Commencez par suivre la définition des options du compilateur et la vérification de type du destructuring de tableaux. Le travail est terminé lorsqu’une nouvelle option peut refuser le destructuring d’une chaîne en tant que tableau, tout en conservant le comportement existant par défaut, avec une couverture pour l’exemple présenté.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Évaluation

Stack technique
typescript
Domaine
compilers
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
35/100

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.