chore: add typedoc.config.mjs

This commit is contained in:
c4605
2024-08-28 00:51:54 +01:00
parent 12eef24476
commit 2c9b3df960
3 changed files with 19 additions and 1 deletions

View 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
View File

@@ -1,4 +1,5 @@
node_modules/
generated/docs/
lib/
*.tgz
.envrc.*.local

View File

@@ -34,7 +34,8 @@
"scripts": {
"gen:stacksContract": "rm -rf generated/smartContract && mkdir -p generated/smartContract && tsx ./scripts/generateClarityTranscoders.ts",
"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",
"prepare": "pnpm run build",
"test": "vitest --exclude lib"