Tools: Fixed buildPluginDoc command

This commit is contained in:
Laurent Cozic committed 2023-06-23 18:18:25 +01:00
1 parent 6886f6fd39
commit 71144bb675
5 files changed
+49 -21

No files matched your search

+1 -2
View File
@@ -16,7 +16,7 @@
"buildSequential": "yarn workspaces foreach --verbose --interlaced --topological run build && yarn run tsc", "buildSequential": "yarn workspaces foreach --verbose --interlaced --topological run build && yarn run tsc",
"buildApiDoc": "yarn workspace joplin start apidoc ../../readme/api/references/rest_api.md", "buildApiDoc": "yarn workspace joplin start apidoc ../../readme/api/references/rest_api.md",
"buildCommandIndex": "node packages/tools/gulp/tasks/buildCommandIndexRun.js", "buildCommandIndex": "node packages/tools/gulp/tasks/buildCommandIndexRun.js",
"buildPluginDoc": "typedoc --name 'Joplin Plugin API Documentation' --mode file -theme './Assets/PluginDocTheme/' --readme './Assets/PluginDocTheme/index.md' --excludeNotExported --excludeExternals --excludePrivate --excludeProtected --out ../joplin-website/docs/api/references/plugin_api packages/lib/services/plugins/api/", "buildPluginDoc": "cd packages/generate-plugin-doc && yarn run buildPluginDoc_",
"updateMarkdownDoc": "node ./packages/tools/updateMarkdownDoc", "updateMarkdownDoc": "node ./packages/tools/updateMarkdownDoc",
"updateNews": "node ./packages/tools/website/updateNews", "updateNews": "node ./packages/tools/website/updateNews",
"buildSettingJsonSchema": "yarn workspace joplin start settingschema ../../../joplin-website/docs/schema/settings.json", "buildSettingJsonSchema": "yarn workspace joplin start settingschema ../../../joplin-website/docs/schema/settings.json",
@@ -84,7 +84,6 @@
"lint-staged": "13.2.2", "lint-staged": "13.2.2",
"madge": "6.0.0", "madge": "6.0.0",
"npm-package-json-lint": "6.4.0", "npm-package-json-lint": "6.4.0",
"typedoc": "0.17.8",
"typescript": "5.0.2" "typescript": "5.0.2"
}, },
"dependencies": { "dependencies": {
+2 -2
View File
@@ -465,7 +465,7 @@ PODS:
- React-Core - React-Core
- RNCPushNotificationIOS (1.11.0): - RNCPushNotificationIOS (1.11.0):
- React-Core - React-Core
- RNDateTimePicker (7.0.1): - RNDateTimePicker (7.1.0):
- React-Core - React-Core
- RNExitApp (1.1.0): - RNExitApp (1.1.0):
- React - React
@@ -807,7 +807,7 @@ SPEC CHECKSUMS:
rn-fetch-blob: f065bb7ab7fb48dd002629f8bdcb0336602d3cba rn-fetch-blob: f065bb7ab7fb48dd002629f8bdcb0336602d3cba
RNCClipboard: 41d8d918092ae8e676f18adada19104fa3e68495 RNCClipboard: 41d8d918092ae8e676f18adada19104fa3e68495
RNCPushNotificationIOS: 64218f3c776c03d7408284a819b2abfda1834bc8 RNCPushNotificationIOS: 64218f3c776c03d7408284a819b2abfda1834bc8
RNDateTimePicker: e073697ac3e8a378968d68ab0581fef542b8af8a RNDateTimePicker: 7ecd54a97fc3749f38c3c89a171f6cbd52f3c142
RNExitApp: c4e052df2568b43bec8a37c7cd61194d4cfee2c3 RNExitApp: c4e052df2568b43bec8a37c7cd61194d4cfee2c3
RNFileViewer: ce7ca3ac370e18554d35d6355cffd7c30437c592 RNFileViewer: ce7ca3ac370e18554d35d6355cffd7c30437c592
RNFS: 4ac0f0ea233904cb798630b3c077808c06931688 RNFS: 4ac0f0ea233904cb798630b3c077808c06931688
+3
View File
@@ -0,0 +1,3 @@
# generate-plugin-doc
This package is only to run the buildPluginDoc command. The version of typedoc we use needs an old version of typescript, so we cannot put the whole thing at the root, where it used to be.
+11
View File
@@ -0,0 +1,11 @@
{
"name": "generate-plugin-doc",
"packageManager": "yarn@3.3.1",
"scripts": {
"buildPluginDoc_": "typedoc --name 'Joplin Plugin API Documentation' --mode file -theme '../../Assets/PluginDocTheme/' --readme '../../Assets/PluginDocTheme/index.md' --excludeNotExported --excludeExternals --excludePrivate --excludeProtected --out ../../../joplin-website/docs/api/references/plugin_api ../lib/services/plugins/api/"
},
"dependencies": {
"typedoc": "0.17.8",
"typescript": "4.7.4"
}
}
+32 -17
View File
@@ -16872,6 +16872,15 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"generate-plugin-doc@workspace:packages/generate-plugin-doc":
version: 0.0.0-use.local
resolution: "generate-plugin-doc@workspace:packages/generate-plugin-doc"
dependencies:
typedoc: 0.17.8
typescript: 4.7.4
languageName: unknown
linkType: soft
"generator-joplin@workspace:packages/generator-joplin": "generator-joplin@workspace:packages/generator-joplin":
version: 0.0.0-use.local version: 0.0.0-use.local
resolution: "generator-joplin@workspace:packages/generator-joplin" resolution: "generator-joplin@workspace:packages/generator-joplin"
@@ -23249,7 +23258,7 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"minimatch@npm:3.0.4, minimatch@npm:^3.0.0, minimatch@npm:^3.0.2, minimatch@npm:^3.0.4": "minimatch@npm:3.0.4, minimatch@npm:^3.0.2, minimatch@npm:^3.0.4":
version: 3.0.4 version: 3.0.4
resolution: "minimatch@npm:3.0.4" resolution: "minimatch@npm:3.0.4"
dependencies: dependencies:
@@ -23258,7 +23267,7 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"minimatch@npm:^3.0.5, minimatch@npm:^3.1.1, minimatch@npm:^3.1.2": "minimatch@npm:^3.0.0, minimatch@npm:^3.0.5, minimatch@npm:^3.1.1, minimatch@npm:^3.1.2":
version: 3.1.2 version: 3.1.2
resolution: "minimatch@npm:3.1.2" resolution: "minimatch@npm:3.1.2"
dependencies: dependencies:
@@ -28762,7 +28771,6 @@ __metadata:
node-gyp: 9.3.1 node-gyp: 9.3.1
nodemon: 2.0.22 nodemon: 2.0.22
npm-package-json-lint: 6.4.0 npm-package-json-lint: 6.4.0
typedoc: 0.17.8
typescript: 5.0.2 typescript: 5.0.2
languageName: unknown languageName: unknown
linkType: soft linkType: soft
@@ -29335,20 +29343,7 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"shelljs@npm:^0.8.4": "shelljs@npm:^0.8.4, shelljs@npm:^0.8.5":
version: 0.8.4
resolution: "shelljs@npm:0.8.4"
dependencies:
glob: ^7.0.0
interpret: ^1.0.0
rechoir: ^0.6.2
bin:
shjs: bin/shjs
checksum: 27f83206ef6a4f5b74a493726c3e6b4c3e07a9c2aac94c5e692d800a61353c18a8234967bd8523b1346abe718beb563843687fb57f466529ba06db3cae6f0bb3
languageName: node
linkType: hard
"shelljs@npm:^0.8.5":
version: 0.8.5 version: 0.8.5
resolution: "shelljs@npm:0.8.5" resolution: "shelljs@npm:0.8.5"
dependencies: dependencies:
@@ -32104,6 +32099,16 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"typescript@npm:4.7.4":
version: 4.7.4
resolution: "typescript@npm:4.7.4"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 5750181b1cd7e6482c4195825547e70f944114fb47e58e4aa7553e62f11b3f3173766aef9c281783edfd881f7b8299cf35e3ca8caebe73d8464528c907a164df
languageName: node
linkType: hard
"typescript@npm:5.0.2": "typescript@npm:5.0.2":
version: 5.0.2 version: 5.0.2
resolution: "typescript@npm:5.0.2" resolution: "typescript@npm:5.0.2"
@@ -32144,6 +32149,16 @@ __metadata:
languageName: node languageName: node
linkType: hard linkType: hard
"typescript@patch:typescript@4.7.4#~builtin<compat/typescript>":
version: 4.7.4
resolution: "typescript@patch:typescript@npm%3A4.7.4#~builtin<compat/typescript>::version=4.7.4&hash=65a307"
bin:
tsc: bin/tsc
tsserver: bin/tsserver
checksum: 9096d8f6c16cb80ef3bf96fcbbd055bf1c4a43bd14f3b7be45a9fbe7ada46ec977f604d5feed3263b4f2aa7d4c7477ce5f9cd87de0d6feedec69a983f3a4f93e
languageName: node
linkType: hard
"typescript@patch:typescript@5.0.2#~builtin<compat/typescript>": "typescript@patch:typescript@5.0.2#~builtin<compat/typescript>":
version: 5.0.2 version: 5.0.2
resolution: "typescript@patch:typescript@npm%3A5.0.2#~builtin<compat/typescript>::version=5.0.2&hash=ad5954" resolution: "typescript@patch:typescript@npm%3A5.0.2#~builtin<compat/typescript>::version=5.0.2&hash=ad5954"