Skip to content
This repository has been archived by the owner on Jun 11, 2024. It is now read-only.

Commit

Permalink
Update TypeDoc version (#8352)
Browse files Browse the repository at this point in the history 
* Update package.json

* Update typedoc.json

* Add typedoc.json for transactions & validator pkgs

* Add package-specific typedoc.json files, update package.json

* Update typedoc.json

* ♻️ Update yarn.lock

---------

Co-authored-by: shuse2 <[email protected]>
  • Loading branch information
@Tschakki @shuse2
Tschakki and shuse2 authored Apr 14, 2023
1 parent fe66827 commit 3689671
Show file tree
Hide file tree
Showing 35 changed files with 173 additions and 98 deletions.
5 changes: 0 additions & 5 deletions commander/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist/index.js",
"bin": {
"lisk": "./bin/run"
Expand Down
7 changes: 7 additions & 0 deletions commander/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-api-client/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-api-client/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-chain/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-chain/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-codec/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-codec/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-cryptography/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-cryptography/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-p2p/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-p2p/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-passphrase/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-passphrase/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-transaction-pool/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"typings": "dist-node/index.d.ts",
"scripts": {
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-transaction-pool/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-transactions/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-transactions/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-tree/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-tree/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-utils/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -20,11 +20,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-utils/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions elements/lisk-validator/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -21,11 +21,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"clean": "./scripts/clean.sh",
Expand Down
7 changes: 7 additions & 0 deletions elements/lisk-validator/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
6 changes: 6 additions & 0 deletions framework-plugins/lisk-framework-chain-connector-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"tsconfig": "./tsconfig.json"
}
7 changes: 7 additions & 0 deletions framework-plugins/lisk-framework-dashboard-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
7 changes: 7 additions & 0 deletions framework-plugins/lisk-framework-faucet-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
7 changes: 7 additions & 0 deletions framework-plugins/lisk-framework-forger-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
7 changes: 7 additions & 0 deletions framework-plugins/lisk-framework-monitor-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
7 changes: 7 additions & 0 deletions framework-plugins/lisk-framework-report-misbehavior-plugin/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
5 changes: 0 additions & 5 deletions framework/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -23,11 +23,6 @@
"node": ">=16.14.1 <=16",
"npm": ">=8.1.0"
},
"typedoc": {
"entryPoint": "./src/index.ts",
"readmeFile": "./README.md",
"tsconfig": "./tsconfig.json"
},
"main": "dist-node/index.js",
"scripts": {
"start": "node src/index.js",
Expand Down
7 changes: 7 additions & 0 deletions framework/typedoc.json
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,7 @@
{
"$schema": "https://typedoc.org/schema.json",
"includeVersion": true,
"entryPoints": ["src/index.ts"],
"readme": "./README.md",
"tsconfig": "./tsconfig.json"
}
3 changes: 1 addition & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -77,8 +77,7 @@
"path-browserify": "^1.0.0",
"prettier": "2.8.0",
"stream-browserify": "3.0.0",
"typedoc": "0.23.23",
"typedoc-plugin-resolve-crossmodule-references": "0.3.3",
"typedoc": "0.24.1",
"typescript": "5.0.2",
"yarn": "1.22.19"
},
Expand Down
3 changes: 2 additions & 1 deletion typedoc.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,12 @@
"commander",
"framework",
"framework-plugins/lisk-framework-dashboard-plugin",
"framework-plugins/lisk-framework-chain-connector-plugin",
"framework-plugins/lisk-framework-forger-plugin",
"framework-plugins/lisk-framework-faucet-plugin",
"framework-plugins/lisk-framework-report-misbehavior-plugin",
"framework-plugins/lisk-framework-monitor-plugin"
],
"skipErrorChecking": true,
"out": "docs/typedoc",
"name": "Lisk SDK",
"includeVersion": true
Expand Down
Loading

0 comments on commit 3689671

Please sign in to comment.