This is an automated email from the ASF dual-hosted git repository. ocket8888 pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/trafficcontrol-trafficops-types.git
commit 3c4d8e73f89cbdae93d5af7f868831893e549b19 Author: ocket8888 <[email protected]> AuthorDate: Wed Apr 27 22:21:27 2022 -0600 Add documentation generation --- .gitignore | 1 + package-lock.json | 8 ++++---- package.json | 4 +++- pnpm-lock.yaml | 60 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 68 insertions(+), 5 deletions(-) diff --git a/.gitignore b/.gitignore index 7780d45..d233cf7 100644 --- a/.gitignore +++ b/.gitignore @@ -2,3 +2,4 @@ node_modules/ *.sublime-* dist/ +docs/ diff --git a/package-lock.json b/package-lock.json index 2383c1e..16cfa6c 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,12 +1,12 @@ { - "name": "trafficcontrol", - "version": "1.0.0", + "name": "trafficops-types", + "version": "3.1.0-beta-2", "lockfileVersion": 2, "requires": true, "packages": { "": { - "name": "trafficcontrol", - "version": "1.0.0", + "name": "trafficops-types", + "version": "3.1.0-beta-2", "license": "ISC", "devDependencies": { "@typescript-eslint/eslint-plugin": "^5.0.0", diff --git a/package.json b/package.json index 3923e5d..e9f1837 100644 --- a/package.json +++ b/package.json @@ -7,7 +7,8 @@ "test": "echo \"Error: no test specified\" && exit 1", "build": "tsc", "lint": "eslint --ext .ts .", - "clean": "rm -rf dist" + "clean": "rm -rf dist", + "doc": "typedoc --includeVersion --readme ./README.md src/index.ts" }, "keywords": [], "author": "", @@ -19,6 +20,7 @@ "eslint-plugin-import": "^2.25.2", "eslint-plugin-jsdoc": "^36.1.1", "eslint-plugin-prefer-arrow": "^1.2.3", + "typedoc": "^0.22.15", "typescript": "^4.4.4" } } diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml index 4cfd68b..8802b37 100644 --- a/pnpm-lock.yaml +++ b/pnpm-lock.yaml @@ -7,6 +7,7 @@ specifiers: eslint-plugin-import: ^2.25.2 eslint-plugin-jsdoc: ^36.1.1 eslint-plugin-prefer-arrow: ^1.2.3 + typedoc: ^0.22.15 typescript: ^4.4.4 devDependencies: @@ -16,6 +17,7 @@ devDependencies: eslint-plugin-import: [email protected] eslint-plugin-jsdoc: [email protected] eslint-plugin-prefer-arrow: [email protected] + typedoc: [email protected] typescript: 4.4.4 packages: @@ -319,6 +321,12 @@ packages: concat-map: 0.0.1 dev: true + /brace-expansion/2.0.1: + resolution: {integrity: sha512-XnAIvQ8eM+kC6aULx6wuQiwVsnzsi9d3WxzV3FpWTGA19F621kwdbsAcFKXgKUHZWsy+mY6iL1sHTxWEFCytDA==} + dependencies: + balanced-match: 1.0.2 + dev: true + /braces/3.0.2: resolution: {integrity: sha512-b8um+L1RzM3WDSzvhm6gIz1yfTbBt6YTlcEKAvsmqCZZFw46z626lVj9j1yEPW33H5H+lBQpZMP1k8l+78Ha0A==} engines: {node: '>=8'} @@ -1051,6 +1059,10 @@ packages: minimist: 1.2.5 dev: true + /jsonc-parser/3.0.0: + resolution: {integrity: sha512-fQzRfAbIBnR0IQvftw9FJveWiHp72Fg20giDrHz6TdfB12UH/uue0D3hm57UB5KgAVuniLMCaS8P1IMj9NR7cA==} + dev: true + /levn/0.4.1: resolution: {integrity: sha512-+bT2uH4E5LGE7h/n3evcS/sQlJXCpIp6ym8OWJ5eV6+67Dsql/LaaT7qJBAt2rzfoa/5QBGBhxDix1dMt2kQKQ==} engines: {node: '>= 0.8.0'} @@ -1090,6 +1102,16 @@ packages: yallist: 4.0.0 dev: true + /lunr/2.3.9: + resolution: {integrity: sha512-zTU3DaZaF3Rt9rhN3uBMGQD3dD2/vFQqnvZCDv4dl5iOzq2IZQqTxu90r4E5J+nP70J3ilqVCrbho2eWaeW8Ow==} + dev: true + + /marked/4.0.14: + resolution: {integrity: sha512-HL5sSPE/LP6U9qKgngIIPTthuxC0jrfxpYMZ3LdGDD3vTnLs59m2Z7r6+LNDR3ToqEQdkKd6YaaEfJhodJmijQ==} + engines: {node: '>= 12'} + hasBin: true + dev: true + /merge2/1.4.1: resolution: {integrity: sha512-8q7VEgMJW4J8tcfVPy8g09NcQwZdbwFEqhe/WZkoIzjn/3TGDwtOCYtXGxA3O8tPzpczCCDgv+P2P5y00ZJOOg==} engines: {node: '>= 8'} @@ -1109,6 +1131,13 @@ packages: brace-expansion: 1.1.11 dev: true + /minimatch/5.0.1: + resolution: {integrity: sha512-nLDxIFRyhDblz3qMuq+SoRZED4+miJ/G+tdDrjkkkRnjAsBexeGpgjLEQ0blJy7rHhR2b93rhQY4SvyWu9v03g==} + engines: {node: '>=10'} + dependencies: + brace-expansion: 2.0.1 + dev: true + /minimist/1.2.5: resolution: {integrity: sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==} dev: true @@ -1321,6 +1350,14 @@ packages: engines: {node: '>=8'} dev: true + /shiki/0.10.1: + resolution: {integrity: sha512-VsY7QJVzU51j5o1+DguUd+6vmCmZ5v/6gYu4vyYAhzjuNQU6P/vmSy4uQaOhvje031qQMiW0d2BwgMH52vqMng==} + dependencies: + jsonc-parser: 3.0.0 + vscode-oniguruma: 1.6.2 + vscode-textmate: 5.2.0 + dev: true + /side-channel/1.0.4: resolution: {integrity: sha512-q5XPytqFEIKHkGdiMIrY10mvLRvnQh42/+GoBlFW3b2LXLE2xxJpZFdm94we0BaoV3RwJyGqg5wS7epxTv0Zvw==} dependencies: @@ -1474,6 +1511,21 @@ packages: engines: {node: '>=10'} dev: true + /typedoc/[email protected]: + resolution: {integrity: sha512-CMd1lrqQbFvbx6S9G6fL4HKp3GoIuhujJReWqlIvSb2T26vGai+8Os3Mde7Pn832pXYemd9BMuuYWhFpL5st0Q==} + engines: {node: '>= 12.10.0'} + hasBin: true + peerDependencies: + typescript: 4.0.x || 4.1.x || 4.2.x || 4.3.x || 4.4.x || 4.5.x || 4.6.x + dependencies: + glob: 7.2.0 + lunr: 2.3.9 + marked: 4.0.14 + minimatch: 5.0.1 + shiki: 0.10.1 + typescript: 4.4.4 + dev: true + /typescript/4.4.4: resolution: {integrity: sha512-DqGhF5IKoBl8WNf8C1gu8q0xZSInh9j1kJJMqT3a94w1JzVaBU4EXOSMrz9yDqMT0xt3selp83fuFMQ0uzv6qA==} engines: {node: '>=4.2.0'} @@ -1499,6 +1551,14 @@ packages: resolution: {integrity: sha512-l8lCEmLcLYZh4nbunNZvQCJc5pv7+RCwa8q/LdUx8u7lsWvPDKmpodJAJNwkAhJC//dFY48KuIEmjtd4RViDrA==} dev: true + /vscode-oniguruma/1.6.2: + resolution: {integrity: sha512-KH8+KKov5eS/9WhofZR8M8dMHWN2gTxjMsG4jd04YhpbPR91fUj7rYQ2/XjeHCJWbg7X++ApRIU9NUwM2vTvLA==} + dev: true + + /vscode-textmate/5.2.0: + resolution: {integrity: sha512-Uw5ooOQxRASHgu6C7GVvUxisKXfSgW4oFlO+aa+PAkgmH89O3CXxEEzNRNtHSqtXFTl0nAC1uYj0GMSH27uwtQ==} + dev: true + /which-boxed-primitive/1.0.2: resolution: {integrity: sha512-bwZdv0AKLpplFY2KZRX6TvyuN7ojjr7lwkg6ml0roIy9YeuSr7JS372qlNW18UQYzgYK9ziGcerWqZOmEn9VNg==} dependencies:
