Skip to content

Commit 7958f2c

Browse files
committed
docs(satp-hermes): add typedoc documentation
1 parent 4244eb6 commit 7958f2c

File tree

119 files changed

+16271
-703
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

119 files changed

+16271
-703
lines changed

.cspell.json

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,7 @@
2121
"AWSSM",
2222
"baio",
2323
"benchmarkjs",
24+
"BNFT",
2425
"Besu",
2526
"Bools",
2627
"brioux",
@@ -40,6 +41,7 @@
4041
"ccmodel",
4142
"cctx",
4243
"celo",
44+
"chainid",
4345
"cids",
4446
"clazz",
4547
"clsx",
@@ -104,6 +106,7 @@
104106
"HTLC",
105107
"Hursley",
106108
"HyperLedger",
109+
"IBFT",
107110
"immalleable",
108111
"imodule",
109112
"ipaddress",
@@ -168,6 +171,7 @@
168171
"outsh",
169172
"Panicf",
170173
"parameterizable",
174+
"Permissioned",
171175
"pkey",
172176
"pmezard",
173177
"Postgres",

.gitignore

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -80,4 +80,5 @@ supply-chain-attack-09082025-audit-scan.out
8080
packages/cactus-plugin-satp-hermes/.config
8181

8282
*.sqlite3
83-
packages/cactus-plugin-satp-hermes/src/test/solidity/generated/build-info
83+
packages/cactus-plugin-satp-hermes/src/test/solidity/generated/build-info
84+
packages/cactus-plugin-satp-hermes/public/typedoc/** */

packages/cactus-plugin-satp-hermes/.eslint.config.mjs

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,19 @@ const compat = new FlatCompat({
1212
});
1313

1414
export default [
15+
{
16+
ignores: [
17+
'node_modules/**',
18+
'dist/**',
19+
'build/**',
20+
'public/**/*',
21+
'src/main/typescript/generated/**',
22+
'src/main/solidity/generated/**',
23+
'src/test/solidity/generated/**',
24+
'src/test/typescript/fabric/contracts/**',
25+
],
26+
},
27+
1528
// Include JS config
1629
js.configs.recommended,
1730

@@ -86,17 +99,4 @@ export default [
8699
"no-undef": "off",
87100
},
88101
},
89-
90-
// Package specific ignores
91-
{
92-
ignores: [
93-
'**/node_modules/**',
94-
'**/dist/**',
95-
'**/build/**',
96-
'**/src/main/typescript/generated/**',
97-
'**/src/main/solidity/generated/**',
98-
'**/src/test/solidity/generated/**',
99-
'**/src/test/typescript/fabric/contracts/**', // Added the fabric contracts test directory
100-
],
101-
}
102102
];

packages/cactus-plugin-satp-hermes/.gitignore

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -9,3 +9,6 @@ src/main/solidity/generated/build-info/
99
src/main/typescript/database/*
1010
reports/junit/satp-hermes-tests-unit.xml
1111
reports/junit/satp-hermes-tests-integration.xml
12+
13+
# TypeDoc generated documentation
14+
public/typedoc/

packages/cactus-plugin-satp-hermes/.prettierignore

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,3 +3,4 @@
33
**/bin/
44
**/generated/
55
**/src/main/typescript/generated/**
6+
**/public/**

0 commit comments

Comments
 (0)