Skip to content

Commit 332f529

Browse files
committed
feat: temp adapt repo to typedoc
1 parent b24cbe9 commit 332f529

File tree

5 files changed

+37
-1361
lines changed

5 files changed

+37
-1361
lines changed

package.json

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,5 @@
11
{
2-
"workspaces": ["src", "examples/*"],
3-
"private": true,
2+
"name": "@arbitrum/orbit-sdk",
43
"type": "module",
54
"scripts": {
65
"prebuild": "rm -rf ./src/dist",

src/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -55,4 +55,4 @@
5555
"@arbitrum/token-bridge-contracts": "^1.2.1",
5656
"ethers": "^5.7.2"
5757
}
58-
}
58+
}

tsconfig.json

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,28 @@
11
{
2-
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.js"],
3-
"compilerOptions": {
4-
"strict": true,
5-
"incremental": true,
2+
"compilerOptions": {
3+
"strict": true,
4+
"incremental": true,
65

7-
"lib": ["ES2021"],
8-
"target": "ES2021",
6+
"lib": ["ES2021"],
7+
"target": "ES2021",
98

10-
"moduleResolution": "node",
11-
"rootDir": "./src",
9+
"moduleResolution": "node",
10+
"rootDir": "./src",
1211

13-
// JavaScript support
14-
"allowJs": false,
15-
"checkJs": false,
12+
// JavaScript support
13+
"allowJs": false,
14+
"checkJs": false,
1615

17-
// Skip type checking for node modules
18-
"skipLibCheck": true,
19-
"resolveJsonModule": true,
20-
"esModuleInterop": true,
21-
"allowSyntheticDefaultImports": true,
22-
"experimentalDecorators": true,
16+
// Skip type checking for node modules
17+
"skipLibCheck": true,
18+
"resolveJsonModule": true,
19+
"esModuleInterop": true,
20+
"allowSyntheticDefaultImports": true,
21+
"experimentalDecorators": true,
2322

24-
// Show all keys in type without hiding in "... more ..."
25-
// Enabling this option cause typescript performance
26-
"noErrorTruncation": false
27-
}
23+
// Show all keys in type without hiding in "... more ..."
24+
// Enabling this option cause typescript performance
25+
"noErrorTruncation": false
26+
},
27+
"include": ["src/**/*.ts", "src/**/*.d.ts", "src/**/*.js"]
2828
}

typedoc.js

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ module.exports = {
1515
plugin: ['typedoc-plugin-markdown'],
1616

1717
// typedoc-plugin-markdown options
18-
// entryDocument: 'modules.md',
18+
// entryDocument: 'modules.mdx',
1919
hideBreadcrumbs: true,
2020
hideInPageTOC: true,
2121
hideMembersSymbol: true,

0 commit comments

Comments
 (0)