mirror of
https://github.com/Brotocol-xyz/bro-sdk.git
synced 2026-01-12 06:44:18 +08:00
chore: add typedoc.config.mjs
This commit is contained in:
16
.config/typedoc.config.mjs
Normal file
16
.config/typedoc.config.mjs
Normal file
@@ -0,0 +1,16 @@
|
|||||||
|
import pkgInfo from "../package.json" assert { type: "json" }
|
||||||
|
import path from "node:path"
|
||||||
|
|
||||||
|
const entryPoints = Object.keys(pkgInfo.exports).map(i => {
|
||||||
|
const exportEndpoint = i === "." ? "./XLinkSDK" : i
|
||||||
|
const exportEndpointFilePath = path.join("../src", exportEndpoint) + ".ts"
|
||||||
|
return exportEndpointFilePath
|
||||||
|
})
|
||||||
|
|
||||||
|
/** @type {Partial<import('typedoc').TypeDocOptions>} */
|
||||||
|
const config = {
|
||||||
|
entryPoints: entryPoints,
|
||||||
|
out: "../generated/docs",
|
||||||
|
}
|
||||||
|
|
||||||
|
export default config
|
||||||
1
.gitignore
vendored
1
.gitignore
vendored
@@ -1,4 +1,5 @@
|
|||||||
node_modules/
|
node_modules/
|
||||||
|
generated/docs/
|
||||||
lib/
|
lib/
|
||||||
*.tgz
|
*.tgz
|
||||||
.envrc.*.local
|
.envrc.*.local
|
||||||
|
|||||||
@@ -34,7 +34,8 @@
|
|||||||
"scripts": {
|
"scripts": {
|
||||||
"gen:stacksContract": "rm -rf generated/smartContract && mkdir -p generated/smartContract && tsx ./scripts/generateClarityTranscoders.ts",
|
"gen:stacksContract": "rm -rf generated/smartContract && mkdir -p generated/smartContract && tsx ./scripts/generateClarityTranscoders.ts",
|
||||||
"gen": "pnpm run gen:stacksContract",
|
"gen": "pnpm run gen:stacksContract",
|
||||||
"docs": "npx typedoc src/index.ts",
|
"docs": "typedoc",
|
||||||
|
"docs:watch": "typedoc --watch",
|
||||||
"build": "pnpm run gen && rm -rf lib && tsup-node --sourcemap --dts -d lib --format cjs,esm src",
|
"build": "pnpm run gen && rm -rf lib && tsup-node --sourcemap --dts -d lib --format cjs,esm src",
|
||||||
"prepare": "pnpm run build",
|
"prepare": "pnpm run build",
|
||||||
"test": "vitest --exclude lib"
|
"test": "vitest --exclude lib"
|
||||||
|
|||||||
Reference in New Issue
Block a user