chore: Switch from lerna to turborepo

Author: cmfcmf

.github/workflows/main.yml

@@ -13,7 +13,10 @@ jobs:
       matrix:
         node-version: [16.x, 18.x]
         docusaurus-version:
+          - "v2.3.1"
           - "v2.2.0"
+          - "v2.1.0"
+          - "v2.0.1"
           - "canary"
 
     steps:
@@ -22,29 +25,26 @@ jobs:
       uses: actions/setup-node@v2
       with:
         node-version: ${{ matrix.node-version }}
-        cache: 'yarn'
+        cache: 'npm'
 
-    - run: yarn install --frozen-lockfile
-    - run: yarn lint
+    - run: npm ci
+    - run: npm run lint
 
-    - run: yarn -W add '@docusaurus/core@${{ matrix.docusaurus-version }}' '@docusaurus/preset-classic@${{ matrix.docusaurus-version }}'
-    - run: yarn --cwd packages/docusaurus-search-local add --dev '@docusaurus/module-type-aliases@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-blog@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-docs@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-pages@${{ matrix.docusaurus-version }}' '@docusaurus/theme-common@${{ matrix.docusaurus-version }}' '@docusaurus/theme-classic@${{ matrix.docusaurus-version }}' '@docusaurus/types@${{ matrix.docusaurus-version }}'
+    - run: npm install --workspaces --save-dev '@docusaurus/core@${{ matrix.docusaurus-version }}' '@docusaurus/preset-classic@${{ matrix.docusaurus-version }}' '@docusaurus/module-type-aliases@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-blog@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-docs@${{ matrix.docusaurus-version }}' '@docusaurus/plugin-content-pages@${{ matrix.docusaurus-version }}' '@docusaurus/theme-common@${{ matrix.docusaurus-version }}' '@docusaurus/theme-classic@${{ matrix.docusaurus-version }}' '@docusaurus/types@${{ matrix.docusaurus-version }}'
+    - run: npm dedupe
 
-    - run: yarn --cwd packages/docusaurus-search-local build:server
-    - run: yarn --cwd packages/docusaurus-search-local build:client
+    - run: npm run build
+
+    - run: npm run test
 
     # Install OS dependencies
     # Run `apt update` beforehand to avoid 404 Not Found errors during apt install.
-    - run: sudo apt update && yarn playwright install-deps
+    - run: sudo apt update && npx playwright install-deps
     # Install Browsers
-    - run: yarn playwright install
-
-    - run: yarn --cwd packages/example-docs build
-    - run: yarn test
-    - run: yarn --cwd packages/example-docs serve &
-    - run: yarn test:e2e --browser=all
+    - run: npx playwright install
+    - run: npm run test:e2e -- -- --browser=all --forbid-only
 
     # TODO: Cannot run browser tests for these for now.
-    - run: yarn --cwd packages/example-docs build --config docusaurus.config.noTrailingSlash.js
-    - run: yarn --cwd packages/example-docs build --config docusaurus.config.subDirectory.js
-    - run: yarn --cwd packages/example-docs build --config docusaurus.config.noTrailingSlashSubdirectory.js
+    - run: npm run build -w example-docs -- --config docusaurus.config.noTrailingSlash.js
+    - run: npm run build -w example-docs -- --config docusaurus.config.subDirectory.js
+    - run: npm run build -w example-docs -- --config docusaurus.config.noTrailingSlashSubdirectory.js

.gitignore

@@ -1,6 +1,7 @@
 /packages/docusaurus-search-local/src/client/theme/SearchBar/generated.js
 /packages/docusaurus-search-local/lib
 /scripts/preview.webm
+.turbo
 
 # Created by https://www.gitignore.io/api/node
 # Edit at https://www.gitignore.io/?templates=node

.syncpackrc

@@ -0,0 +1,30 @@
+{
+  "versionGroups": [
+    {
+      "label": "Example Docs must always use the local version of the search plugin",
+      "packages": ["example-docs"],
+      "dependencies": ["@cmfcmf/docusaurus-search-local"],
+      "pinVersion": "*"
+    },
+    {
+      "label": "The Docusaurus dev dependencies must all have the highest version supported by the plugin.",
+      "packages": ["**"],
+      "dependencies": ["@docusaurus/**"],
+      "dependencyTypes": ["dev"],
+      "pinVersion": "^2.3.1"
+    },
+    {
+      "label": "The Docusaurus peer dependencies must all have the lowest version supported by the plugin.",
+      "packages": ["**"],
+      "dependencies": ["@docusaurus/**"],
+      "dependencyTypes": ["peer"],
+      "pinVersion": "^2.0.0"
+    },
+    {
+      "label": "All dependencies should follow the versions of the search plugin",
+      "packages": ["**"],
+      "dependencies": ["**"],
+      "snapTo": ["@cmfcmf/docusaurus-search-local"]
+    }
+  ]
+}

.vscode/settings.json

@@ -3,5 +3,5 @@
     "lib/**": true,
     "example-docs/**": true
   },
-  "jest.jestCommandLine": "yarn test"
+  "jest.jestCommandLine": "npx turbo test --",
 }

CONTRIBUTING.md

@@ -5,14 +5,13 @@ Thank you for your interest in contributing to the project!
 To get up and running, follow these steps:
 
 1. Clone the repository
-2. Install dependencies: `yarn install`
-3. Build everthing `yarn build`
-4. Run tests: `yarn test`
+2. Install dependencies: `npm install`
+3. Build everything `npm run build`
+4. Run tests: `npm run test`
 5. Run end to end tests using Playwright:
    ```bash
-   yarn build-and-serve
-   # in another terminal:
-   yarn test:e2e # add --debug to step through the tests
+   npm run test:e2e # add `-- -- --debug` to step through the tests
    ```
+6. Test search manually: `npm run serve`
 
 You can view debug information at http://localhost:3000/\_\_docusaurus/debug (generated by [@docusaurus/plugin-debug](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-debug))

README.md

@@ -26,13 +26,13 @@ Feature Highlights:
 ## Installation
 
 ```bash
-yarn add @cmfcmf/docusaurus-search-local
+npm install @cmfcmf/docusaurus-search-local
 ```
 
 or
 
 ```bash
-npm install @cmfcmf/docusaurus-search-local
+yarn add @cmfcmf/docusaurus-search-local
 ```
 
 ## Usage
@@ -131,10 +131,10 @@ The following options are available (defaults are shown below):
 
 You can now use the search bar to search your documentation.
 
-**Important: Search only works for the statically built documentation (i.e., after you ran `yarn build` in your documentation folder).**
+**Important: Search only works for the statically built documentation (i.e., after you ran `npm run docusaurus build` in your documentation folder).**
 
-**Search does **not** work in development (i.e., when running `yarn start`).**
-If you want to test search locally, first build the documentation with `yarn build`, and then serve it via `yarn serve`.
+**Search does **not** work in development (i.e., when running `npm run docusaurus start`).**
+If you want to test search locally, first build the documentation with `npm run docusaurus build`, and then serve it via `npm run docusaurus serve`.
 
 ### Non-English Documentation
 
@@ -164,7 +164,7 @@ Read more at: https://docusaurus.io/docs/i18n/tutorial#translate-json-files
 
 If building your documentation produces an error, you can build it in debug mode to figure out
 which page is causing it. To do so, simply set the `DEBUG` environment variable when building
-your documentation: `DEBUG=1 yarn build`.
+your documentation: `DEBUG=1 npm run docusaurus build`.
 
 ## CONTRIBUTING