docs updates (#2887)

ethereumjs · Jul 13, 2023 · 88b5402 · 88b5402
1 parent fc80b2e
commit 88b5402
Show file tree

Hide file tree

Showing 29 changed files with 28 additions and 28 deletions.
diff --git a/config/typedoc.js → config/typedoc.cjs b/config/typedoc.js → config/typedoc.cjs
diff --git 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 → packages/block/typedoc.cjs b/packages/block/typedoc.js → 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
@@ -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 → packages/blockchain/typedoc.cjs b/packages/blockchain/typedoc.js → 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
@@ -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 → packages/client/typedoc.cjs b/packages/client/typedoc.js → 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
@@ -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 → packages/common/typedoc.cjs b/packages/common/typedoc.js → 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
@@ -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 → packages/devp2p/typedoc.cjs b/packages/devp2p/typedoc.js → 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
@@ -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 → packages/ethash/typedoc.cjs b/packages/ethash/typedoc.js → 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
@@ -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 → packages/evm/typedoc.cjs b/packages/evm/typedoc.js → 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
@@ -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 → packages/genesis/typedoc.cjs b/packages/statemanager/typedoc.js → 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
@@ -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 → packages/statemanager/typedoc.cjs b/packages/genesis/typedoc.js → 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
@@ -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 → packages/trie/typedoc.cjs b/packages/wallet/typedoc.js → 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
@@ -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 → packages/tx/typedoc.cjs b/packages/tx/typedoc.js → 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
@@ -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 → packages/util/typedoc.cjs b/packages/util/typedoc.js → 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
@@ -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 → packages/vm/typedoc.cjs b/packages/vm/typedoc.js → 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
@@ -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 → packages/wallet/typedoc.cjs b/packages/trie/typedoc.js → 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'],