Skip to content

Commit

Permalink
docs: fix
Browse files Browse the repository at this point in the history
  • Loading branch information
@ralphschuler
ralphschuler committed Nov 26, 2023
1 parent 1f8f3fb commit 4829a80
Show file tree
Hide file tree
Showing 32 changed files with 54 additions and 32 deletions.
6 changes: 4 additions & 2 deletions package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -22,6 +22,8 @@
"typedoc": "^0.25.3",
"typedoc-github-wiki-theme": "^1.1.0",
"typedoc-plugin-markdown": "^3.17.1",
"typedoc-plugin-mdn-links": "^3.1.5",
"typedoc-plugin-missing-exports": "^2.1.0",
"typedoc-plugin-rename-defaults": "^0.7.0"
},
"homepage": "https://ralphschuler.github.io/ts-libs/",
Expand All @@ -41,8 +43,8 @@
"clean": "yarn workspaces foreach -Apt run clean",
"docs:all": "yarn docs:build; yarn docs:bundle:markdown && yarn docs:bundle:html",
"docs:build": "yarn workspaces foreach -Apt run docs",
"docs:bundle:html": "typedoc --out docs/html --plugin @mxssfd/typedoc-theme --theme my-theme --plugin typedoc-plugin-markdown --plugin typedoc-plugin-rename-defaults --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
"docs:bundle:markdown": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs/markdown --plugin typedoc-plugin-rename-defaults --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",
"docs:bundle:html": "typedoc --out docs/html --plugin @mxssfd/typedoc-theme --theme my-theme --plugin typedoc-plugin-markdown --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",

Check notice on line 46 in package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Update typedoc command in package.json 

The `typedoc` command in the `package.json` file for `ai-function-caller` and `assert` packages should be updated.

Currently, the command uses the `entrypointStrategy` option with the value `expand`, which is not a valid option. It should be updated to use the correct option `entryPointStrategy` with the value `merge`.

Here is the updated command:

