Skip to content

Commit

Permalink
fix(api): auto-update API docs in README
Browse files Browse the repository at this point in the history
  • Loading branch information
thibaudcolas committed Jan 23, 2019
1 parent 60885b3 commit aa40707
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 4 deletions.
1 change: 1 addition & 0 deletions .githooks/pre-commit.6.lint.sh
Original file line number Diff line number Diff line change
Expand Up @@ -3,4 +3,5 @@
if [ -n "$JS_STAGED" ];
then
npx eslint $JS_STAGED
npx documentation lint $JS_STAGED
fi
6 changes: 2 additions & 4 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -76,12 +76,10 @@
"report:coverage": "open coverage/lcov-report/index.html",
"report:build": "open public/source-map-explorer.html",
"report:package": "npm pack --loglevel notice 2>&1 >/dev/null | sed -e 's/^npm notice //' | tee build/package.txt && rm *.tgz",
"lint": "prettier --check '**/*.{js,css,md,json,yaml,yml,html}'",
"lint": "prettier --check '**/*.{js,css,md,json,yaml,yml,html}' && documentation lint src/**",
"format": "prettier --write '**/*.{js,css,md,json,yaml,yml,html}'",
"test:ci": "npm run lint -s && npm run dist -s && flow && npm run test:coverage -s -- --outputFile build/test-results.json --json",
"prepublishOnly": "npm run dist -s",
"docs:generate:html": "documentation build src/lib/** -f htmk -o docs",
"docs:generate:md": "documentation build src/lib/** -f md -o docs/doc.md",
"docs:serve": "documentation serve src/lib/**"
"build:docs": "documentation readme src/lib/index.js -f md > docs/doc.md --section=API --markdown-toc=false && prettier --write README.md"
}
}

0 comments on commit aa40707

Please sign in to comment.