/
jsdoc2md.js
90 lines (89 loc) · 3.72 KB
/
jsdoc2md.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
/**
* © 2020, db-developer.
* Licensed under the MIT license.
*/
// Note: This is used for running tests only!
module.exports = function ( grunt, options ) {
return {
target0: {
// multiple source files to directory with multiple markdown files
src: "src/lib/**/*.js",
dest: "docs/api/",
options: {
index: {
dest: "docs/api.index.md",
template: undefined
}
}
},
target1: {
// multiple source files to directory with multiple markdown files
src: "src/lib/**/*.js",
dest: "src/test/tmp/",
options: {
index: {
dest: "src/test/tmp/target1/api.md",
template: undefined
}
}
},
target2: {
options: {
index: {
dest: "src/test/tmp/target2/api.md",
template: "src/test/templates/api.hbs" // test if templating works
}
},
files: [
// single source file to single markdown file
{ src: 'src/lib/tasks/jsdoc2md.js', dest: 'src/test/tmp/api/tofile/1/jsdoc2md.md' },
// missing source file ... producing no output but a warning message
{ src: 'src/does.not.exist.js', dest: 'src/test/tmp/api/tofile/2/missing.src.md' },
// multiple source files to single (aggregated) markdown file
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/3/aggregated.api.md' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/4/' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/test/templates/**/*.js', dest: 'src/test/tmp/api/tofile/5/' }
]
},
target3: {
options: {
index: false // test if setting index to false works
},
files: [
// single source file to single markdown file
{ src: 'src/lib/tasks/jsdoc2md.js', dest: 'src/test/tmp/api/tofile/6/jsdoc2md.md' },
// missing source file ... producing no output but a warning message
{ src: 'src/does.not.exist.js', dest: 'src/test/tmp/api/tofile/7/missing.src.md' },
// multiple source files to single (aggregated) markdown file
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/8/aggregated.api.md' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/9/' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/test/templates/**/*.js', dest: 'src/test/tmp/api/tofile/10/' }
]
},
target4: { // test settings without options
files: [
// single source file to single markdown file
{ src: 'src/lib/tasks/jsdoc2md.js', dest: 'src/test/tmp/api/tofile/11/jsdoc2md.md' },
// missing source file ... producing no output but a warning message
{ src: 'src/does.not.exist.js', dest: 'src/test/tmp/api/tofile/12/missing.src.md' },
// multiple source files to single (aggregated) markdown file
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/13/aggregated.api.md' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/lib/**/*.js', dest: 'src/test/tmp/api/tofile/14/' },
// multiple source files to directory creating multiple markdown files
{ src: 'src/test/templates/**/*.js', dest: 'src/test/tmp/api/tofile/15/' }
]
},
target5: {
dest: "build",
files: [
{ src: 'src/lib/constants.js' },
{ src: 'src/**/*.js' }
]
}
};
};