Skip to content

Commit

Permalink
Add jsdoc to package json and test/build tasks
Browse files Browse the repository at this point in the history
  • Loading branch information
paulkaplan committed Jul 31, 2018
1 parent c7db7ad commit 5a429d9
Show file tree
Hide file tree
Showing 2 changed files with 25 additions and 2 deletions.
20 changes: 20 additions & 0 deletions .jsdoc.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
{
"plugins": ["plugins/markdown"],
"templates": {
"default": {
"includeDate": false,
"outputSourceFiles": false
}
},
"source": {
"include": ["src"]
},
"opts": {
"destination": "playground/docs",
"pedantic": true,
"private": true,
"readme": "README.md",
"recurse": true,
"template": "node_modules/docdash"
}
}
7 changes: 5 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,10 @@
"main": "./dist/node/scratch-vm.js",
"browser": "./src/index.js",
"scripts": {
"build": "webpack --progress --colors --bail",
"build": "npm run docs && webpack --progress --colors --bail",
"coverage": "tap ./test/{unit,integration}/*.js --coverage --coverage-report=lcov",
"deploy": "touch playground/.nojekyll && gh-pages -t -d playground -m \"Build for $(git log --pretty=format:%H -n1)\"",
"docs": "jsdoc -c .jsdoc.json",
"extract:core": "mkdirp translations/core && format-message extract --out-file translations/core/en.json src/extensions/**/index.js",
"i18n:src": "npm run extract:core",
"lint": "eslint . && format-message lint src/**/*.js",
Expand All @@ -23,7 +24,7 @@
"tap": "tap ./test/{unit,integration}/*.js",
"tap:unit": "tap ./test/unit/*.js",
"tap:integration": "tap ./test/integration/*.js",
"test": "npm run lint && npm run tap",
"test": "npm run lint && npm run docs && npm run tap",
"watch": "webpack --progress --colors --watch",
"version": "json -f package.json -I -e \"this.repository.sha = '$(git log -n1 --pretty=format:%H)'\""
},
Expand Down Expand Up @@ -54,13 +55,15 @@
"babel-loader": "^7.0.0",
"babel-preset-env": "^1.6.1",
"copy-webpack-plugin": "^4.5.1",
"docdash": "^0.4.0",
"eslint": "^5.0.1",
"eslint-config-scratch": "^5.0.0",
"expose-loader": "0.7.5",
"file-loader": "^1.1.6",
"format-message-cli": "5.2.1",
"gh-pages": "^1.1.0",
"in-publish": "^2.0.0",
"jsdoc": "^3.5.5",
"json": "^9.0.4",
"lodash.defaultsdeep": "4.6.0",
"pngjs": "^3.3.2",
Expand Down

0 comments on commit 5a429d9

Please sign in to comment.