microsoft / microsoft/TypeScript
jsdoc: escaped property names are not parsed properly
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- Go
- Estrellas
- 111k
- Forks
- 14.4k
- Merge medio
- 1 d 19 h
- PR fusionados (30 d)
- 117
Descripción
Bug Report
🔎 Search Terms
jsdoc
escape
property names
🕗 Version & Regression Information
- This is the behavior in every version I tried, and I reviewed the FAQ for entries about
jsdoc
⏯ Playground Link
Playground link with relevant code
💻 Code
/**
* @see https://datatracker.ietf.org/doc/html/rfc7517#section-4
* @typedef {Object} JWK
* @prop {string} kty key type
* @prop {string} [x5t\u0023S256] X.509 Certificate SHA-256 Thumbprint
*/
/** @type {JWK} */
const o = {
kty: 'foo',
'x5t#S256': 'bar',
};
🙁 Actual behavior
Errors:
]' expected.
Type '{ kty: string; 'x5t#256': string; }' is not assignable to type 'JWK'.
Object literal may only specify known properties, and ''x5t#256'' does not exist in type 'JWK'.
🙂 Expected behavior
No errors and to parse escaped property names correctly.
Additional Info
If
\u0020doesn't work on VSCode, file it as an issue with them. The way JSDoc works is to allow such escaping.
And that approach should indeed work with any character as "0020" is the hexadecimal Unicode escape sequence for a space.
\u0023is the code for#(familiarize yourself with Unicode escapes in JavaScript to find for others).
Originally posted by @brettz9 in https://github.com/jsdoc/jsdoc/issues/1468#issuecomment-743490820
Edit: Fixed typo in property name. Incidentally shows the importance of types. 😅
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con el TypeScript Playground enlazado y el ejemplo de JSDoc que muestra un # escapado en un nombre de propiedad. Sigue cómo se analizan y comprueban el typedef de JSDoc y el literal de objeto; se considera terminado cuando el ejemplo no produce errores y reconoce x5t#S256 como la propiedad declarada.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- javascript, typescript
- Área
- compilers
- Tipo de issue
- Error
- Dificultad
- 3/5
- Tiempo estimado
- 1-2 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 42/100