Grunt JSDoc：使用jsdoc JSON文件

Question

我想设置一个Grunt任务来运行JSDoc。我正在使用JSDoc npm页面推荐的grunt-jsdoc。它工作正常，但我不能使用我创建的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文件，并让它工作。目前，执行此操作不会产生错误，但除了在基本目录中创建空文档文件夹之外，它不会执行任何操作。

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

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

Answer 1

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

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