Bump docusaurus to `3.0.0-alpha.0` #1745

pokey · 2023-08-08T11:03:55Z

We have some security warnings on a couple packages that are dependencies of docusaurus, so I decided to upgrade to the latest to remove those dependencies. Docusaurus uses their nightly version on their own docs, and things seem to work for us on this version with no issue, so I think it's ok. In addition, we were violating their peer dependencies by using react 18; we now no longer need to do that. Also, this version allows us to use mdx v2, which has a lot of niceties that we'll probably want as we do our big docs refactor (#867)

depends on Stop publishing API docs #1750 to fix typedoc failure

Checklist

I have added tests
I have updated the docs and cheatsheet
I have not broken the cheatsheet

pokey · 2023-08-08T11:04:29Z

package.json

-        "@docusaurus/mdx-loader",
-        "@docusaurus/plugin-content-blog",
-        "@docusaurus/preset-classic"
+        "react-json-view"


We still need this peer dependency override until facebook/docusaurus#9116 is released

pokey · 2023-08-08T11:04:55Z

package.json

@@ -41,14 +41,11 @@
  },
  "pnpm": {
    "patchedDependencies": {
-      "@docusaurus/theme-search-algolia@2.3.1": "patches/@docusaurus__theme-search-algolia@2.3.1.patch"
+      "@docusaurus/theme-search-algolia@3.0.0-alpha.0": "patches/@docusaurus__theme-search-algolia@2.3.1.patch"


this patch seemed to apply cleanly, and still is having the intended effect in local testing, so that's a relief 😅

pokey · 2023-08-08T11:06:46Z

pnpm-lock.yaml

@auscompgeek anything jump out at you here?

pokey · 2023-08-08T11:24:11Z

packages/meta-updater/src/updateTSConfig.ts

-    extends: toPosixPath(
-      path.join(pathFromPackageToRoot, "tsconfig.base.json"),
-    ),
+    extends: getExtends(pathFromPackageToRoot, input.extends),


need this because we are now extending docusaurus tsconfig in our docs site

- Fixes #1749 - Will do a `pnpm remove` on all our typedoc dependencies once #1745 is merged so we don't get massive merge conflicts on our `pnpm.lock` 😅 - Our website deploy has gone from more than 12 minutes to 1 min 20 sec 🙌 ## Checklist - [ ] I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/) - [ ] I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet) - [ ] I have not broken the cheatsheet

#1745 is almost impossible to review 😅 I'd suggest running `pnpm dedupe` on the PR but it turns out `main` has a whole bunch of duplicate transitive deps too, so running it against `main` first. ## Checklist - [ ] ~I have added [tests](https://www.cursorless.org/docs/contributing/test-case-recorder/)~ - [ ] ~I have updated the [docs](https://github.com/cursorless-dev/cursorless/tree/main/docs) and [cheatsheet](https://github.com/cursorless-dev/cursorless/tree/main/cursorless-talon/src/cheatsheet)~ - [ ] I have not broken the cheatsheet

pokey · 2023-08-09T11:09:36Z

ok @auscompgeek I've merged your dedupe. Fwiw I just ran a dedupe on this branch and did a soft reset over your dedupe; didn't feel like fighting with merge conflicts in pnpm lockfile 😅

auscompgeek · 2023-08-09T11:10:42Z

Yep makes sense, I think the end result should be the same however you slice it 😄

auscompgeek

Nothing that leapt out as majorly alarming to me. Left some comments on the more curious new deps coming in (although the comments are a bit of a stream of consciousness).

A few cases where there's -1 +1 versions of a dep, largely different semver major versions (judging by the node engine constraints on them, I'm guessing ES6 conversions or something). A few cases where we have one fewer version of an existing dep though, which is good to see.

auscompgeek · 2023-08-09T11:16:11Z

pnpm-lock.yaml


-  /@babel/core@7.21.4:
-    resolution: {integrity: sha512-qt/YV149Jman/6AfmlxJ04LMIu8bMoyl3RB91yTFrxQmgbrSvQMy7cI8Q62FHx1t8wJ8B5fu0UDoLwHAhUo1QA==}
+  /@babel/core@7.22.10:


Interesting, we had two versions of @babel/core. Looks like the old come was being pulled in by mdx

auscompgeek · 2023-08-09T11:31:27Z

pnpm-lock.yaml

-  /@mdx-js/mdx@1.6.22:
-    resolution: {integrity: sha512-AMxuLxPz2j5/6TpF/XSdKpQP1NlG0z11dFOlq+2IP/lSgl11GY8ji6S/rgsViN/L0BDvHvUMruRb7ub+24LUYA==}
-    dependencies:
-      '@babel/core': 7.12.9


Ah, mdx 1 had babel 7.12 pinned. Looks like it doesn't depend on babel any more - pulling in estree instead.

auscompgeek · 2023-08-09T11:34:43Z

pnpm-lock.yaml

@@ -3886,7 +3820,11 @@ packages:
    engines: {node: '>=12.22.0'}
    dev: true

-  /@pnpm/config@16.6.4(@pnpm/logger@5.0.0)(@yarnpkg/core@4.0.0-rc.14)(typanion@3.12.1):
+  /@pnpm/config.env-replace@1.1.0:


interesting, pulling in a second version of this, weird

auscompgeek · 2023-08-09T11:35:35Z

pnpm-lock.yaml

      '@pnpm/network.ca-file': 1.0.2
      config-chain: 1.1.13
    dev: true

-  /@pnpm/npm-lifecycle@2.0.0(typanion@3.12.1):
+  /@pnpm/npm-conf@2.2.2:


another second version too

auscompgeek · 2023-08-09T11:40:25Z

pnpm-lock.yaml

  /@szmarczak/http-timer@4.0.6:
    resolution: {integrity: sha512-4BAffykYOgO+5nzBWYwE3W90sBgLJoUPRWWcL8wlyiM8IB8ipJz3UMJ9KXQd1RKQXpKp8Tutn80HZtWsu2u76w==}
    engines: {node: '>=10'}
    dependencies:
      defer-to-connect: 2.0.1
    dev: true

+  /@szmarczak/http-timer@5.0.1:


another one here too, but it's a different major version 🤷

auscompgeek · 2023-08-09T11:48:13Z

pnpm-lock.yaml

-  /cacheable-request@6.1.0:
-    resolution: {integrity: sha512-Oj3cAGPCqOZX7Rz64Uny2GYAZNliQSqfbePrgAQ1wKAihYmCUnraBtJtKcGR4xz7wF+LoJC+ssFZvv5BgF9Igg==}
-    engines: {node: '>=8'}
+  /cacheable-lookup@7.0.0:


2 major versions, hmm

auscompgeek · 2023-08-09T11:49:08Z

pnpm-lock.yaml

@@ -7115,6 +7100,11 @@ packages:
    resolution: {integrity: sha512-Gmy6FhYlCY7uOElZUSbxo2UCDH8owEk996gkbrpsgGtrJLM3J7jGxl9Ic7Qwwj4ivOE5AWZWRMecDdF7hqGjFA==}
    engines: {node: '>=10'}

+  /camelcase@7.0.1:


3 major versions...

is this what it says on the tin? 😂

If it does what it says on the tin, then the fact that we pull in 3 major versions of a one-line function is pretty much the npm ecosystem in a nutshell 😂

auscompgeek · 2023-08-09T11:52:28Z

pnpm-lock.yaml

@@ -7716,6 +7713,14 @@ packages:
  /crypto-random-string@2.0.0:
    resolution: {integrity: sha512-v1plID3y9r/lPhviJ1wrXpLeyUIGAZ2SHNYTEapm7/8A9nLPoyvVp3RK/EPFqn5kEznyWgYZNsRtYYIWbuG8KA==}
    engines: {node: '>=8'}
+    dev: true
+
+  /crypto-random-string@4.0.0:


a second major version here too.

auscompgeek · 2023-08-09T11:53:17Z

pnpm-lock.yaml

+    resolution: {integrity: sha512-x8dy3RnvYdlUcPOjkEHqozhiwzKNSq7GcPuXFbnyMOCHxX8V3OgIg/pYuabl2sbUPfIJaeAQB7PMOK8DFIdoRA==}
+    engines: {node: '>=12'}
+    dependencies:
+      type-fest: 1.4.0


that's an interesting transitive dependency 😂

Ha yeah that's...interesting. Should type-fest every be anything other than dev dependency?

yeah I don't think this should be a non-dev dependency, but I haven't checked how it's actually being used here

auscompgeek · 2023-08-09T12:00:49Z

pnpm-lock.yaml

+  /mem@6.1.1:
+    resolution: {integrity: sha512-Ci6bIfq/UgcxPTYa8dQQ5FY3BzKkT894bwXWXxC/zqs0XgMO2cT20CGkOqda7gZNkmK5VP4x89IGZ6K7hfbn3Q==}
+    engines: {node: '>=8'}
+    dependencies:
+      map-age-cleaner: 0.1.3
+      mimic-fn: 3.1.0
+    dev: true
+
+  /mem@8.1.1:


wat

... oh, github diff didn't notice these already existed?

pokey commented Aug 8, 2023

View reviewed changes

pokey requested review from auscompgeek and AndreasArvidsson August 8, 2023 11:07

pokey force-pushed the pokey/bump-docusaurus-to-300-alpha0 branch 3 times, most recently from 96e7596 to 58fbe93 Compare August 8, 2023 11:23

pokey commented Aug 8, 2023

View reviewed changes

AndreasArvidsson approved these changes Aug 8, 2023

View reviewed changes

auscompgeek mentioned this pull request Aug 8, 2023

Run pnpm dedupe #1746

Merged

3 tasks

This was referenced Aug 8, 2023

Bump our webpack version #1748

Closed

Stop publishing API docs #1750

Merged

Bump docusaurus to 3.0.0-alpha.0

a7ac988

pokey force-pushed the pokey/bump-docusaurus-to-300-alpha0 branch from 9ec62c3 to a7ac988 Compare August 9, 2023 11:06

auscompgeek approved these changes Aug 9, 2023

View reviewed changes

pokey added this pull request to the merge queue Aug 9, 2023

Merged via the queue into main with commit 16973f8 Aug 9, 2023
14 checks passed

pokey deleted the pokey/bump-docusaurus-to-300-alpha0 branch August 9, 2023 13:56

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Bump docusaurus to `3.0.0-alpha.0` #1745

Bump docusaurus to `3.0.0-alpha.0` #1745

pokey commented Aug 8, 2023 •

edited

Loading

pokey Aug 8, 2023

pokey Aug 8, 2023

pokey Aug 8, 2023

pokey Aug 8, 2023

pokey commented Aug 9, 2023

auscompgeek commented Aug 9, 2023

auscompgeek left a comment •

edited

Loading

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

pokey Aug 9, 2023 •

edited

Loading

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

pokey Aug 9, 2023

auscompgeek Aug 9, 2023

auscompgeek Aug 9, 2023

Bump docusaurus to 3.0.0-alpha.0 #1745

Bump docusaurus to 3.0.0-alpha.0 #1745

Conversation

pokey commented Aug 8, 2023 • edited Loading

Checklist

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pokey commented Aug 9, 2023

auscompgeek commented Aug 9, 2023

auscompgeek left a comment • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

pokey Aug 9, 2023 • edited Loading

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Bump docusaurus to `3.0.0-alpha.0` #1745

Bump docusaurus to `3.0.0-alpha.0` #1745

pokey commented Aug 8, 2023 •

edited

Loading

auscompgeek left a comment •

edited

Loading

pokey Aug 9, 2023 •

edited

Loading