如何在目录中运行jsdoc并忽略.gitignore文件

Question

我可以使用以下命令在整个项目上运行jsdoc：

$ jsdoc -r .

但是这会为node_modules中的js文件生成文档。我该如何告诉jsdoc不要在.gitignore中的文件上运行？

- Harry Moreno

Answer 1

如何使用类似这样的配置文件？

$ jsdoc.js -c ./.jsdoc.conf.json

./.jsdoc.conf.json

{
  "source": {
    "include": ["."],
    "includePattern": ".+\\.js(doc|x)?$",
    "excludePattern": "node_modules"
  }
}

这里的内容来自在Stack上生成jsdoc文档。

- Graham P Heath

---

你能否将 ["./node_modules"] 放入 exclude 参数中并获得相同的结果？ - Float07

由于某种原因，这个代码不起作用，它仍然进入了目录。 - Philll_t

应该使用exclude而不是excludePattern。excludePattern用于正则表达式，而exclude用于明确命名的资源。 - theZ3r0CooL

Answer 2

{
  "source": {
    "include": ["."],
    "includePattern": ".(jsx|js|ts|tsx)$",
    "exclude": [
        "node_modules",
        "docs"
    ]
  }
}

- theZ3r0CooL