Skip to content

Commit

Permalink
Update typedoc (0.27.6) and docusaurus (3.7.0) (#3914)
Browse files Browse the repository at this point in the history
This PR makes the following changes:
- bump teraslice from 2.12.2 to 2.12.3
- bump scripts from 1.9.1 to 1.9.2
- Add typedoc config options to display properties of enums, interfaces
and classes as tables
- dependency updates 
  - scripts
    - `typedoc` from 0.25.13 to 0.27.6
    - `typedoc-plugin-markdown from 4.0.3 to 4.4.1
  - website
    - @docusaurus/core from 3.0.0 to 3.7.0
    - @docusaurus/mdx-loader from 3.4.0 to 3.7.0
    - @docusaurus/preset-classic from 3.0.0 to 3.7.0
    - @docusaurus/theme-mermaid from 3.4.0 to 3.7.0
    - @mdx-js/react from 3.0.0 to 3.1.0
    - clsx from 1.1.1 to 2.1.1
    - react from 18.2.0 to 19.0.0
    - react-dom from 18.2.0 to 19.0.0
    - react-markdown from 8.0.7 to 9.0.3
  • Loading branch information
busma13 authored Jan 27, 2025
1 parent 8d0da40 commit e9a2afe
Show file tree
Hide file tree
Showing 9 changed files with 4,034 additions and 1,434 deletions.
2 changes: 1 addition & 1 deletion e2e/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@
"ms": "~2.1.3"
},
"devDependencies": {
"@terascope/scripts": "~1.9.1",
"@terascope/scripts": "~1.9.2",
"@terascope/types": "~1.4.1",
"bunyan": "~1.8.15",
"elasticsearch-store": "~1.7.3",
Expand Down
4 changes: 2 additions & 2 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "teraslice-workspace",
"displayName": "Teraslice",
"version": "2.12.2",
"version": "2.12.3",
"private": true,
"homepage": "https://github.com/terascope/teraslice",
"bugs": {
Expand Down Expand Up @@ -53,7 +53,7 @@
"@eslint/js": "~9.18.0",
"@swc/core": "1.10.9",
"@swc/jest": "~0.2.37",
"@terascope/scripts": "~1.9.1",
"@terascope/scripts": "~1.9.2",
"@types/bluebird": "~3.5.42",
"@types/convict": "~6.1.6",
"@types/elasticsearch": "~5.0.43",
Expand Down
9 changes: 5 additions & 4 deletions packages/scripts/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@terascope/scripts",
"displayName": "Scripts",
"version": "1.9.1",
"version": "1.9.2",
"description": "A collection of terascope monorepo scripts",
"homepage": "https://github.com/terascope/teraslice/tree/master/packages/scripts#readme",
"bugs": {
Expand Down Expand Up @@ -51,8 +51,8 @@
"signale": "~1.4.0",
"sort-package-json": "~2.14.0",
"toposort": "~2.0.2",
"typedoc": "~0.25.13",
"typedoc-plugin-markdown": "~4.0.3",
"typedoc": "~0.27.6",
"typedoc-plugin-markdown": "~4.4.1",
"yargs": "~17.7.2"
},
"devDependencies": {
Expand All @@ -61,7 +61,8 @@
"@types/ms": "~0.7.34",
"@types/semver": "~7.5.8",
"@types/signale": "~1.4.7",
"@types/toposort": "~2.0.7"
"@types/toposort": "~2.0.7",
"typescript": "~5.7.3"
},
"peerDependencies": {
"typescript": "~5.7.3"
Expand Down
13 changes: 5 additions & 8 deletions packages/scripts/src/helpers/doc-builder/typedoc.ts
Original file line number Diff line number Diff line change
Expand Up @@ -98,6 +98,7 @@ export async function generateTSDocs(pkgInfo: PackageInfo, outputDir: string): P
name: pkgInfo.name,
tsconfig: path.join(pkgInfo.dir, 'tsconfig.json'),
plugin: ['typedoc-plugin-markdown'],
theme: 'markdown',
entryPoints: ['./src'],
entryPointStrategy: 'expand',
exclude: ['test', 'node_modules'],
Expand All @@ -116,14 +117,10 @@ export async function generateTSDocs(pkgInfo: PackageInfo, outputDir: string): P
app.options.setValue('sanitizeComments', true);
app.options.setValue('indexFormat', 'table');
app.options.setValue('parametersFormat', 'table');

// this option causes errors with mdx
// app.options.setValue('enumMembersFormat', 'table');

// try these when we upgrade to version 4.1.0
// app.options.setValue('interfacePropertiesFormat', 'table');
// app.options.setValue('classPropertiesFormat', 'table');
// app.options.setValue('propertyMembersFormat', 'table');
app.options.setValue('enumMembersFormat', 'table');
app.options.setValue('interfacePropertiesFormat', 'table');
app.options.setValue('classPropertiesFormat', 'table');
app.options.setValue('propertyMembersFormat', 'table');

if (app.logger.hasErrors()) {
signale.error(`found errors typedocs for package ${pkgInfo.name}`);
Expand Down
2 changes: 1 addition & 1 deletion packages/teraslice/package.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "teraslice",
"displayName": "Teraslice",
"version": "2.12.2",
"version": "2.12.3",
"description": "Distributed computing platform for processing JSON data",
"homepage": "https://github.com/terascope/teraslice#readme",
"bugs": {
Expand Down
6 changes: 3 additions & 3 deletions website/docusaurus.config.js
Original file line number Diff line number Diff line change
Expand Up @@ -113,15 +113,15 @@ module.exports = {
items: [
{
label: 'Getting Started',
to: 'docs/getting-started.html',
to: 'docs/getting-started',
},
{
label: 'Packages',
to: 'docs/packages.html',
to: 'docs/packages',
},
{
label: 'Asset Bundles',
to: 'docs/asset-bundles.html',
to: 'docs/asset-bundles',
},
],
},
Expand Down
20 changes: 10 additions & 10 deletions website/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -14,18 +14,18 @@
},
"license": "MIT",
"devDependencies": {
"npm-watch": "^0.11.0"
"npm-watch": "^0.13.0"
},
"dependencies": {
"@docusaurus/core": "^3.0.0",
"@docusaurus/mdx-loader": "^3.4.0",
"@docusaurus/preset-classic": "^3.0.0",
"@docusaurus/theme-mermaid": "^3.4.0",
"@mdx-js/react": "^3.0.0",
"clsx": "^1.1.1",
"react": "^18.2.0",
"react-dom": "^18.2.0",
"react-markdown": "8.0.7"
"@docusaurus/core": "^3.7.0",
"@docusaurus/mdx-loader": "^3.7.0",
"@docusaurus/preset-classic": "^3.7.0",
"@docusaurus/theme-mermaid": "^3.7.0",
"@mdx-js/react": "^3.1.0",
"clsx": "^2.1.1",
"react": "^19.0.0",
"react-dom": "^19.0.0",
"react-markdown": "9.0.3"
},
"packageManager": "yarn@4.6.0",
"watch": {
Expand Down
Loading

0 comments on commit e9a2afe

Please sign in to comment.