microsoft / microsoft/TypeScript

Inspect interface composition hierarchy and its full set of members

Ouverte
#37,148 0 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.4k
Merge moyen
1 j 19 h
PR mergées (30 j)
117

Description

Search Terms

interface extends hierarchy, interface extends tree, interface tree

Suggestion

Inspired by the recently introduced function call tree, I would like to propose a similar kind of feature allowing for easy inspection of an interface's hierarchical composition of other interfaces.

Use Cases

Interfaces are great for dependency inversion and its extends allows for interface segregation. This proposed inspection feature would add the kind of super fluffy developer experience that encourages both principles to be used more liberally.

Currently, when the segregated interfaces are finally composed at some kind of top level and one needs to provide all required functionalities, one would need to keep checking what members are still missing. If a member turns up by surprise, it would take recursive Ctrl+click through all subjects of extends to see where that unexpected member is required. This alone is off-putting when one deals with a complex project and would like to keep unit dependencies as small as possible.

With this proposed inspector, one would be able write a unit module, quoting its dependent interfaces without needing to worry that the final composition way up would be hard to trace. There would be very little temptation/excuse to define some kind of God-interface, whose only one or two members are used by any module at a time.

(FWIW in my projects I'm already pursuing dependency inversion in full force and it pays great maintainability dividends. Even with the recursive click-through it is still significantly easier to reason with IMO than God interfaces.)

Examples

For instance, for something like this (in reality, these interfaces would likely live in different files):

interface A { /* ... */ }
interface B { /* ... */ }
interface C extends A { /* ... */ }
interface D extends B { /* ... */ }
interface E extends C, D { /* ... */ }

would give rise to this tree upon inspecting E:

E
+- C
|  +- A
+- D
|  +- B
+- A
+- B

plus a view that shows all effective members of E.

I'm not sure how the listing of members would work precisely, but for starters it would be good to be able to use it to answer questions like:

  1. What methods do I now expect to provide?
  2. Why do I have to implement method X? (For those familiar with Yarn, it would be like yarn why on an interface member.)

I'm sure others can come up with more suggestions on the desirable dev-experience around the core idea.

Checklist

My suggestion meets these guidelines:

  • This wouldn't be a breaking change in existing TypeScript/JavaScript code
  • This wouldn't change the runtime behavior of existing JavaScript code
  • This could be implemented without emitting different JS based on the types of the expressions
  • This isn't a runtime feature (e.g. library functionality, non-ECMAScript syntax with JavaScript output, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

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 mentionne aucun fichier, test ou point d’entrée. Commencez par examiner la hiérarchie d’interfaces d’exemple ainsi que les vues demandées de la hiérarchie et des membres effectifs, puis clarifiez la surface d’inspection et le comportement attendu avant l’implémentation. La tâche sera considérée comme terminée lorsqu’une méthode définie permettra de suivre les membres hérités et d’expliquer pourquoi chaque membre est requis.

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

Évaluation

Stack technique
typescript
Domaine
developer-experience, tooling
Type d'issue
Fonctionnalité
Difficulté
5/5
Temps estimé
Plus d'une semaine
Activité
À l'abandon
Clarté
Plutôt claire
Accessibilité débutants
25/100

Recevez les nouvelles issues par e-mail

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