Browse Source

Add TSDoc and TypeDoc to handle documentation

trunk v0.4.2
Kevin Hoerr 10 months ago
parent
commit
00ee6f4991
Signed by: kjhoerr GPG Key ID: 78E4BD33ACC22C86
7 changed files with 169 additions and 5 deletions
  1. +1
    -0
      .dockerignore
  2. +5
    -1
      .eslintrc.json
  3. +1
    -0
      .gitignore
  4. +4
    -0
      CHANGELOG.md
  5. +143
    -1
      package-lock.json
  6. +7
    -3
      package.json
  7. +8
    -0
      tsconfig.json

+ 1
- 0
.dockerignore View File

@ -2,6 +2,7 @@
.vscode
build
coverage
docs
example_reports
.env*
dist

+ 5
- 1
.eslintrc.json View File

@ -1,6 +1,9 @@
{
"parser": "@typescript-eslint/parser",
"plugins": ["@typescript-eslint"],
"plugins": [
"@typescript-eslint",
"eslint-plugin-tsdoc"
],
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/eslint-recommended",
@ -10,6 +13,7 @@
],
"rules": {
"no-var": "error",
"tsdoc/syntax": "warn",
"no-constant-condition": "off"
}
}

+ 1
- 0
.gitignore View File

@ -2,6 +2,7 @@ node_modules
dist
build
coverage
docs
.vscode
tsconfig.tsbuildinfo
.env*


+ 4
- 0
CHANGELOG.md View File

@ -7,9 +7,12 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
## [Unreleased]
## [0.4.2]
### Added
- 404 page to handle unknown paths
- TSDoc and TypeDoc to generate documentation
### Changed
@ -113,6 +116,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
- Code formatting using Prettier
[unreleased]: https://git.submelon.dev/kjhoerr/ao-coverage/src/branch/trunk
[0.4.1]: https://git.submelon.dev/kjhoerr/ao-coverage/src/tag/v0.4.2
[0.4.1]: https://git.submelon.dev/kjhoerr/ao-coverage/src/tag/v0.4.1
[0.4.0]: https://git.submelon.dev/kjhoerr/ao-coverage/src/tag/v0.4.0
[0.3.3]: https://git.submelon.dev/kjhoerr/ao-coverage/src/tag/v0.3.3


+ 143
- 1
package-lock.json View File

