Skip to content

Commit b1deb01

Browse files
authored
Docusaurus 3.2.0 Fix (#283)
- Updated All Plugins package.json to use docusaurus 3.2.0 - Updated `toNav` function to handle menus that now build with the role of `button` instead of `link` - `addLeadingSlash` and `addTrailingSlash` are now being imported from `@docusaurus/utils-common` - Omit `showLastUpdateAuthor` and `showLastUpdateTime` from PluginOptions
1 parent a2ef7c9 commit b1deb01

10 files changed

Lines changed: 236 additions & 366 deletions

File tree

cypress/integration/test.spec.ts

Lines changed: 13 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -47,11 +47,19 @@ function navTo(links: RegExp[], heading: RegExp) {
4747
return false;
4848
});
4949

50-
for (let link of links) {
51-
cy.get("nav.menu")
52-
.findByRole("link", { name: link })
53-
.click({ force: true }); // sometimes the sidebar items get covered by the navbar in CI.
54-
}
50+
links.forEach((linkRegex) => {
51+
cy.get("nav.menu").then(($menu) => {
52+
const navElement = $menu
53+
.find("a")
54+
.toArray()
55+
.find((el) => linkRegex.test(el.innerText));
56+
if (navElement) {
57+
cy.wrap(navElement).click({ force: true });
58+
} else {
59+
cy.log(`No link or button found matching regex: ${linkRegex}`);
60+
}
61+
});
62+
});
5563

5664
cy.findByRole("heading", { name: heading, level: 1 }).should("exist");
5765
}

demo/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@
1414
"write-heading-ids": "docusaurus write-heading-ids"
1515
},
1616
"dependencies": {
17-
"@docusaurus/core": "^3.0.0",
17+
"@docusaurus/core": "^3.2.0",
1818
"@svgr/webpack": "^5.5.0",
1919
"clsx": "^1.2.1",
2020
"docusaurus-preset-openapi": "^0.7.3",

packages/create-docusaurus-openapi/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@
2323
},
2424
"license": "MIT",
2525
"dependencies": {
26-
"@docusaurus/logger": "^3.0.0",
26+
"@docusaurus/logger": "^3.2.0",
2727
"commander": "^5.1.0",
2828
"fs-extra": "^11.0.0",
2929
"lodash": "^4.17.20",

packages/docusaurus-plugin-openapi/package.json

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,8 @@
2121
"watch": "tsc --watch"
2222
},
2323
"devDependencies": {
24-
"@docusaurus/module-type-aliases": "^3.0.0",
25-
"@docusaurus/types": "^3.0.0",
24+
"@docusaurus/module-type-aliases": "^3.2.0",
25+
"@docusaurus/types": "^3.2.0",
2626
"@types/axios": "^0.14.0",
2727
"@types/js-yaml": "^4.0.5",
2828
"@types/json-schema": "^7.0.9",
@@ -31,10 +31,11 @@
3131
"utility-types": "^3.10.0"
3232
},
3333
"dependencies": {
34-
"@docusaurus/mdx-loader": "^3.0.0",
35-
"@docusaurus/plugin-content-docs": "^3.0.0",
36-
"@docusaurus/utils": "^3.0.0",
37-
"@docusaurus/utils-validation": "^3.0.0",
34+
"@docusaurus/mdx-loader": "^3.2.0",
35+
"@docusaurus/plugin-content-docs": "^3.2.0",
36+
"@docusaurus/utils": "^3.2.0",
37+
"@docusaurus/utils-validation": "^3.2.0",
38+
"@docusaurus/utils-common": "^3.2.0",
3839
"axios": "^0.26.1",
3940
"chalk": "^4.1.2",
4041
"clsx": "^1.2.1",

packages/docusaurus-plugin-openapi/src/docs/docs.ts

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -72,6 +72,8 @@ async function doProcessDocMetadata({
7272
| "editLocalizedFiles"
7373
| "numberPrefixParser"
7474
| "breadcrumbs"
75+
| "showLastUpdateTime"
76+
| "showLastUpdateAuthor"
7577
>;
7678
env: DocEnv;
7779
}): Promise<DocMetadataBase> {
@@ -181,6 +183,8 @@ export function processDocMetadata(args: {
181183
| "editLocalizedFiles"
182184
| "numberPrefixParser"
183185
| "breadcrumbs"
186+
| "showLastUpdateTime"
187+
| "showLastUpdateAuthor"
184188
>;
185189
env: DocEnv;
186190
}): Promise<DocMetadataBase> {

packages/docusaurus-plugin-openapi/src/docs/slug.ts

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,8 @@ import type {
2121
NumberPrefixParser,
2222
DocMetadataBase,
2323
} from "@docusaurus/plugin-content-docs";
24-
import {
25-
addLeadingSlash,
26-
addTrailingSlash,
27-
isValidPathname,
28-
resolvePathname,
29-
} from "@docusaurus/utils";
24+
import { isValidPathname, resolvePathname } from "@docusaurus/utils";
25+
import { addLeadingSlash, addTrailingSlash } from "@docusaurus/utils-common";
3026

3127
import { isCategoryIndex, toCategoryIndexMatcherParam } from "./docs";
3228
import {

packages/docusaurus-plugin-proxy/package.json

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,7 +21,7 @@
2121
"watch": "tsc --watch"
2222
},
2323
"devDependencies": {
24-
"@docusaurus/types": "^3.0.0",
24+
"@docusaurus/types": "^3.2.0",
2525
"@types/webpack-dev-server": "^4.7.2"
2626
},
2727
"engines": {

packages/docusaurus-preset-openapi/package.json

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,10 @@
2828
"watch": "tsc --watch"
2929
},
3030
"devDependencies": {
31-
"@docusaurus/types": "^3.0.0"
31+
"@docusaurus/types": "^3.2.0"
3232
},
3333
"dependencies": {
34-
"@docusaurus/preset-classic": "^3.0.0",
34+
"@docusaurus/preset-classic": "^3.2.0",
3535
"docusaurus-plugin-openapi": "^0.7.3",
3636
"docusaurus-plugin-proxy": "^0.7.3",
3737
"docusaurus-theme-openapi": "^0.7.3"

packages/docusaurus-theme-openapi/package.json

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -24,8 +24,8 @@
2424
"format:lib-next": "prettier --config ../../.prettierrc.json --write \"lib-next/**/*.{js,ts,jsx,tsc}\""
2525
},
2626
"devDependencies": {
27-
"@docusaurus/module-type-aliases": "^3.0.0",
28-
"@docusaurus/types": "^3.0.0",
27+
"@docusaurus/module-type-aliases": "^3.2.0",
28+
"@docusaurus/types": "^3.2.0",
2929
"@types/concurrently": "^6.3.0",
3030
"@types/crypto-js": "^4.1.0",
3131
"@types/lodash": "^4.14.176",
@@ -35,7 +35,7 @@
3535
"concurrently": "^5.2.0"
3636
},
3737
"dependencies": {
38-
"@docusaurus/theme-common": "^3.0.0",
38+
"@docusaurus/theme-common": "^3.2.0",
3939
"@mdx-js/react": "^3.0.0",
4040
"@monaco-editor/react": "^4.3.1",
4141
"@reduxjs/toolkit": "^1.7.1",

0 commit comments

Comments
 (0)