microsoft / microsoft/TypeScript

JSDoc for file/directory autocompletion

Abierto
#43,445 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.4k
Merge medio
1 d 19 h
PR fusionados (30 d)
117

Descripción

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.

Guía de contribución

Abrir la guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Línea de trabajo

La propuesta no menciona ningún archivo, prueba ni punto de entrada. Empieza por determinar dónde se gestionan las opciones de JSDoc/plugin y la finalización de rutas, y después define, antes de la implementación, el comportamiento de anotaciones compatible, el alcance de las rutas y el tratamiento de los archivos que faltan; se considera terminado cuando la finalización solicitada funciona para los casos de uso descritos.

Escrito por el modelo de indexación a partir del texto del issue.

Evaluación

Stack tecnológico
javascript, typescript
Área
developer-experience
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Necesita aclaración
Aptitud para principiantes
25/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.