@ -1,6 +1,6 @@
{
"name": "ao-coverage",
"version": "0.4.1",
"version": "0.4.3",
"lockfileVersion": 1,
"requires": true,
"dependencies": {
@ -920,6 +920,35 @@
}
}
},
"@microsoft/tsdoc": {
"version": "0.12.19",
"resolved": "https://registry.npmjs.org/@microsoft/tsdoc/-/tsdoc-0.12.19.tgz",
"integrity": "sha512-IpgPxHrNxZiMNUSXqR1l/gePKPkfAmIKoDRP9hp7OwjU29ZR8WCJsOJ8iBKgw0Qk+pFwR+8Y1cy8ImLY6e9m4A==",
"dev": true
},
"@microsoft/tsdoc-config": {
"version": "0.13.3",
"resolved": "https://registry.npmjs.org/@microsoft/tsdoc-config/-/tsdoc-config-0.13.3.tgz",
"integrity": "sha512-6v2JUsfQIr2KStZgRusIuJmNvXX/xZMkzXA9YKY99hpj7uuAeAsHeKTe07D8t7hKlz79qCZMmg6ptJ55dYP9Xg==",
"dev": true,
"requires": {
"@microsoft/tsdoc": "0.12.19",
"ajv": "~6.10.2",
"jju": "~1.4.0",
"resolve": "~1.12.0"
},
"dependencies": {
"resolve": {
"version": "1.12.3",
"resolved": "https://registry.npmjs.org/resolve/-/resolve-1.12.3.tgz",
"integrity": "sha512-hF6+hAPlxjqHWrw4p1rF3Wztbgxd4AjA5VlUzY5zcTb4J8D3JK4/1RjU48pHz2PJWzGVsLB1VWZkvJzhK2CCOA==",
"dev": true,
"requires": {
"path-parse": "^1.0.6"
}
}
}
},
"@sinonjs/commons": {
"version": "1.7.2",
"resolved": "https://registry.npmjs.org/@sinonjs/commons/-/commons-1.7.2.tgz",
@ -2455,6 +2484,16 @@
"prettier-linter-helpers": "^1.0.0"
}
},
"eslint-plugin-tsdoc": {
"version": "0.2.4",
"resolved": "https://registry.npmjs.org/eslint-plugin-tsdoc/-/eslint-plugin-tsdoc-0.2.4.tgz",
"integrity": "sha512-iUHb4SkithNERIfrHGWAdsR0cjHplF9F9Mop4cnDSplAw/0oKyPb9eDjcqwFfO4E2pz+JLv24TzgM7gFAGqO9A==",
"dev": true,
"requires": {
"@microsoft/tsdoc": "0.12.19",
"@microsoft/tsdoc-config": "0.13.3"
}
},
"eslint-scope": {
"version": "5.0.0",
"resolved": "https://registry.npmjs.org/eslint-scope/-/eslint-scope-5.0.0.tgz",
@ -2960,6 +2999,17 @@
"integrity": "sha1-g8YK/Fi5xWmXAH7Rp2izqzA6RP4=",
"dev": true
},
"fs-extra": {
"version": "8.1.0",
"resolved": "https://registry.npmjs.org/fs-extra/-/fs-extra-8.1.0.tgz",
"integrity": "sha512-yhlQgA6mnOJUKOsRUFsgJdQCvkKhcz8tlZG5HBQfReYZy46OwLcY+Zia0mtdHsOo9y/hP+CxMN0TU9QxoOtG4g==",
"dev": true,
"requires": {
"graceful-fs": "^4.2.0",
"jsonfile": "^4.0.0",
"universalify": "^0.1.0"
}
},
"fs.realpath": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/fs.realpath/-/fs.realpath-1.0.0.tgz",
@ -3155,6 +3205,12 @@
}
}
},
"highlight.js": {
"version": "10.0.1",
"resolved": "https://registry.npmjs.org/highlight.js/-/highlight.js-10.0.1.tgz",
"integrity": "sha512-l1HB5S9nmBuvurFIOPbpeJv4psKh2MyKCTOYRK/E6dwRXkbG96PLH7amP/xpGNyZOK8OWqv45DxLS/ZAIb3n9w==",
"dev": true
},
"hosted-git-info": {
"version": "2.8.8",
"resolved": "https://registry.npmjs.org/hosted-git-info/-/hosted-git-info-2.8.8.tgz",
@ -3296,6 +3352,12 @@
}
}
},
"interpret": {
"version": "1.2.0",
"resolved": "https://registry.npmjs.org/interpret/-/interpret-1.2.0.tgz",
"integrity": "sha512-mT34yGKMNceBQUoVn7iCDKDntA7SC6gycMAWzGx1z/CMCTV7b2AAtXlo3nRyHZ1FelRkQbQjprHSYGwzLtkVbw==",
"dev": true
},
"ip-regex": {
"version": "2.1.0",
"resolved": "https://registry.npmjs.org/ip-regex/-/ip-regex-2.1.0.tgz",
@ -4823,6 +4885,12 @@
}
}
},
"jju": {
"version": "1.4.0",
"resolved": "https://registry.npmjs.org/jju/-/jju-1.4.0.tgz",
"integrity": "sha1-o6vicYryQaKykE+EpiWXDzia4yo=",
"dev": true
},
"js-tokens": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/js-tokens/-/js-tokens-4.0.0.tgz",
@ -4927,6 +4995,15 @@
"minimist": "^1.2.5"
}
},
"jsonfile": {
"version": "4.0.0",
"resolved": "https://registry.npmjs.org/jsonfile/-/jsonfile-4.0.0.tgz",
"integrity": "sha1-h3Gq4HmbZAdrdmQPygWPnBDjPss=",
"dev": true,
"requires": {
"graceful-fs": "^4.1.6"
}
},
"jsprim": {
"version": "1.4.1",
"resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz",
@ -5042,6 +5119,12 @@
"yallist": "^2.1.2"
}
},
"lunr": {
"version": "2.3.8",
"resolved": "https://registry.npmjs.org/lunr/-/lunr-2.3.8.tgz",
"integrity": "sha512-oxMeX/Y35PNFuZoHp+jUj5OSEmLCaIH4KTFJh7a93cHBoFmpw2IoPs22VIz7vyO2YUnx2Tn9dzIwO2P/4quIRg==",
"dev": true
},
"make-dir": {
"version": "3.1.0",
"resolved": "https://registry.npmjs.org/make-dir/-/make-dir-3.1.0.tgz",
@ -5087,6 +5170,12 @@
"object-visit": "^1.0.0"
}
},
"marked": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/marked/-/marked-1.0.0.tgz",
"integrity": "sha512-Wo+L1pWTVibfrSr+TTtMuiMfNzmZWiOPeO7rZsQUY5bgsxpHesBEcIWJloWVTFnrMXnf/TL30eTFSGJddmQAng==",
"dev": true
},
"media-typer": {
"version": "0.3.0",
"resolved": "https://registry.npmjs.org/media-typer/-/media-typer-0.3.0.tgz",
@ -5791,6 +5880,15 @@
"integrity": "sha512-v1SEYUOXXdbBZK8ZuNgO4TBjamPsiSgcFr0aP+tEKpQZK8vooEUqV6nm6Cv502mX4NF2EfsnVqtNAHG+/6Ur1Q==",
"dev": true
},
"rechoir": {
"version": "0.6.2",
"resolved": "https://registry.npmjs.org/rechoir/-/rechoir-0.6.2.tgz",
"integrity": "sha1-hSBLVNuoLVdC4oyWdW70OvUOM4Q=",
"dev": true,
"requires": {
"resolve": "^1.1.6"
}
},
"regex-not": {
"version": "1.0.2",
"resolved": "https://registry.npmjs.org/regex-not/-/regex-not-1.0.2.tgz",
@ -6292,6 +6390,17 @@
"integrity": "sha1-2kL0l0DAtC2yypcoVxyxkMmO/qM=",
"dev": true
},
"shelljs": {
"version": "0.8.4",
"resolved": "https://registry.npmjs.org/shelljs/-/shelljs-0.8.4.tgz",
"integrity": "sha512-7gk3UZ9kOfPLIAbslLzyWeGiEqx9e3rxwZM0KE6EL8GlGwjym9Mrlx5/p33bWTu9YG6vcS4MBxYZDHYr5lr8BQ==",
"dev": true,
"requires": {
"glob": "^7.0.0",
"interpret": "^1.0.0",
"rechoir": "^0.6.2"
}
},
"shellwords": {
"version": "0.1.1",
"resolved": "https://registry.npmjs.org/shellwords/-/shellwords-0.1.1.tgz",
@ -7161,6 +7270,33 @@
"is-typedarray": "^1.0.0"
}
},
"typedoc": {
"version": "0.17.6",
"resolved": "https://registry.npmjs.org/typedoc/-/typedoc-0.17.6.tgz",
"integrity": "sha512-pQiYnhG3yJk7939cv2n8uFoTsSgy5Hfiw0dgOQYa9nT9Ya1013dMctQdAXMj8JbNu7KhcauQyq9Zql9D/TziLw==",
"dev": true,
"requires": {
"fs-extra": "^8.1.0",
"handlebars": "^4.7.6",
"highlight.js": "^10.0.0",
"lodash": "^4.17.15",
"lunr": "^2.3.8",
"marked": "1.0.0",
"minimatch": "^3.0.0",
"progress": "^2.0.3",
"shelljs": "^0.8.4",
"typedoc-default-themes": "^0.10.1"
}
},
"typedoc-default-themes": {
"version": "0.10.1",
"resolved": "https://registry.npmjs.org/typedoc-default-themes/-/typedoc-default-themes-0.10.1.tgz",
"integrity": "sha512-SuqAQI0CkwhqSJ2kaVTgl37cWs733uy9UGUqwtcds8pkFK8oRF4rZmCq+FXTGIb9hIUOu40rf5Kojg0Ha6akeg==",
"dev": true,
"requires": {
"lunr": "^2.3.8"
}
},
"typescript": {
"version": "3.8.3",
"resolved": "https://registry.npmjs.org/typescript/-/typescript-3.8.3.tgz",
@ -7187,6 +7323,12 @@
"set-value": "^2.0.1"
}
},
"universalify": {
"version": "0.1.2",
"resolved": "https://registry.npmjs.org/universalify/-/universalify-0.1.2.tgz",
"integrity": "sha512-rBJeI5CXAlmy1pV+617WB9J63U6XcazHHF2f2dbJix4XzpUF0RS3Zbj0FGIOCAva5P/d/GBOYaACQ1w+0azUkg==",
"dev": true
},
"unpipe": {
"version": "1.0.0",
"resolved": "https://registry.npmjs.org/unpipe/-/unpipe-1.0.0.tgz",


+ 7
- 3
package.json View File

@ -1,6 +1,6 @@
{
"name": "ao-coverage",
"version": "0.4.1",
"version": "0.4.2",
"description": "Simple code coverage storage and server",
"repository": {
"type": "git",
@ -16,7 +16,8 @@
"lint:fix": "eslint --fix 'src/**/*.ts'",
"test": "jest",
"test:coverage": "jest --coverage",
"tsc": "tsc"
"tsc": "tsc",
"doc": "typedoc src"
},
"author": "Kevin J Hoerr <kjhoerr@submelon.tech>",
"license": "Parity-7.0.0",
@ -35,6 +36,7 @@
"winston": "^3.2.1"
},
"devDependencies": {
"@microsoft/tsdoc": "^0.12.19",
"@types/jest": "^25.2.1",
"@types/supertest": "^2.0.8",
"@types/triple-beam": "^1.3.0",
@ -43,12 +45,14 @@
"eslint": "^6.8.0",
"eslint-config-prettier": "^6.11.0",
"eslint-plugin-prettier": "^3.1.3",
"eslint-plugin-tsdoc": "^0.2.4",
"jest": "^25.4.0",
"prettier": "^1.19.1",
"supertest": "^4.0.2",
"triple-beam": "^1.3.0",
"ts-jest": "^25.4.0",
"tsc-watch": "^4.2.3"
"tsc-watch": "^4.2.3",
"typedoc": "^0.17.6"
},
"jest": {
"preset": "ts-jest",


+ 8
- 0
tsconfig.json View File

@ -62,5 +62,13 @@
/* Advanced Options */
"forceConsistentCasingInFileNames": true /* Disallow inconsistently-cased references to the same file. */
},
"typedocOptions": {
"inputFiles": ["./src"],
"exclude": ["**/*.test.ts"],
"out": "docs",
"mode": "modules",
"includeVersion": true,
"excludePrivate": true,
}
}

Loading…
Cancel
Save