Skip to content

Commit a29a062

Browse files
committed
Add ESDoc to the core module
1 parent ff378ab commit a29a062

File tree

7 files changed

+1638
-18
lines changed

7 files changed

+1638
-18
lines changed

core/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,4 +16,6 @@ docs/build
1616
coverage
1717
.vscode
1818
/types
19+
/docs
20+
/lib6
1921
*.code-workspace

core/.npmignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,5 +2,6 @@ docs/
22
src/
33
build/
44
test/
5+
lib6/
56
.gitignore
67
node_modules/

core/esdoc.json

Lines changed: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
{
2+
"source": "./lib6",
3+
"destination": "./docs",
4+
"includes": ["\\.js$"],
5+
"excludes": ["external", "internal"],
6+
"package": "./package.json",
7+
"plugins": [
8+
{
9+
"name": "esdoc-importpath-plugin",
10+
"option": {
11+
"replaces": [
12+
{
13+
"from": "^lib6/",
14+
"to": "lib/"
15+
}
16+
]
17+
}
18+
},
19+
{
20+
"name": "esdoc-standard-plugin",
21+
"option": {
22+
"lint": {
23+
"enable": false
24+
},
25+
"accessor": {
26+
"access": ["public"],
27+
"autoPrivate": true
28+
},
29+
"undocumentIdentifier": {
30+
"enable": true
31+
},
32+
"unexportedIdentifier": {
33+
"enable": false
34+
},
35+
"typeInference": {
36+
"enable": true
37+
},
38+
"brand": {
39+
"title": "Neo4j Bolt Driver 4.1 for JavaScript",
40+
"repository": "https://github.com/neo4j/neo4j-javascript-driver"
41+
}
42+
}
43+
}
44+
]
45+
}

0 commit comments

Comments
 (0)