forked from serenity-js/serenity-js
-
Notifications
You must be signed in to change notification settings - Fork 0
/
.esdoc.js
38 lines (37 loc) · 1.52 KB
/
.esdoc.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
require('./.esdoc-patches');
const path = require('path');
module.exports = {
source: 'src',
includes: ['\\.ts$', '\\.js$'],
// excludes: ['^.nyc', '^lib', '^node_modules', '^spec'],
destination: './target/site',
plugins: [
{ name: 'esdoc-lint-plugin', option: {enable: true} },
{ name: 'esdoc-coverage-plugin', option: {enable: true} },
{ name: path.resolve(__dirname, './documentation/esdoc-typescript-plugin'), option: {
enable: true,
} },
{ name: path.resolve(__dirname, './documentation/esdoc-external-docs-plugin'), option: {
externals: 'node_modules/@serenity-js/*/target/site/exported.js',
enable: true,
} },
{ name: 'esdoc-accessor-plugin', option: {
enable: true,
access: ['public', 'protected'],
} },
{ name: 'esdoc-external-ecmascript-plugin', option: {enable: false} },
{ name: 'esdoc-undocumented-identifier-plugin', option: {enable: true} },
{ name: 'esdoc-unexported-identifier-plugin', option: {enable: false} },
{ name: 'esdoc-publish-html-plugin', option: {
enable: true,
template: 'node_modules/@documentation/esdoc-template/src'
}},
{ name: 'esdoc-type-inference-plugin', option: {enable: true} },
{ name: 'esdoc-integrate-test-plugin', option: {
enable: true,
source: './spec/',
interfaces: ['describe', 'it'],
includes: ['spec\\.ts$']
}},
],
};