Skip to content

Commit bfd1b4d

Browse files
committed
Add jsdoc
* add dependency jsdoc * create jsdoc npm script * ignore jsdoc output
1 parent 04dfbbc commit bfd1b4d

File tree

5 files changed

+170
-0
lines changed

5 files changed

+170
-0
lines changed

.eslintignore

+1
Original file line numberDiff line numberDiff line change
@@ -2,3 +2,4 @@ coverage/*
22
dist/*
33
test/*-test.js
44
site/*
5+
out/*

.gitignore

+1
Original file line numberDiff line numberDiff line change
@@ -4,3 +4,4 @@ site/
44
coverage/
55
dist/
66
.nyc_output/
7+
out

jsdoc.conf.json

+18
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,18 @@
1+
{
2+
"plugins": ["plugins/markdown"],
3+
"recurseDepth": 10,
4+
"source": {
5+
"include": "lib/",
6+
"includePattern": ".+\\.js(doc)?$",
7+
"excludePattern": "(^|\\/|\\\\)_"
8+
},
9+
"sourceType": "module",
10+
"tags": {
11+
"allowUnknownTags": true,
12+
"dictionaries": ["jsdoc","closure"]
13+
},
14+
"templates": {
15+
"cleverLinks": false,
16+
"monospaceLinks": false
17+
}
18+
}

package-lock.json

+148
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

package.json

+2
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
"build": "run-s build:dist-folder build:bundle",
1919
"build:bundle": "rollup -c > dist/samsam.js",
2020
"build:dist-folder": "mkdirp dist",
21+
"jsdoc": "jsdoc -c jsdoc.conf.json",
2122
"lint": "eslint .",
2223
"prepublishOnly": "npm run build && mkdocs gh-deploy -r upstream || mkdocs gh-deploy -r origin",
2324
"test": "mocha ./lib/*.test.js",
@@ -47,6 +48,7 @@
4748
"eslint-plugin-mocha": "^6.0.0",
4849
"eslint-plugin-prettier": "^3.1.0",
4950
"husky": "^0.14.3",
51+
"jsdoc": "^3.6.3",
5052
"jsdom": "^13.0.0",
5153
"jsdom-global": "^3.0.2",
5254
"lint-staged": "^6.1.0",

0 commit comments

Comments
 (0)