From 88b54028b3a2807e07eea965282ef6eb489ca369 Mon Sep 17 00:00:00 2001 From: acolytec3 Date: Thu, 13 Jul 2023 14:02:21 -0400 Subject: [PATCH] docs updates (#2887) --- config/{typedoc.js => typedoc.cjs} | 0 packages/block/package.json | 2 +- packages/block/{typedoc.js => typedoc.cjs} | 2 +- packages/blockchain/package.json | 2 +- packages/blockchain/{typedoc.js => typedoc.cjs} | 2 +- packages/client/package.json | 2 +- packages/client/{typedoc.js => typedoc.cjs} | 2 +- packages/common/package.json | 2 +- packages/common/{typedoc.js => typedoc.cjs} | 2 +- packages/devp2p/package.json | 2 +- packages/devp2p/{typedoc.js => typedoc.cjs} | 2 +- packages/ethash/package.json | 2 +- packages/ethash/{typedoc.js => typedoc.cjs} | 2 +- packages/evm/package.json | 2 +- packages/evm/{typedoc.js => typedoc.cjs} | 2 +- packages/genesis/package.json | 2 +- packages/{statemanager/typedoc.js => genesis/typedoc.cjs} | 2 +- packages/statemanager/package.json | 2 +- packages/{genesis/typedoc.js => statemanager/typedoc.cjs} | 2 +- packages/trie/package.json | 2 +- packages/{wallet/typedoc.js => trie/typedoc.cjs} | 2 +- packages/tx/package.json | 2 +- packages/tx/{typedoc.js => typedoc.cjs} | 2 +- packages/util/package.json | 2 +- packages/util/{typedoc.js => typedoc.cjs} | 2 +- packages/vm/package.json | 2 +- packages/vm/{typedoc.js => typedoc.cjs} | 2 +- packages/wallet/package.json | 2 +- packages/{trie/typedoc.js => wallet/typedoc.cjs} | 2 +- 29 files changed, 28 insertions(+), 28 deletions(-) rename config/{typedoc.js => typedoc.cjs} (100%) rename packages/block/{typedoc.js => typedoc.cjs} (73%) rename packages/blockchain/{typedoc.js => typedoc.cjs} (75%) rename packages/client/{typedoc.js => typedoc.cjs} (91%) rename packages/common/{typedoc.js => typedoc.cjs} (78%) rename packages/devp2p/{typedoc.js => typedoc.cjs} (77%) rename packages/ethash/{typedoc.js => typedoc.cjs} (73%) rename packages/evm/{typedoc.js => typedoc.cjs} (72%) rename packages/{statemanager/typedoc.js => genesis/typedoc.cjs} (69%) rename packages/{genesis/typedoc.js => statemanager/typedoc.cjs} (69%) rename packages/{wallet/typedoc.js => trie/typedoc.cjs} (69%) rename packages/tx/{typedoc.js => typedoc.cjs} (72%) rename packages/util/{typedoc.js => typedoc.cjs} (68%) rename packages/vm/{typedoc.js => typedoc.cjs} (78%) rename packages/{trie/typedoc.js => wallet/typedoc.cjs} (69%) diff --git a/config/typedoc.js b/config/typedoc.cjs similarity index 100% rename from config/typedoc.js rename to config/typedoc.cjs diff --git a/packages/block/package.json b/packages/block/package.json index 3388391a4e..0172d0da2b 100644 --- a/packages/block/package.json +++ b/packages/block/package.json @@ -33,7 +33,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- block", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/block/typedoc.js b/packages/block/typedoc.cjs similarity index 73% rename from packages/block/typedoc.js rename to packages/block/typedoc.cjs index 365638d9c4..e909b4e0c1 100644 --- a/packages/block/typedoc.js +++ b/packages/block/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'src/helpers.ts'], diff --git a/packages/blockchain/package.json b/packages/blockchain/package.json index 7ef7be7cbd..071b36a45c 100644 --- a/packages/blockchain/package.json +++ b/packages/blockchain/package.json @@ -33,7 +33,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- blockchain", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/blockchain/typedoc.js b/packages/blockchain/typedoc.cjs similarity index 75% rename from packages/blockchain/typedoc.js rename to packages/blockchain/typedoc.cjs index 18cbbfe7c1..dc7616cfd6 100644 --- a/packages/blockchain/typedoc.js +++ b/packages/blockchain/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'src/db/**', 'src/clique.ts'], diff --git a/packages/client/package.json b/packages/client/package.json index c4bc2b16ce..7e94b4e611 100644 --- a/packages/client/package.json +++ b/packages/client/package.json @@ -42,7 +42,7 @@ "client:start:dev1": "npm run client:start -- --discDns=false --discV4=false --bootnodes", "client:start:dev2": "npm run client:start -- --discDns=false --discV4=false --port=30304 --dataDir=datadir-dev2", "coverage": "c8 --all --reporter=lcov --reporter=text npm run test:unit", - "docs:build": "typedoc --options typedoc.js --tsconfig tsconfig.prod.cjs.json", + "docs:build": "typedoc --options typedoc.cjs --tsconfig tsconfig.prod.cjs.json", "examples": "ts-node ../../scripts/examples-runner.ts -- client", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/client/typedoc.js b/packages/client/typedoc.cjs similarity index 91% rename from packages/client/typedoc.js rename to packages/client/typedoc.cjs index 2ce1f04bc0..418a57db18 100644 --- a/packages/client/typedoc.js +++ b/packages/client/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: [ diff --git a/packages/common/package.json b/packages/common/package.json index e25aefc89f..8e22d1b4fa 100644 --- a/packages/common/package.json +++ b/packages/common/package.json @@ -43,7 +43,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- common", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/common/typedoc.js b/packages/common/typedoc.cjs similarity index 78% rename from packages/common/typedoc.js rename to packages/common/typedoc.cjs index 12ed5256f4..1c6061b8d7 100644 --- a/packages/common/typedoc.js +++ b/packages/common/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/**', 'src/chains/**', 'src/eips/**', 'src/hardforks/**'], diff --git a/packages/devp2p/package.json b/packages/devp2p/package.json index 6f89456155..a0f72bf9a1 100644 --- a/packages/devp2p/package.json +++ b/packages/devp2p/package.json @@ -46,7 +46,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "../../config/cli/coverage.sh", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- devp2p", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/devp2p/typedoc.js b/packages/devp2p/typedoc.cjs similarity index 77% rename from packages/devp2p/typedoc.js rename to packages/devp2p/typedoc.cjs index 1ab97b81ad..ce80b4e71d 100644 --- a/packages/devp2p/typedoc.js +++ b/packages/devp2p/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'examples/*.ts', 'src/protocol/protocol.ts'], diff --git a/packages/ethash/package.json b/packages/ethash/package.json index bea58e6cb5..35569a032d 100644 --- a/packages/ethash/package.json +++ b/packages/ethash/package.json @@ -34,7 +34,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- ethash", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/ethash/typedoc.js b/packages/ethash/typedoc.cjs similarity index 73% rename from packages/ethash/typedoc.js rename to packages/ethash/typedoc.cjs index ba203bcba7..1e0dab9e63 100644 --- a/packages/ethash/typedoc.js +++ b/packages/ethash/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'examples/*.ts'], diff --git a/packages/evm/package.json b/packages/evm/package.json index 19606eadf5..7558dabe2c 100644 --- a/packages/evm/package.json +++ b/packages/evm/package.json @@ -38,7 +38,7 @@ "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", "coverage:test": "npm run test:node && cd ../vm && npm run tester -- --state", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- evm", "formatTest": "node ./scripts/formatTest", "lint": "../../config/cli/lint.sh", diff --git a/packages/evm/typedoc.js b/packages/evm/typedoc.cjs similarity index 72% rename from packages/evm/typedoc.js rename to packages/evm/typedoc.cjs index 6660d1234c..04314aef63 100644 --- a/packages/evm/typedoc.js +++ b/packages/evm/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'src/evm/**'], diff --git a/packages/genesis/package.json b/packages/genesis/package.json index 19851a67a0..0c141a0b50 100644 --- a/packages/genesis/package.json +++ b/packages/genesis/package.json @@ -45,7 +45,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "../../config/cli/coverage.sh", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", "lint:fix": "../../config/cli/lint-fix.sh", diff --git a/packages/statemanager/typedoc.js b/packages/genesis/typedoc.cjs similarity index 69% rename from packages/statemanager/typedoc.js rename to packages/genesis/typedoc.cjs index 823588a62c..701fee055f 100644 --- a/packages/statemanager/typedoc.js +++ b/packages/genesis/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts'], diff --git a/packages/statemanager/package.json b/packages/statemanager/package.json index 8584046093..d1b1a51600 100644 --- a/packages/statemanager/package.json +++ b/packages/statemanager/package.json @@ -36,7 +36,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- statemanager", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/genesis/typedoc.js b/packages/statemanager/typedoc.cjs similarity index 69% rename from packages/genesis/typedoc.js rename to packages/statemanager/typedoc.cjs index 823588a62c..701fee055f 100644 --- a/packages/genesis/typedoc.js +++ b/packages/statemanager/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts'], diff --git a/packages/trie/package.json b/packages/trie/package.json index ebb76be944..bfffd0c064 100644 --- a/packages/trie/package.json +++ b/packages/trie/package.json @@ -39,7 +39,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- trie", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/wallet/typedoc.js b/packages/trie/typedoc.cjs similarity index 69% rename from packages/wallet/typedoc.js rename to packages/trie/typedoc.cjs index 823588a62c..701fee055f 100644 --- a/packages/wallet/typedoc.js +++ b/packages/trie/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts'], diff --git a/packages/tx/package.json b/packages/tx/package.json index c0cd2e55c5..805ff59046 100644 --- a/packages/tx/package.json +++ b/packages/tx/package.json @@ -44,7 +44,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- tx", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/tx/typedoc.js b/packages/tx/typedoc.cjs similarity index 72% rename from packages/tx/typedoc.js rename to packages/tx/typedoc.cjs index 72d07d140f..f843620ce5 100644 --- a/packages/tx/typedoc.js +++ b/packages/tx/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['src/util.ts', 'test/**/*.ts'], diff --git a/packages/util/package.json b/packages/util/package.json index 62a3e02c20..fc8ba3441f 100644 --- a/packages/util/package.json +++ b/packages/util/package.json @@ -78,7 +78,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", - "docs:build": "npx typedoc --options typedoc.js", + "docs:build": "npx typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- util", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/util/typedoc.js b/packages/util/typedoc.cjs similarity index 68% rename from packages/util/typedoc.js rename to packages/util/typedoc.cjs index 3d06f850c5..0c5a50bf95 100644 --- a/packages/util/typedoc.js +++ b/packages/util/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/*.ts'], diff --git a/packages/vm/package.json b/packages/vm/package.json index f1bd1b7ae1..55ef01c765 100644 --- a/packages/vm/package.json +++ b/packages/vm/package.json @@ -39,7 +39,7 @@ "clean": "../../config/cli/clean-package.sh", "coverage": "npx vitest run --coverage.enabled --coverage.reporter=lcov", "coverage:test": "npm run test:API", - "docs:build": "typedoc --options typedoc.js", + "docs:build": "typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- vm", "formatTest": "node ./scripts/formatTest", "lint": "../../config/cli/lint.sh", diff --git a/packages/vm/typedoc.js b/packages/vm/typedoc.cjs similarity index 78% rename from packages/vm/typedoc.js rename to packages/vm/typedoc.cjs index e366b669bb..4ba84fef05 100644 --- a/packages/vm/typedoc.js +++ b/packages/vm/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts', 'src/bloom/*.ts', 'src/evm/**', 'src/state/cache.ts'], diff --git a/packages/wallet/package.json b/packages/wallet/package.json index f4d45ea036..c4b0ef4985 100644 --- a/packages/wallet/package.json +++ b/packages/wallet/package.json @@ -34,7 +34,7 @@ "build": "../../config/cli/ts-build.sh", "clean": "../../config/cli/clean-package.sh", "coverage": "npm run build && nyc --reporter=lcov npm run test:unit", - "docs:build": "npx typedoc --options typedoc.js", + "docs:build": "npx typedoc --options typedoc.cjs", "examples": "ts-node ../../scripts/examples-runner.ts -- wallet", "lint": "../../config/cli/lint.sh", "lint:diff": "../../config/cli/lint-diff.sh", diff --git a/packages/trie/typedoc.js b/packages/wallet/typedoc.cjs similarity index 69% rename from packages/trie/typedoc.js rename to packages/wallet/typedoc.cjs index 823588a62c..701fee055f 100644 --- a/packages/trie/typedoc.js +++ b/packages/wallet/typedoc.cjs @@ -1,5 +1,5 @@ module.exports = { - extends: '../../config/typedoc.js', + extends: '../../config/typedoc.cjs', entryPoints: ['src'], out: 'docs', exclude: ['test/**/*.ts'],