| 1441 |
ariadna |
1 |
// This file is part of Moodle - http://moodle.org/
|
|
|
2 |
//
|
|
|
3 |
// Moodle is free software: you can redistribute it and/or modify
|
|
|
4 |
// it under the terms of the GNU General Public License as published by
|
|
|
5 |
// the Free Software Foundation, either version 3 of the License, or
|
|
|
6 |
// (at your option) any later version.
|
|
|
7 |
//
|
|
|
8 |
// Moodle is distributed in the hope that it will be useful,
|
|
|
9 |
// but WITHOUT ANY WARRANTY; without even the implied warranty of
|
|
|
10 |
// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
|
|
|
11 |
// GNU General Public License for more details.
|
|
|
12 |
//
|
|
|
13 |
// You should have received a copy of the GNU General Public License
|
|
|
14 |
// along with Moodle. If not, see <http://www.gnu.org/licenses/>.
|
|
|
15 |
/* jshint node: true, browser: false */
|
|
|
16 |
/* eslint-env node */
|
|
|
17 |
|
|
|
18 |
/**
|
|
|
19 |
* @copyright 2021 Andrew Nicols
|
|
|
20 |
* @license http://www.gnu.org/copyleft/gpl.html GNU GPL v3 or later
|
|
|
21 |
*/
|
|
|
22 |
|
|
|
23 |
module.exports = (grunt) => {
|
|
|
24 |
const path = require('path');
|
|
|
25 |
|
|
|
26 |
grunt.registerTask('jsdoc', 'Generate JavaScript documentation using jsdoc', function() {
|
|
|
27 |
const done = this.async();
|
|
|
28 |
const configuration = path.resolve('.grunt/jsdoc/jsdoc.conf.js');
|
|
|
29 |
|
|
|
30 |
grunt.util.spawn({
|
|
|
31 |
cmd: 'jsdoc',
|
|
|
32 |
args: [
|
|
|
33 |
'--configure',
|
|
|
34 |
configuration,
|
|
|
35 |
]
|
|
|
36 |
}, function(error, result, code) {
|
|
|
37 |
if (result.stdout) {
|
|
|
38 |
grunt.log.write(result.stdout);
|
|
|
39 |
}
|
|
|
40 |
|
|
|
41 |
if (result.stderr) {
|
|
|
42 |
grunt.log.error(result.stderr);
|
|
|
43 |
}
|
|
|
44 |
if (error) {
|
|
|
45 |
grunt.fail.fatal(`JSDoc failed with error code ${code}`);
|
|
|
46 |
} else {
|
|
|
47 |
grunt.log.write('JSDoc completed successfully'.green);
|
|
|
48 |
}
|
|
|
49 |
done();
|
|
|
50 |
});
|
|
|
51 |
});
|
|
|
52 |
};
|