microsoft / microsoft/TypeScript

Resolve project references from root

Abierto
#32,161 1 comentario 9 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Awaiting More Feedback Suggestion
Lenguaje dominante
Go
Estrellas
111k
Forks
14.3k
Merge medio
2 d 4 h
PR fusionados (30 d)
132

Descripción

Search Terms

Project reference root resolve.

Suggestion

Resolve project reference paths from root directory of a mono repository.

Use Cases

We have a large mono-repository with 1000s of sub-packages we want to convert to TS projects. Currently the references between them must be defined as relative paths, leading to configuration like:

  "references": [
    {
      "path": "../../../base"
    },
    {
      "path": "../colors"
    },
    {
      "path": "../device_capabilities"
    }
  ],

Which is:

  • Hard to read and reason about
  • Creates noisy diffs when moving packages

Ideally project references could be resolved from the root of the mono-repo project, e.g. rootDir or baseUrl options.

E.g.:

  "references": [
    {
      "path": "base"
    },
    {
      "path": "ui/base/colors"
    },
    {
      "path": "ui/base/device_capabilities"
    }
  ],

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.

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

El issue no menciona archivos de origen, pruebas ni puntos de entrada. Empieza por localizar project-reference path resolution y revisar cómo se relacionan rootDir y baseUrl con el comportamiento propuesto; se considerará completado cuando se hayan acordado e implementado root-relative references, preservando el comportamiento existente para las rutas relativas.

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

Evaluación

Stack tecnológico
typescript
Área
build-system, compilers
Tipo de issue
Nueva funcionalidad
Dificultad
5/5
Tiempo estimado
Más de una semana
Estado de actividad
Estancado
Claridad
Bastante claro
Aptitud para principiantes
35/100

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.