microsoft / microsoft/TypeScript

JSDoc for file/directory autocompletion

Ouverte
#43,445 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.3k
Merge moyen
2 j 4 h
PR mergées (30 j)
132

Description

Suggestion

🔍 Search Terms

directory autocompletion
file autocompletion
path autocompletion
path intellisense
cwd autocompletion

✅ Viability 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, new syntax sugar for JS, etc.)
  • This feature would agree with the rest of TypeScript's Design Goals.

⭐ Suggestion

An new JSDoc like /* @ts-ignore */ for directory/file autocompletion for an folder (e.g. default: cwd)
e.g.:
Plugin Options:

interface PluginOptions {
  /* @ts-path-autocompletion (optional define path; default: cwd) */
  file: string
}

📃 Motivating Example

It can help to choose the path instead of typing it.
And maybe warn if the path does not exist. (Disabling would be handy for files and folders that are still being created)

💻 Use Cases

IntelliSense for an path in another folder for e.g. webpack plugin options.

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

La proposition ne mentionne aucun fichier, test ni point d’entrée. Commencez par déterminer où sont gérées les options JSDoc/plugin et la complétion des chemins, puis définissez avant l’implémentation le comportement pris en charge pour les annotations, la portée des chemins et la gestion des fichiers manquants ; le travail est terminé lorsque la complétion demandée fonctionne pour les cas d’utilisation décrits.

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

Évaluation

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

Recevez les nouvelles issues par e-mail

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