javascript - 咕噜 JSDoc : Use jsdoc JSON file

Question

我想设置一个 Grunt 任务来运行 JSDoc。我正在使用 grunt-jsdoc JSDoc npm 页面推荐的。它工作正常，但我不能使用我创建的 jsdoc.json 文件。

{
  "tags": {
    "allowUnknownTags": true,
    "dictionaries": ["jsdoc","closure"]
  },
  "source": {
    "include": [
      "lib/",
      "routes/",
      "README.md"
    ]
  },
  "plugins": ["plugins/markdown"],
  "templates": {
    "cleverLinks": false,
    "monospaceLinks": false
  },
  "opts": {
    "destination": "public/docs"
  }
}

我发现当我从 JSDoc 中提取一些内容并将它们放入 Grunt 中时，我没有遇到任何问题:

//This will generate a blank public/docs folder
jsdoc: {
    dist : {
        src: './jsdoc.json'
        options: {
            destination: 'public/docs'
        }
    }
}

我希望能够只引用 JSON 文件，并使其正常工作。目前，这样做不会产生错误，但除了在基本目录中创建一个空的 doc 文件夹外，它不会做任何事情。

jsdoc: {
    dist : {
        src: './jsdoc.json'
    }
}

我还验证了 jsdoc.json 文件是正确的 jsdoc -c jsdoc.json

Answer 1

您需要将 conf 文件放入 options 属性中。

jsdoc: {
   dist: {
     options: {
          configure: './jsdoc.json'
       }
   }
}