Skip to content

Commit

Permalink
chore: Update dependencies
Browse files Browse the repository at this point in the history
BREAKING CHANGE: The minimum supported Docusaurus version is now v2.0.0-beta21
  • Loading branch information
cmfcmf committed Jun 12, 2022
1 parent ccec5d0 commit 1fe21f7
Show file tree
Hide file tree
Showing 10 changed files with 2,571 additions and 3,161 deletions.
4 changes: 2 additions & 2 deletions .github/workflows/main.yml
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@ jobs:
strategy:
fail-fast: false
matrix:
node-version: [14.x, 16.x, 17.x]
node-version: [16.x, 17.x, 18.x]
docusaurus-version:
- "v2.0.0-beta.17"
- "v2.0.0-beta.21"
- "canary"

steps:
Expand Down
2 changes: 1 addition & 1 deletion .nvmrc
Original file line number Diff line number Diff line change
@@ -1 +1 @@
14
16
4 changes: 2 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# Offline / Local Search for Docusaurus v2.0.0-beta.17+
# Offline / Local Search for Docusaurus v2.0.0-beta.21+

![Version](https://img.shields.io/npm/v/@cmfcmf/docusaurus-search-local?style=flat-square)
![License](https://img.shields.io/npm/l/@cmfcmf/docusaurus-search-local?style=flat-square)
[![code style: prettier](https://img.shields.io/badge/code_style-prettier-ff69b4.svg?style=flat-square)](https://github.com/prettier/prettier)
![GitHub issues](https://img.shields.io/github/issues/cmfcmf/docusaurus-search-local?style=flat-square)
![GitHub last commit](https://img.shields.io/github/last-commit/cmfcmf/docusaurus-search-local?style=flat-square)

Offline / local search for Docusaurus **v2.0.0-beta.17+** that works behind your firewall.
Offline / local search for Docusaurus **v2.0.0-beta.21+** that works behind your firewall.

Feature Highlights:

Expand Down
10 changes: 5 additions & 5 deletions package.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@
"packages/*"
],
"devDependencies": {
"@docusaurus/core": "^2.0.0-beta.17",
"@docusaurus/preset-classic": "^2.0.0-beta.17",
"@docusaurus/core": "^2.0.0-beta.21",
"@docusaurus/preset-classic": "^2.0.0-beta.21",
"@playwright/test": "^1.17.1",
"husky": "^7.0.4",
"lerna": "^4.0.0",
"lint-staged": "^12.1.2",
"playwright": "^1.17.1",
"react": "^17.0.2",
"react-dom": "^17.0.2"
"react": "^18.1.0",
"react-dom": "^18.1.0"
},
"scripts": {
"build": "yarn --cwd packages/docusaurus-search-local build && yarn --cwd packages/example-docs build",
Expand All @@ -30,7 +30,7 @@
]
},
"engines": {
"node": ">=14",
"node": ">=16.14",
"yarn": "<2"
}
}
30 changes: 15 additions & 15 deletions packages/docusaurus-search-local/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@
"mark.js": "^8.11.1"
},
"peerDependencies": {
"@docusaurus/core": "^v2.0.0-beta.17",
"@docusaurus/core": "^v2.0.0-beta.21",
"nodejieba": "^2.5.0"
},
"peerDependenciesMeta": {
Expand All @@ -47,34 +47,34 @@
"@babel/core": "^7.16.7",
"@babel/preset-env": "^7.16.8",
"@babel/preset-typescript": "^7.16.7",
"@docusaurus/module-type-aliases": "^2.0.0-beta.13",
"@docusaurus/plugin-content-blog": "^2.0.0-beta.13",
"@docusaurus/plugin-content-docs": "^2.0.0-beta.13",
"@docusaurus/plugin-content-pages": "^2.0.0-beta.13",
"@docusaurus/theme-classic": "^2.0.0-beta.17",
"@docusaurus/theme-common": "^2.0.0-beta.13",
"@docusaurus/types": "^2.0.0-beta.13",
"@types/jest": "^27.4.0",
"@docusaurus/module-type-aliases": "^2.0.0-beta.21",
"@docusaurus/plugin-content-blog": "^2.0.0-beta.21",
"@docusaurus/plugin-content-docs": "^2.0.0-beta.21",
"@docusaurus/plugin-content-pages": "^2.0.0-beta.21",
"@docusaurus/theme-classic": "^2.0.0-beta.21",
"@docusaurus/theme-common": "^2.0.0-beta.21",
"@docusaurus/types": "^2.0.0-beta.21",
"@types/jest": "^28.1.1",
"@types/lodash": "^4.14.178",
"@types/lunr": "^2.3.3",
"@types/mark.js": "^8.11.7",
"@types/prismjs": "^1.16.6",
"@types/react": "^17.0.38",
"@types/react-dom": "^17.0.11",
"@types/react": "^18.0.12",
"@types/react-dom": "^18.0.5",
"@types/react-helmet": "^6.1.5",
"@types/react-loadable": "^5.5.5",
"@types/react-router-config": "^5.0.6",
"@types/react-router-dom": "^5.3.3",
"@types/rtlcss": "^3.1.2",
"babel-jest": "^27.4.6",
"babel-jest": "^28.1.1",
"concurrently": "^7.0.0",
"copyfiles": "^2.4.1",
"jest": "^27.4.7",
"jest": "^28.1.1",
"nodejieba": "^2.6.0",
"nodemon": "^2.0.15",
"prettier": "^2.5.1",
"react": "^17.0.2",
"react-dom": "^17.0.2",
"react": "^18.1.0",
"react-dom": "^18.1.0",
"typescript": "^4.5.4"
},
"scripts": {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ const SearchBar = () => {
contentBoost,
parentCategoriesBoost,
indexDocSidebarParentCategories,
} = usePluginData<DSLAPluginData>("@cmfcmf/docusaurus-search-local");
} = usePluginData("@cmfcmf/docusaurus-search-local") as DSLAPluginData;

const history = useHistory<DSLALocationState>();

Expand Down
15 changes: 8 additions & 7 deletions packages/docusaurus-search-local/src/server/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,11 +7,11 @@ import type {
OptionValidationContext,
Plugin,
} from "@docusaurus/types";
import type { LoadedContent as DocsLoadedContent } from "@docusaurus/plugin-content-docs/src/types";
import type { LoadedContent as DocsLoadedContent } from "@docusaurus/plugin-content-docs";
import type { PluginOptions as DocsOptions } from "@docusaurus/plugin-content-docs";
import type { BlogContent as BlogLoadedContent } from "@docusaurus/plugin-content-blog/src/types";
import type { BlogContent as BlogLoadedContent } from "@docusaurus/plugin-content-blog";
import type { PluginOptions as BlogOptions } from "@docusaurus/plugin-content-blog";
import type { LoadedContent as PagesLoadedContent } from "@docusaurus/plugin-content-pages/src/types";
import type { LoadedContent as PagesLoadedContent } from "@docusaurus/plugin-content-pages";
import type { PluginOptions as PagesOptions } from "@docusaurus/plugin-content-pages";
import { Joi } from "@docusaurus/utils-validation";
import type { DSLAPluginData, MyDocument } from "../types";
Expand Down Expand Up @@ -293,12 +293,13 @@ export const tokenize = (input) => lunr.tokenizer(input)
return {};
},
async contentLoaded({ actions: { setGlobalData } }) {
setGlobalData<DSLAPluginData>({
const data: DSLAPluginData = {
titleBoost,
contentBoost,
parentCategoriesBoost,
indexDocSidebarParentCategories,
});
};
setGlobalData(data);
},
async postBuild({
routesPaths = [],
Expand All @@ -314,7 +315,7 @@ export const tokenize = (input) => lunr.tokenizer(input)
plugins
.filter((plugin) => plugin.name === name)
.map((plugin) => [plugin.options.id, plugin]) as Array<
[string, LoadedPlugin<Content> & { options: Options }]
[string, LoadedPlugin & { content: Content; options: Options }]
>
);
}
Expand Down Expand Up @@ -581,6 +582,6 @@ export const tokenize = (input) => lunr.tokenizer(input)
export function validateOptions({
options,
validate,
}: OptionValidationContext<MyOptions>) {
}: OptionValidationContext<MyOptions, MyOptions>) {
return validate(optionsSchema, options);
}
8 changes: 0 additions & 8 deletions packages/docusaurus-search-local/tsconfig.server.json
Original file line number Diff line number Diff line change
Expand Up @@ -5,13 +5,5 @@
"module": "CommonJS",
"lib": ["ESNext", "DOM"]
},
// TODO: Currently required, otherwise we get the following type errors:
// [server] ../../node_modules/@docusaurus/plugin-content-blog/src/plugin-content-blog.d.ts(153,34): error TS2307: Cannot find module '@theme/BlogSidebar' or its corresponding type declarations.
// [server] ../../node_modules/@docusaurus/plugin-content-blog/src/plugin-content-blog.d.ts(200,34): error TS2307: Cannot find module '@theme/BlogSidebar' or its corresponding type declarations.
// [server] ../../node_modules/@docusaurus/plugin-content-blog/src/plugin-content-blog.d.ts(224,34): error TS2307: Cannot find module '@theme/BlogSidebar' or its corresponding type declarations.
// [server] ../../node_modules/@docusaurus/plugin-content-blog/src/plugin-content-blog.d.ts(243,34): error TS2307: Cannot find module '@theme/BlogSidebar' or its corresponding type declarations.
"files": [
"../../node_modules/@docusaurus/theme-classic/lib/theme-classic.d.ts"
],
"include": ["src/server/**/*"]
}
4 changes: 2 additions & 2 deletions packages/example-docs/package.json
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@
"clsx": "^1.1.1"
},
"peerDependencies": {
"@docusaurus/core": "^2.0.0-beta.17",
"@docusaurus/preset-classic": "^2.0.0-beta.17",
"@docusaurus/core": "^2.0.0-beta.21",
"@docusaurus/preset-classic": "^2.0.0-beta.21",
"react": "^17.0.2",
"react-dom": "^17.0.2"
},
Expand Down
Loading

0 comments on commit 1fe21f7

Please sign in to comment.