chore: bump docusaurus, use docusaurus/preset-classic #4960

Josh-Cena · 2022-05-11T05:42:56Z

PR Checklist

Addresses an existing open issue: fixes #000
That issue was marked as accepting prs
Steps in CONTRIBUTING.md were taken

Overview

Since we are considering adding a blog (#4957), we will be enjoying all features that preset-classic provides by then. It will be sensible for us to use the preset instead, so we don't need to manage so many dependencies individually.

There are no breaking changes that impact us, but I've made a few little refactors.

nx-cloud · 2022-05-11T05:42:57Z

☁️ Nx Cloud Report

CI is running/has finished running commands for commit 1d5b555. As they complete they will appear below. Click to see the status, the terminal output, and the build insights.

📂 See all runs for this branch

✅ Successfully ran 43 targets

Sent with 💌 from NxCloud.

typescript-eslint · 2022-05-11T05:42:59Z

Thanks for the PR, @Josh-Cena!

typescript-eslint is a 100% community driven project, and we are incredibly grateful that you are contributing to that community.

The core maintainers work on this in their personal time, so please understand that it may not be possible for them to review your work immediately.

Thanks again!

🙏 Please, if you or your company is finding typescript-eslint valuable, help us sustain the project by sponsoring it transparently on https://opencollective.com/typescript-eslint. As a thank you, your profile/company logo will be added to our main README which receives thousands of unique visitors per day.

netlify · 2022-05-11T05:43:02Z

✅ Deploy Preview for typescript-eslint ready!

Name	Link
🔨 Latest commit	`1d5b555`
🔍 Latest deploy log	https://app.netlify.com/sites/typescript-eslint/deploys/6281bcdf78f2510008dc4415
😎 Deploy Preview	https://deploy-preview-4960--typescript-eslint.netlify.app
📱 Preview on mobile	Toggle QR Code... Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site settings.

Josh-Cena · 2022-05-11T05:43:48Z

packages/website/docusaurus.config.js

+      /** @type {import('@docusaurus/preset-classic').Options} */
+      ({


JSDoc only works if you wrap the object literal with brackets. In the latest version, we've added actual JSDoc documentation to all APIs, so it's good if we can do it properly.

Josh-Cena · 2022-05-11T05:44:41Z

packages/website/src/css/custom.css

@@ -60,17 +61,7 @@ html[data-theme='dark']:root {
  scrollbar-color: #454a4d #202324;

  --docsearch-muted-color: #aaa;
-}
-
-.docusaurus-highlight-code-line {


This is a breaking change: the class name has been removed in Docusaurus. We are using CSS vars instead. But AFAIK it won't impact us because it seems we are not using code line highlighting.

Josh-Cena · 2022-05-11T05:44:57Z

packages/website/src/css/prism.css

@@ -56,8 +56,8 @@ html[data-theme='dark'] {
  --token-color-highlight: rgba(247, 235, 198, 0.2);
 }

-div[class*='codeBlockContainer'],
-div[class*='codeBlockContainer'] pre {
+.theme-code-block,


This is a more stable class name and is recommended.

Josh-Cena · 2022-05-11T05:45:38Z

packages/website/src/theme/prism-include-languages.js

+export default function prismIncludeLanguages(PrismObject) {
+  const {
+    themeConfig: { prism },
+  } = siteConfig;
+  const { additionalLanguages } = prism;
+  globalThis.Prism = PrismObject;

-    additionalLanguages.forEach(lang => {
-      require(`prismjs/components/prism-${lang}`); // eslint-disable-line
-    });
+  additionalLanguages.forEach(lang => {
+    require(`prismjs/components/prism-${lang}`); // eslint-disable-line
+  });

-    require(`../prism/language/jsonc`);
-    delete window.Prism;
-  }
-};
-
-export default prismIncludeLanguages;
+  require(`../prism/language/jsonc`);
+  delete globalThis.Prism;
+}


Backporting changes from upstream. By using globalThis, we can now support server-side rendering of custom languages as well.

codecov · 2022-05-11T05:55:38Z

Codecov Report

Merging #4960 (089d1cb) into main (77e15a9) will decrease coverage by 0.85%.
The diff coverage is n/a.

❗ Current head 089d1cb differs from pull request most recent head 1d5b555. Consider uploading reports for the commit 1d5b555 to get more accurate results

@@            Coverage Diff             @@
##             main    #4960      +/-   ##
==========================================
- Coverage   92.64%   91.78%   -0.86%     
==========================================
  Files         190      228      +38     
  Lines       10251    10633     +382     
  Branches     3249     3289      +40     
==========================================
+ Hits         9497     9760     +263     
- Misses        502      591      +89     
- Partials      252      282      +30

Flag	Coverage Δ
unittest	`91.78% <ø> (-0.86%)`	⬇️

Flags with carried forward coverage won't be shown. Click here to find out more.

Impacted Files	Coverage Δ
packages/utils/src/ts-eslint-scope/index.ts	`18.18% <0.00%> (ø)`
...s/utils/src/eslint-utils/batchedSingleLineTests.ts	`91.66% <0.00%> (ø)`
...ckages/utils/src/eslint-utils/getParserServices.ts	`20.00% <0.00%> (ø)`
packages/utils/src/eslint-utils/applyDefault.ts	`100.00% <0.00%> (ø)`
packages/utils/src/ts-eslint-scope/analyze.ts	`100.00% <0.00%> (ø)`
packages/utils/src/ts-eslint/index.ts	`11.11% <0.00%> (ø)`
...utils/src/ast-utils/eslint-utils/PatternMatcher.ts	`100.00% <0.00%> (ø)`
packages/utils/src/eslint-utils/RuleTester.ts	`11.62% <0.00%> (ø)`
packages/visitor-keys/src/get-keys.ts	`100.00% <0.00%> (ø)`
packages/utils/src/eslint-utils/deepMerge.ts	`89.47% <0.00%> (ø)`
... and 28 more

Josh-Cena · 2022-05-11T06:01:54Z

I think the reason why Cypress tests always fail on version bump PRs is because the cache is invalidated, causing yarn start to take longer than necessary.

Josh-Cena · 2022-05-11T06:38:05Z

packages/website/src/css/prism.css

-  background-color: var(--token-background);
+.theme-code-block,
+.theme-code-block pre {
+  color: var(--token-color) !important;


This is to work around a Docusaurus bug: facebook/docusaurus#3678

I'd still recommend to use the theme-code-block class name, even if it means using !important...

JoshuaKGoldberg · 2022-05-16T02:53:48Z

packages/website/src/clientModules.js

-if (typeof window !== 'undefined') {
+import ExecutionEnvironment from '@docusaurus/ExecutionEnvironment';
+
+if (ExecutionEnvironment.canUseDOM) {


Ha, I remember bumping into this discussion! Glad it's resolved 🙂

Except that ExecutionEnvironment.canUseDOM does exactly the same thing as typeof window !== 'undefined' (except doing a few more checks) 🤦‍♂️

It's now officially made its way to the docs, now that client modules are finalized and published: https://docusaurus.io/docs/advanced/client#:~:text=remember%20to%20check%20the%20execution%20environment

JoshuaKGoldberg

Fantastic, thanks so much @Josh-Cena (as always)! 👏

Josh-Cena commented May 11, 2022

View reviewed changes

Josh-Cena changed the title ~~chore: bump docusaurus, use preset-classic~~ chore: bump docusaurus, use docusaurus/preset-classic May 11, 2022

chore: bump docusaurus, use preset-classic

feac4f8

Josh-Cena force-pushed the upgrade-docusaurus branch from 089d1cb to feac4f8 Compare May 11, 2022 05:56

refactor: add important

240d3cf

bradzacher added the repo maintenance things to do with maintenance of the repo, and not with code/docs label May 11, 2022

Josh-Cena commented May 11, 2022

View reviewed changes

bradzacher requested review from JoshuaKGoldberg and armano2 May 11, 2022 06:39

JoshuaKGoldberg reviewed May 16, 2022

View reviewed changes

Merge branch 'main' into upgrade-docusaurus

1d5b555

JoshuaKGoldberg approved these changes May 16, 2022

View reviewed changes

JoshuaKGoldberg enabled auto-merge (squash) May 16, 2022 02:54

JoshuaKGoldberg merged commit 03577a6 into typescript-eslint:main May 16, 2022

Josh-Cena deleted the upgrade-docusaurus branch May 16, 2022 03:12

github-actions bot locked as resolved and limited conversation to collaborators Jun 16, 2022

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

chore: bump docusaurus, use docusaurus/preset-classic #4960

chore: bump docusaurus, use docusaurus/preset-classic #4960

Josh-Cena commented May 11, 2022 •

edited

nx-cloud bot commented May 11, 2022 •

edited

typescript-eslint bot commented May 11, 2022

netlify bot commented May 11, 2022 •

edited

Josh-Cena May 11, 2022 •

edited

Josh-Cena May 11, 2022 •

edited

Josh-Cena May 11, 2022

Josh-Cena May 11, 2022

codecov bot commented May 11, 2022 •

edited

Josh-Cena commented May 11, 2022

Josh-Cena May 11, 2022 •

edited

JoshuaKGoldberg May 16, 2022

Josh-Cena May 16, 2022

JoshuaKGoldberg left a comment

		/** @type {import('@docusaurus/preset-classic').Options} */
		({

chore: bump docusaurus, use docusaurus/preset-classic #4960

chore: bump docusaurus, use docusaurus/preset-classic #4960

Conversation

Josh-Cena commented May 11, 2022 • edited

PR Checklist

Overview

nx-cloud bot commented May 11, 2022 • edited

☁️ Nx Cloud Report

typescript-eslint bot commented May 11, 2022

netlify bot commented May 11, 2022 • edited

✅ Deploy Preview for typescript-eslint ready!

Josh-Cena May 11, 2022 • edited

Choose a reason for hiding this comment

Josh-Cena May 11, 2022 • edited

Choose a reason for hiding this comment

Josh-Cena May 11, 2022

Choose a reason for hiding this comment

Josh-Cena May 11, 2022

Choose a reason for hiding this comment

codecov bot commented May 11, 2022 • edited

Codecov Report

Josh-Cena commented May 11, 2022

Josh-Cena May 11, 2022 • edited

Choose a reason for hiding this comment

JoshuaKGoldberg May 16, 2022

Choose a reason for hiding this comment

Josh-Cena May 16, 2022

Choose a reason for hiding this comment

JoshuaKGoldberg left a comment

Choose a reason for hiding this comment

Josh-Cena commented May 11, 2022 •

edited

nx-cloud bot commented May 11, 2022 •

edited

netlify bot commented May 11, 2022 •

edited

Josh-Cena May 11, 2022 •

edited

Josh-Cena May 11, 2022 •

edited

codecov bot commented May 11, 2022 •

edited

Josh-Cena May 11, 2022 •

edited