Я пытаюсь заставить JSDoc работать, но у меня много проблем с супер базовыми настройками:
Вот мой конфигурационный файл:
{
"plugins": [],
"source": {
"include": ["src/components"]
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": ["jsdoc","closure"]
},
"templates": {
"cleverLinks": false,
"monospaceLinks": false
},
"opts": {
"destination": "./out/",
"recurse": true
}
}
Когда я запускаю jsdoc -c conf.json
, он ничего не делает.
Принимая во внимание, что я просто запускаю: jsdoc "src/components" -r
, это работает без проблем.
Когда я использую --debug
, это показывает разницу в конфигурации:
С файлом конфигурации:
DEBUG: Environment info:
{
"env": {
"conf": {
"plugins": [],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": ""
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": [
"jsdoc",
"closure"
]
},
"templates": {
"monospaceLinks": false,
"cleverLinks": false
},
"opts": {
"_": [
"src/components"
],
"destination": "./out/",
"recurse": true
}
},
"opts": {
"_": [],
"configure": "docs/conf.json",
"version": true,
"debug": true,
"destination": "./out/",
"recurse": true,
"encoding": "utf8"
}
}
}
Без конфигурационного файла:
DEBUG: Environment info:
{
"env": {
"conf": {
"plugins": [],
"recurseDepth": 10,
"source": {
"includePattern": ".+\\.js(doc|x)?$",
"excludePattern": "(^|\\/|\\\\)_"
},
"sourceType": "module",
"tags": {
"allowUnknownTags": true,
"dictionaries": [
"jsdoc",
"closure"
]
},
"templates": {
"monospaceLinks": false,
"cleverLinks": false,
"default": {
"outputSourceFiles": true
}
}
},
"opts": {
"_": [
"./src/components"
],
"recurse": true,
"debug": true,
"destination": "./out/",
"encoding": "utf8"
}
}
}