Docz: Integración avanzada de anotaciones mecanografiadas

Creado en 12 jun. 2018 · 3Comentarios · Fuente: doczjs/docz

Hola,

Muchas gracias por Docz, siempre tuve problemas con otras herramientas y Docz simplemente funciona. La integración de TypeScript con PropsTable es increíble y me gustaría abrir una discusión sobre una integración más avanzada:

Admite el valor predeterminado con los parámetros de función predeterminados de JS, es decir, function MyComponent({text = "hello"}) {}
Descripción de soporte con comentario JS encima del parámetro, como lo maneja actualmente el servidor de lenguaje mecanografiado usado en IDE, es decir
`` js
función MyComponent ({
/ *
- Documentación para el parámetro "texto"
  
  *
/

text = "hola"

})

Admite funciones normales, y no exclusivamente componentes de React, incluso con la escritura de parámetros y la documentación de parámetros en línea.

Voilà, estoy seguro de que ya pensaste en estos temas, pero pensé que sería bueno tener una discusión abierta al respecto.

question

Fuente

mquandalle

Comentario más útil

Me alegro de que te haya gustado @mquandalle. Estoy usando mucho mecanografiado en un montón de proyectos hoy en día, para ser honesto, lo estoy usando para todos los proyectos y realmente me gusta. Desafortunadamente, como no tenía mucho tiempo, terminé optando por obtener alguna herramienta que ya hiciera esta integración de anotaciones. En esta versión de docz estamos usando react-docgen para generar la tabla de propiedades, pero es un poco limitada, tiene muchas compensaciones y puede ser un problema de rendimiento 😢Una de estas compensaciones es acerca de las propiedades predeterminadas usando mecanografiado . ¡La integración de flujo es mucho mejor que el mecanografiado!

Quizás en el futuro sea bueno crear algo o mejorar react-docgen para solucionar estos problemas.

Acerca de las anotaciones en funciones normales, esto es asombroso y creo que es algo realmente fácil y viable de hacer con docz. ¡Estoy pensando en eso esta semana y JSDocs hasta ahora es la mejor alternativa!

pedronauck en 13 jun. 2018

👍3

Todos 3 comentarios

Quizás en el futuro sea bueno crear algo o mejorar react-docgen para solucionar estos problemas.

pedronauck en 13 jun. 2018

👍3

Realmente no sé mucho sobre el metaanálisis de archivos JS, pero ¿cree que podría ser viable usar el servidor de lenguaje mecanografiado (para archivos TS y JS) para recopilar metainformaciones como tipos y descripciones de campo usando la misma API que IDE como VS Code?

La idea sería utilizar una API madura de alto nivel en lugar de transformar AST.

mquandalle en 13 jun. 2018