Skip to content

feat: add yarn build:docs #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Jul 1, 2025
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 2 additions & 0 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -32,6 +32,7 @@
"!**/.*"
],
"scripts": {
"build:docs": "typedoc",
"lint:changelog": "auto-changelog validate --prettier",
"lint:constraints": "yarn constraints",
"lint:dependencies": "depcheck && yarn dedupe",
Expand Down Expand Up @@ -94,6 +95,7 @@
"react-native-builder-bob": "^0.38.4",
"release-it": "^17.10.0",
"turbo": "^1.10.7",
"typedoc": "^0.28.7",
"typescript": "^5.2.2"
},
"peerDependencies": {
Expand Down
151 changes: 148 additions & 3 deletions yarn.lock
Original file line number Diff line number Diff line change
Expand Up @@ -1864,6 +1864,19 @@ __metadata:
languageName: node
linkType: hard

"@gerrit0/mini-shiki@npm:^3.7.0":
version: 3.7.0
resolution: "@gerrit0/mini-shiki@npm:3.7.0"
dependencies:
"@shikijs/engine-oniguruma": "npm:^3.7.0"
"@shikijs/langs": "npm:^3.7.0"
"@shikijs/themes": "npm:^3.7.0"
"@shikijs/types": "npm:^3.7.0"
"@shikijs/vscode-textmate": "npm:^10.0.2"
checksum: 10/d9af211439551e2198309b6b3a274174ef7f84ab74d55872a6ab0302fe5b41a2000eaad65574ef5cd8fedad13d5a099e64863d489a991df7a3efd8e3250f8912
languageName: node
linkType: hard

"@hapi/hoek@npm:^9.0.0, @hapi/hoek@npm:^9.3.0":
version: 9.3.0
resolution: "@hapi/hoek@npm:9.3.0"
Expand Down Expand Up @@ -2370,6 +2383,7 @@ __metadata:
react-native-builder-bob: "npm:^0.38.4"
release-it: "npm:^17.10.0"
turbo: "npm:^1.10.7"
typedoc: "npm:^0.28.7"
typescript: "npm:^5.2.2"
peerDependencies:
react: "*"
Expand Down Expand Up @@ -3099,6 +3113,51 @@ __metadata:
languageName: node
linkType: hard

"@shikijs/engine-oniguruma@npm:^3.7.0":
version: 3.7.0
resolution: "@shikijs/engine-oniguruma@npm:3.7.0"
dependencies:
"@shikijs/types": "npm:3.7.0"
"@shikijs/vscode-textmate": "npm:^10.0.2"
checksum: 10/dee77bddb90efd2b164d46ed2b88793503d00cd2fb484b869cf7c78531b75fd024bbbd2d7b8be2eb3f063179d79aa441341478411403415156ad76672d751547
languageName: node
linkType: hard

"@shikijs/langs@npm:^3.7.0":
version: 3.7.0
resolution: "@shikijs/langs@npm:3.7.0"
dependencies:
"@shikijs/types": "npm:3.7.0"
checksum: 10/11bc671751c6cd82ae83575bdf84ecf51f54b13b3c8e3b51ff299a8c1288b8eac0fa2c99c6905753a4790b7af9160c6ed5a15be4c54851be3d339540a8d292ee
languageName: node
linkType: hard

"@shikijs/themes@npm:^3.7.0":
version: 3.7.0
resolution: "@shikijs/themes@npm:3.7.0"
dependencies:
"@shikijs/types": "npm:3.7.0"
checksum: 10/9fb5085bc9121124577823a28f9b2d1335875296232856e37c7cf9a9672958dff93b6d821896f6dbcbd44953043254acf28407c6e4cfba62d5fa8bf38142fd08
languageName: node
linkType: hard

"@shikijs/types@npm:3.7.0, @shikijs/types@npm:^3.7.0":
version: 3.7.0
resolution: "@shikijs/types@npm:3.7.0"
dependencies:
"@shikijs/vscode-textmate": "npm:^10.0.2"
"@types/hast": "npm:^3.0.4"
checksum: 10/f6f4c6166968a24620b390bc4dc7d2238f8cbcb209d0b55583dafe0fea2de742479795b2bdede2b3f070159550b2e36519d3933ac9f23ca02e036c87fed74db4
languageName: node
linkType: hard

"@shikijs/vscode-textmate@npm:^10.0.2":
version: 10.0.2
resolution: "@shikijs/vscode-textmate@npm:10.0.2"
checksum: 10/d924cba8a01cd9ca12f56ba097d628fdb81455abb85884c8d8a5ae85b628a37dd5907e7691019b97107bd6608c866adf91ba04a1c3bba391281c88e386c044ea
languageName: node
linkType: hard

"@sideway/address@npm:^4.1.5":
version: 4.1.5
resolution: "@sideway/address@npm:4.1.5"
Expand Down Expand Up @@ -3227,6 +3286,15 @@ __metadata:
languageName: node
linkType: hard

"@types/hast@npm:^3.0.4":
version: 3.0.4
resolution: "@types/hast@npm:3.0.4"
dependencies:
"@types/unist": "npm:*"
checksum: 10/732920d81bb7605895776841b7658b4d8cc74a43a8fa176017cc0fb0ecc1a4c82a2b75a4fe6b71aa262b649d3fb62858c6789efa3793ea1d40269953af96ecb5
languageName: node
linkType: hard

"@types/istanbul-lib-coverage@npm:*, @types/istanbul-lib-coverage@npm:^2.0.0, @types/istanbul-lib-coverage@npm:^2.0.1":
version: 2.0.6
resolution: "@types/istanbul-lib-coverage@npm:2.0.6"
Expand Down Expand Up @@ -3338,6 +3406,13 @@ __metadata:
languageName: node
linkType: hard

"@types/unist@npm:*":
version: 3.0.3
resolution: "@types/unist@npm:3.0.3"
checksum: 10/96e6453da9e075aaef1dc22482463898198acdc1eeb99b465e65e34303e2ec1e3b1ed4469a9118275ec284dc98019f63c3f5d49422f0e4ac707e5ab90fb3b71a
languageName: node
linkType: hard

"@types/yargs-parser@npm:*":
version: 21.0.3
resolution: "@types/yargs-parser@npm:21.0.3"
Expand Down Expand Up @@ -5827,7 +5902,7 @@ __metadata:
languageName: node
linkType: hard

"entities@npm:^4.5.0":
"entities@npm:^4.4.0, entities@npm:^4.5.0":
version: 4.5.0
resolution: "entities@npm:4.5.0"
checksum: 10/ede2a35c9bce1aeccd055a1b445d41c75a14a2bb1cd22e242f20cf04d236cdcd7f9c859eb83f76885327bfae0c25bf03303665ee1ce3d47c5927b98b0e3e3d48
Expand Down Expand Up @@ -9098,6 +9173,15 @@ __metadata:
languageName: node
linkType: hard

"linkify-it@npm:^5.0.0":
version: 5.0.0
resolution: "linkify-it@npm:5.0.0"
dependencies:
uc.micro: "npm:^2.0.0"
checksum: 10/ef3b7609dda6ec0c0be8a7b879cea195f0d36387b0011660cd6711bba0ad82137f59b458b7e703ec74f11d88e7c1328e2ad9b855a8500c0ded67461a8c4519e6
languageName: node
linkType: hard

"locate-path@npm:^3.0.0":
version: 3.0.0
resolution: "locate-path@npm:3.0.0"
Expand Down Expand Up @@ -9323,6 +9407,13 @@ __metadata:
languageName: node
linkType: hard

"lunr@npm:^2.3.9":
version: 2.3.9
resolution: "lunr@npm:2.3.9"
checksum: 10/f2f6db34c046f5a767782fe2454e6dd69c75ba3c5cf5c1cb9cacca2313a99c2ba78ff8fa67dac866fb7c4ffd5f22e06684793f5f15ba14bddb598b94513d54bf
languageName: node
linkType: hard

"macos-release@npm:^3.1.0":
version: 3.4.0
resolution: "macos-release@npm:3.4.0"
Expand Down Expand Up @@ -9420,6 +9511,22 @@ __metadata:
languageName: node
linkType: hard

"markdown-it@npm:^14.1.0":
version: 14.1.0
resolution: "markdown-it@npm:14.1.0"
dependencies:
argparse: "npm:^2.0.1"
entities: "npm:^4.4.0"
linkify-it: "npm:^5.0.0"
mdurl: "npm:^2.0.0"
punycode.js: "npm:^2.3.1"
uc.micro: "npm:^2.1.0"
bin:
markdown-it: bin/markdown-it.mjs
checksum: 10/f34f921be178ed0607ba9e3e27c733642be445e9bb6b1dba88da7aafe8ba1bc5d2f1c3aa8f3fc33b49a902da4e4c08c2feadfafb290b8c7dda766208bb6483a9
languageName: node
linkType: hard

"marky@npm:^1.2.2":
version: 1.3.0
resolution: "marky@npm:1.3.0"
Expand All @@ -9434,6 +9541,13 @@ __metadata:
languageName: node
linkType: hard

"mdurl@npm:^2.0.0":
version: 2.0.0
resolution: "mdurl@npm:2.0.0"
checksum: 10/1720349d4a53e401aa993241368e35c0ad13d816ad0b28388928c58ca9faa0cf755fa45f18ccbf64f4ce54a845a50ddce5c84e4016897b513096a68dac4b0158
languageName: node
linkType: hard

"media-typer@npm:0.3.0":
version: 0.3.0
resolution: "media-typer@npm:0.3.0"
Expand Down Expand Up @@ -10067,7 +10181,7 @@ __metadata:
languageName: node
linkType: hard

"minimatch@npm:^9.0.4":
"minimatch@npm:^9.0.4, minimatch@npm:^9.0.5":
version: 9.0.5
resolution: "minimatch@npm:9.0.5"
dependencies:
Expand Down Expand Up @@ -11316,6 +11430,13 @@ __metadata:
languageName: node
linkType: hard

"punycode.js@npm:^2.3.1":
version: 2.3.1
resolution: "punycode.js@npm:2.3.1"
checksum: 10/f0e946d1edf063f9e3d30a32ca86d8ff90ed13ca40dad9c75d37510a04473340cfc98db23a905cc1e517b1e9deb0f6021dce6f422ace235c60d3c9ac47c5a16a
languageName: node
linkType: hard

"punycode@npm:^2.1.0":
version: 2.3.1
resolution: "punycode@npm:2.3.1"
Expand Down Expand Up @@ -13211,6 +13332,23 @@ __metadata:
languageName: node
linkType: hard

"typedoc@npm:^0.28.7":
version: 0.28.7
resolution: "typedoc@npm:0.28.7"
dependencies:
"@gerrit0/mini-shiki": "npm:^3.7.0"
lunr: "npm:^2.3.9"
markdown-it: "npm:^14.1.0"
minimatch: "npm:^9.0.5"
yaml: "npm:^2.8.0"
peerDependencies:
typescript: 5.0.x || 5.1.x || 5.2.x || 5.3.x || 5.4.x || 5.5.x || 5.6.x || 5.7.x || 5.8.x
bin:
typedoc: bin/typedoc
checksum: 10/afe4868d9288c8456227d745955eeb37a0485b56657d4b690d32e2c99580983cf27109e197b5c652c747cfcdab81588c9ff3d1572e9d7d87fd068e8630715b18
languageName: node
linkType: hard

"typescript@npm:^5.2.2":
version: 5.8.3
resolution: "typescript@npm:5.8.3"
Expand All @@ -13231,6 +13369,13 @@ __metadata:
languageName: node
linkType: hard

"uc.micro@npm:^2.0.0, uc.micro@npm:^2.1.0":
version: 2.1.0
resolution: "uc.micro@npm:2.1.0"
checksum: 10/37197358242eb9afe367502d4638ac8c5838b78792ab218eafe48287b0ed28aaca268ec0392cc5729f6c90266744de32c06ae938549aee041fc93b0f9672d6b2
languageName: node
linkType: hard

"uglify-js@npm:^3.1.4":
version: 3.19.3
resolution: "uglify-js@npm:3.19.3"
Expand Down Expand Up @@ -13806,7 +13951,7 @@ __metadata:
languageName: node
linkType: hard

"yaml@npm:^2.2.1":
"yaml@npm:^2.2.1, yaml@npm:^2.8.0":
version: 2.8.0
resolution: "yaml@npm:2.8.0"
bin:
Expand Down
Loading