`"docs": "typedoc --entryPointStrategy merge --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/"
"docs:bundle:markdown": "typedoc --plugin typedoc-plugin-markdown --plugin typedoc-github-wiki-theme --out docs/markdown --readme ./README.md --entryPointStrategy merge \"./**/docs/*.json\"",

Check notice on line 47 in package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Improve Scripts for Documentation Generation 

The scripts in package.json for generating documentation could be improved for readability and maintainability.

1. Consider breaking the long command lines into multiple lines for better readability.
2. Provide clearer descriptions for the script commands.
3. Add comments to explain the purpose of each command.
4. Consider specifying the version numbers for the plugins to ensure consistent behavior across environments.

Overall, the documentation generation scripts could benefit from these improvements.
"fixpack": "fixpack && yarn workspaces foreach -Apt run fixpack",
"format": "yarn workspaces foreach -Apt run format",
"format:fix": "yarn workspaces foreach -Apt run format:fix",
Expand Down
2 changes: 1 addition & 1 deletion packages/ai-function-caller/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/assert/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/better-map/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",

Check notice on line 46 in packages/better-map/package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Use specific version for typedoc-plugin-mdn-links 

The package.json file for 'packages/better-map' specifies the use of 'typedoc-plugin-mdn-links' without a specific version, which can lead to compatibility issues or unexpected behavior. It's recommended to specify a specific version for better control over the dependencies.

Consider updating the line in package.json to:

"typedoc-plugin-mdn-links": "^3.1.5",

This will ensure that the desired version of 'typedoc-plugin-mdn-links' is used.
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/better-set/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/binary-serializer/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/bit-mask/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/cli/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/complex-compare/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/i811n/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/logger/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/lsystem/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/mixin-class-factory/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/neuronal-network/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/parser-combinator/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/priority-queue/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/prom-metrics-decorator/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/prom-metrics-parser/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/random/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",

Check notice on line 50 in packages/random/package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Potential Improvement 

Consider organizing the `docs` command in the `package.json` file to multiple lines for readability and maintainability. Additionally, it's recommended to specify the specific file(s) or folder(s) in the `src/` directory rather than using the `src/` wildcard.
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/reactivity/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",

Check notice on line 49 in packages/reactivity/package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Inefficient typedoc command 

The `docs` command in the `reactivity` package's `package.json` file uses the `entrypointStrategy` option with the value `expand`, which can be inefficient when generating documentation. It is generally recommended to use the `merge` strategy instead. Consider updating the command to use the `merge` strategy for better performance.

It is also worth mentioning that the `typedoc-plugin-rename-defaults` plugin is deprecated and should be replaced with an alternative solution.
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/safe-array/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/signature/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/slot-mashine/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",

Check notice on line 49 in packages/slot-mashine/package.json

View workflow job for this annotation

GitHub Actions / Chat GPT Code Peer Review

Update Documentation Command 

Consider updating the documentation command to include the `typedoc-plugin-markdown` plugin for generating Markdown documentation.

Current:
```
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/"
```

Suggested:
```
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --plugin typedoc-plugin-markdown --readme ./README.md src/"
```
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/state-machine/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -46,7 +46,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/state-store/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/stats-tracker/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/task-manager/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@
"typescript": "^5.2.2"
},
"scripts": {
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"build": "tsc",
"publish": "yarn npm publish",
"test": "echo \"Error: no test specified\" && exit 0",
Expand Down
2 changes: 1 addition & 1 deletion packages/ts-error/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/webgl-sand-engine/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/webgl-shader-factory/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
2 changes: 1 addition & 1 deletion packages/worker-pool/package.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -47,7 +47,7 @@
"scripts": {
"build": "tsc",
"clean": "rimraf dist node_modules docs",
"docs": "typedoc --json docs/docs.json --readme ./README.md",
"docs": "typedoc --entrypointStrategy expand --json docs/docs.json --plugin typedoc-plugin-missing-exports --plugin typedoc-plugin-rename-defaults --plugin typedoc-plugin-mdn-links --readme ./README.md src/",
"fixpack": "fixpack",
"format": "prettier src/",
"format:fix": "prettier --write src/",
Expand Down
20 changes: 20 additions & 0 deletions yarn.lock
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1023,6 +1023,8 @@ __metadata:
typedoc: "npm:^0.25.3"
typedoc-github-wiki-theme: "npm:^1.1.0"
typedoc-plugin-markdown: "npm:^3.17.1"
typedoc-plugin-mdn-links: "npm:^3.1.5"
typedoc-plugin-missing-exports: "npm:^2.1.0"
typedoc-plugin-rename-defaults: "npm:^0.7.0"
languageName: unknown
linkType: soft
Expand Down Expand Up @@ -4993,6 +4995,24 @@ __metadata:
languageName: node
linkType: hard

"typedoc-plugin-mdn-links@npm:^3.1.5":
version: 3.1.5
resolution: "typedoc-plugin-mdn-links@npm:3.1.5"
peerDependencies:
typedoc: ">= 0.23.14 || 0.24.x || 0.25.x"
checksum: 82d5546db8a8c28a3f6decf20f4327e3ad874e7a21d3897b1f12cfed81dd71dfc9a093ddef56adda7cfc7380f619c0f3d9e07b349d921e236e63c353c22afb0a
languageName: node
linkType: hard

"typedoc-plugin-missing-exports@npm:^2.1.0":
version: 2.1.0
resolution: "typedoc-plugin-missing-exports@npm:2.1.0"
peerDependencies:
typedoc: 0.24.x || 0.25.x
checksum: 05eaa9f249b146dcdf791c63088452e70f734805d84faa691228b8474b4c806fba7691fd1a51bb039a2b1901af2c02db3bae17853cf4b102ee4fda0a195308fb
languageName: node
linkType: hard

"typedoc-plugin-rename-defaults@npm:^0.7.0":
version: 0.7.0
resolution: "typedoc-plugin-rename-defaults@npm:0.7.0"
Expand Down

0 comments on commit 4829a80

Please sign in to comment.