microsoft / microsoft/TypeScript

Add JSON schema to the `typescript` package for `tsconfig.json` and `jsconfig.json`

Abierto
#54,192 3 comentarios 10 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
1 d 19 h
PR fusionados (30 d)
117

Descripción

Suggestion

🔍 Search Terms

  • JSON schema
  • SchemaStore
  • tsconfig.json
  • jsconfig.json

✅ Viability Checklist

N/A

📃 Why

I noticed that Rome doesn't use a traditional hosted JSON schema and instead they publish their JSON schema in their package so that it can then be referenced with a local path:

{
  "$schema": "./node_modules/rome/configuration_schema.json",
}

I see three advantages to this approach...

  1. The JSON schema will match the installed version of the package.
  2. The JSON schema will work without internet access, provided that node_modules has been installed.
  3. Any changes to the JSON schema in the development can be used straight away in examples, etc.

⭐ Suggestion

Maintain the JSON schema in this repository, instead of the the SchemaStore repository. It will be kept in sync with new TypeScript releases. Finally, publish the JSON schemas in the typescript package.

You can still leave the hosted JSON schema as an option, which will always resolve to the JSON schemas for the latest version of TypeScript. This will still be needed for editor autocomplete, whereby the schema is not specified in the JSON, but detected from the name of the file.

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

Comienza inspeccionando cómo se ensambla y publica el paquete TypeScript y, a continuación, identifica dónde se mantienen las definiciones de configuración de tsconfig.json y jsconfig.json. Compara los esquemas locales del paquete deseados con el enfoque existente de SchemaStore y confirma que los esquemas se mantienen sincronizados con las versiones publicadas y se incluyen en el paquete publicado.

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

Evaluación

Stack tecnológico
json, typescript
Área
developer-experience, tooling
Tipo de issue
Nueva funcionalidad
Dificultad
4/5
Tiempo estimado
3-5 días
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.