Grunt JSDoc: использовать jsdoc JSON файл

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 и поместить их в Грунте, у меня нет никаких проблем:

//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

Вам нужно поместить файл конф в собственность опций.

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