【问题标题】:The error message "There are no input files to process" from jsdoc来自 jsdoc 的错误消息“没有要处理的输入文件”
【发布时间】:2014-08-16 06:08:15
【问题描述】:

Jsdoc 安装在本地 ( npm install jsdoc )。尝试执行时出现以下错误 .\node_modules.bin\jsdoc --debug ./lib/JavaScriptSource.js 输出: DEBUG: JSDoc 3.3.0-dev (Sun, 15 Jun 2014 18:39:52 GMT) DEBUG: Environment info: {"env":{"conf":{"tags":{"allowUnknownTags":true},"templ ates":{"monospaceLinks":false,"cleverLinks":false,"default":{"outputSourceFiles" :true}},"source":{"includePattern":".+\.js(doc)?$","excludePattern":"(^|\/|\\ )_"},"plugins":[]},"opts":{"_":["./lib/JavaScriptSource.js"],"debug":true,"destina tion":"./out/","encoding":"utf8"}}} There are no input files to process.

JSDoc 3.3.0-dev(2014 年 6 月 15 日星期日 18:39:52 GMT)

选项:
-t, --template  要使用的模板的路径。默认:
                             路径/到/jsdoc/模板/默认
-c, --configure  配置文件的路径。
                             默认值:path/to/jsdoc/conf.json
......

【问题讨论】:

  • ./lib/JavaScriptSource.js 存在吗?
  • 是的,它确实存在。在 jsdoc 源代码 jsdoc/cli.js 中,调用 cli.scanFiles() 方法后,env.sourceFiles 为空。还没有看到这个地方的详细代码。
  • 在 jsdoc/cli.js 的第 263 行,我能够执行 code var fileData = fs.readFileSync(env.opts._[0], 'utf8'); console.log(fileData.toString()); code 显示内容。 env 对象显示在原始帖子中。
  • Turns 是 jsdoc 中的一个开放错误,它不处理以“_”开头的文件路径。 github.com/jsdoc3/jsdoc/issues/308。也提供解决方案。

标签: javascript node.js jsdoc jsdoc3


【解决方案1】:

Turns 是 jsdoc 中的一个开放错误,它不处理以“_”开头的文件路径。 github.com/jsdoc3/jsdoc/issues/308。也提供解决方案。

默认的 excludePattern (^|/|\)_ 会忽略以下划线开头的路径。

引用自https://github.com/jsdoc3/jsdoc/issues/308的解决方案

"更改默认行为:

将 conf.json.EXAMPLE 复制到一个新文件 conf.json。你可以把它放在 JSDoc 目录或其他目录。如果你把它放在另一个 目录,你需要使用 -c 选项告诉 JSDoc 去哪里 找到它: jsdoc -c path/to/conf.json 在文本编辑器中打开 conf.json。 找到 source.excludePattern 属性,并将其更改为空 字符串。”

【讨论】:

  • 这是预期的行为,而不是错误,这就是为什么该问题已关闭一年半的原因。
  • 好的。 “默认情况下,JSDoc 会忽略以下划线开头的文件和 目录。”因此,如果我的文件路径包含名称错误的文件夹,它也会被忽略。
猜你喜欢
  • 1970-01-01
  • 1970-01-01
  • 1970-01-01
  • 2011-08-23
  • 1970-01-01
  • 1970-01-01
  • 2016-12-11
  • 2010-10-15
  • 1970-01-01
相关资源
最近更新 更多