He estado tratando de generar un solo JSdoc para múltiples paquetes en un monorepo (lerna se usa aquí). Y también cada paquete tiene su propio archivo Léame. En el nivel superior hay archivos Léame genéricos. La biblioteca utilizada para este propósito está aquí . ¿Cuál es la forma posible de generar JSDoc?
Jsdoc configurado basado en la configuración:
{ "tags": { "allowUnknownTags": false }, "plugins": [ "plugins/markdown" ], "source": { "include": [ "packages/A/", "packages/B/" ], "excludePattern": "\\.(?:|spec|test)\\.js$" }, "sourceType": "module", "opts": { "readme": "README.md", "template": "templates/default", "encoding": "utf8", "destination": "doc/", "access": "public", "recurse": true, "verbose": true }, "markdown": { "parser": "gfm", "hardwrap": true }, "templates": { "cleverLinks": true, "monospaceLinks": false } }Jsdoc generado para la configuración con múltiples fuentes enumeradas correctamente en la matriz.
"source": { "include": [ "packages/A/", "packages/B/" ], "excludePattern": "\\.(?:|spec|test)\\.js$" }Sin embargo, Readme.md está disponible en todos los paquetes de monorepo que no figuran en ninguna parte. Solo el Léame.md de nivel raíz está disponible y el resto de los paquetes Léame no existe en ninguna parte del JSdoc generado. No pude encontrar una forma de enumerar todos los archivos Léame en la configuración de fuente especificada del módulo A y B correspondiente. Configuración que dudaba es
"opts": { "readme": "README.md", "template": "templates/default", "encoding": "utf8", "destination": "doc/", "access": "public", "recurse": true, "verbose": true }especialmente el atributo readme en el objeto opts asignado al readme de nivel raíz. ¿Es posible proporcionar todos los paquetes Léame de monorepo en Opts ?
El enlace para consultar la configuración.
Cualquier sugerencia para generar JSdoc a monorepo es muy apreciada. ¡Gracias!