Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix(tsconfig): add @docusaurus/tsconfig target es2022 #10547

Merged
merged 1 commit into from
Oct 3, 2024

Conversation

slorber
Copy link
Collaborator

@slorber slorber commented Oct 3, 2024

Motivation

Sites using TypeScript should support TS syntax up to ES2022 as a reasonable default.

Also advised in https://www.totaltypescript.com/tsconfig-cheat-sheet

It's only a default, that I think has been forgotten when creating the initial @docusaurus/tsconfig package, so I consider this as a bugfix.
(users can revert it to the "es5" default TS value if they want)

Now it's hard to find a "perfect" default because feature support increases other time and we are not sure if users will use TS for Node or React theme code.

I noticed this lack of a better default while working on Rspack with skipLibCheck=false leading to errors such as:

CleanShot 2024-10-03 at 15 10 24@2x

Test Plan

CI

Test links

https://deploy-preview-10547--docusaurus-2.netlify.app/

@slorber slorber added the pr: bug fix This PR fixes a bug in a past release. label Oct 3, 2024
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Oct 3, 2024
Copy link

netlify bot commented Oct 3, 2024

[V2]

Name Link
🔨 Latest commit f1500c0
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/66fe98594971db00073f7fd9
😎 Deploy Preview https://deploy-preview-10547--docusaurus-2.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

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

Copy link

github-actions bot commented Oct 3, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO Report
/ 🟠 70 🟢 98 🟢 96 🟢 100 Report
/docs/installation 🟠 55 🟢 97 🟢 100 🟢 100 Report
/docs/category/getting-started 🟠 74 🟢 100 🟢 100 🟠 86 Report
/blog 🟠 64 🟢 96 🟢 96 🟠 86 Report
/blog/preparing-your-site-for-docusaurus-v3 🔴 47 🟢 92 🟢 100 🟢 100 Report
/blog/tags/release 🟠 65 🟢 96 🟢 96 🟠 86 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟠 86 Report

Copy link

github-actions bot commented Oct 3, 2024

Size Change: +228 B (0%)

Total Size: 11.6 MB

ℹ️ View Unchanged
Filename Size Change
website/.docusaurus/codeTranslations.json 2 B 0 B
website/.docusaurus/docusaurus.config.mjs 27.9 kB 0 B
website/.docusaurus/globalData.json 30.2 kB 0 B
website/.docusaurus/i18n.json 930 B 0 B
website/.docusaurus/registry.js 155 kB 0 B
website/.docusaurus/routes.js 74.3 kB 0 B
website/.docusaurus/routesChunkNames.json 81.7 kB 0 B
website/.docusaurus/site-metadata.json 2.17 kB 0 B
website/build/assets/css/styles.********.css 119 kB 0 B
website/build/assets/js/main.********.js 666 kB 0 B
website/build/assets/js/runtime~main.********.js 35.1 kB 0 B
website/build/blog.html 61.3 kB 0 B
website/build/blog/2017/12/14/introducing-docusaurus.html 74.7 kB -1 B (0%)
website/build/blog/2018/04/30/How-I-Converted-Profilo-To-Docusaurus.html 47.3 kB +11 B (+0.02%)
website/build/blog/2018/09/11/Towards-Docusaurus-2.html 51.7 kB -1 B (0%)
website/build/blog/2018/12/14/Happy-First-Birthday-Slash.html 30.4 kB -1 B (0%)
website/build/blog/2019/12/30/docusaurus-2019-recap.html 39.6 kB -2 B (-0.01%)
website/build/blog/2020/01/07/tribute-to-endi.html 34 kB -1 B (0%)
website/build/blog/2021/01/19/docusaurus-2020-recap.html 48.9 kB -1 B (0%)
website/build/blog/2021/03/09/releasing-docusaurus-i18n.html 45.1 kB -2 B (0%)
website/build/blog/2021/05/12/announcing-docusaurus-two-beta.html 47.5 kB -1 B (0%)
website/build/blog/2021/11/21/algolia-docsearch-migration.html 52.9 kB +11 B (+0.02%)
website/build/blog/2022/01/24/docusaurus-2021-recap.html 44.5 kB -1 B (0%)
website/build/blog/2022/08/01/announcing-docusaurus-2.0.html 139 kB -1 B (0%)
website/build/blog/2022/09/01/docusaurus-2.1.html 50.9 kB -2 B (0%)
website/build/blog/archive.html 24.7 kB 0 B
website/build/blog/authors.html 46.5 kB 0 B
website/build/blog/authors/j-marcey.html 65 kB 0 B
website/build/blog/authors/josh-cena.html 43 kB 0 B
website/build/blog/authors/lex-111.html 50.2 kB 0 B
website/build/blog/authors/slorber.html 61.5 kB 0 B
website/build/blog/authors/slorber/authors/2.html 65.4 kB 0 B
website/build/blog/authors/slorber/authors/3.html 77.7 kB 0 B
website/build/blog/authors/slorber/authors/4.html 44.7 kB 0 B
website/build/blog/authors/yangshun.html 57.8 kB 0 B
website/build/blog/authors/zpao.html 43.5 kB 0 B
website/build/blog/page/2.html 66 kB 0 B
website/build/blog/page/3.html 71.7 kB 0 B
website/build/blog/page/4.html 64.2 kB 0 B
website/build/blog/page/5.html 41.8 kB 0 B
website/build/blog/preparing-your-site-for-docusaurus-v3.html 138 kB -2 B (0%)
website/build/blog/releases/2.2.html 49.6 kB -1 B (0%)
website/build/blog/releases/2.3.html 60.8 kB -1 B (0%)
website/build/blog/releases/2.4.html 65.3 kB -1 B (0%)
website/build/blog/releases/3.0.html 111 kB +11 B (+0.01%)
website/build/blog/releases/3.1.html 52 kB 0 B
website/build/blog/releases/3.2.html 48.8 kB -1 B (0%)
website/build/blog/releases/3.3.html 55.5 kB -1 B (0%)
website/build/blog/releases/3.4.html 55.8 kB +6 B (+0.01%)
website/build/blog/releases/3.5.html 58 kB 0 B
website/build/blog/tags.html 28.5 kB 0 B
website/build/blog/upgrading-frontend-dependencies-with-confidence-using-visual-regression-testing.html 128 kB -1 B (0%)
website/build/docs.html 49.2 kB -1 B (0%)
website/build/docs/advanced.html 31.1 kB -1 B (0%)
website/build/docs/advanced/architecture.html 30.7 kB +3 B (+0.01%)
website/build/docs/advanced/client.html 76 kB -1 B (0%)
website/build/docs/advanced/plugins.html 58.6 kB -1 B (0%)
website/build/docs/advanced/routing.html 73.9 kB +7 B (+0.01%)
website/build/docs/advanced/ssg.html 81.5 kB -1 B (0%)
website/build/docs/api/docusaurus-config.html 202 kB -1 B (0%)
website/build/docs/api/misc/@docusaurus/eslint-plugin.html 48.3 kB +3 B (+0.01%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/no-html-links.html 38.1 kB -1 B (0%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/no-untranslated-text.html 37 kB -1 B (0%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/prefer-docusaurus-heading.html 38.3 kB +3 B (+0.01%)
website/build/docs/api/misc/@docusaurus/eslint-plugin/string-literal-i18n-messages.html 41.9 kB -1 B (0%)
website/build/docs/api/misc/@docusaurus/logger.html 39.8 kB -1 B (0%)
website/build/docs/api/misc/create-docusaurus.html 34.9 kB -1 B (0%)
website/build/docs/api/plugin-methods.html 67.4 kB +3 B (0%)
website/build/docs/api/plugin-methods/extend-infrastructure.html 63 kB +3 B (0%)
website/build/docs/api/plugin-methods/i18n-lifecycles.html 60.6 kB +3 B (0%)
website/build/docs/api/plugin-methods/lifecycle-apis.html 170 kB -1 B (0%)
website/build/docs/api/plugin-methods/static-methods.html 46.5 kB +3 B (+0.01%)
website/build/docs/api/plugins.html 31.6 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-client-redirects.html 62.6 kB +12 B (+0.02%)
website/build/docs/api/plugins/@docusaurus/plugin-content-blog.html 198 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-content-docs.html 202 kB +8 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-content-pages.html 78 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-debug.html 50.5 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-google-analytics.html 51.5 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-google-gtag.html 51 kB -5 B (-0.01%)
website/build/docs/api/plugins/@docusaurus/plugin-google-tag-manager.html 49.8 kB -1 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-ideal-image.html 51.1 kB +3 B (+0.01%)
website/build/docs/api/plugins/@docusaurus/plugin-pwa.html 122 kB +3 B (0%)
website/build/docs/api/plugins/@docusaurus/plugin-sitemap.html 68.5 kB +5 B (+0.01%)
website/build/docs/api/plugins/@docusaurus/plugin-vercel-analytics.html 42.2 kB +11 B (+0.03%)
website/build/docs/api/themes.html 30.4 kB -1 B (0%)
website/build/docs/api/themes/@docusaurus/theme-classic.html 46.4 kB +3 B (+0.01%)
website/build/docs/api/themes/@docusaurus/theme-live-codeblock.html 38.6 kB +3 B (+0.01%)
website/build/docs/api/themes/@docusaurus/theme-mermaid.html 37.5 kB +3 B (+0.01%)
website/build/docs/api/themes/@docusaurus/theme-search-algolia.html 34.7 kB -1 B (0%)
website/build/docs/api/themes/configuration.html 256 kB -1 B (0%)
website/build/docs/blog.html 219 kB +5 B (0%)
website/build/docs/browser-support.html 51 kB -1 B (0%)
website/build/docs/category/getting-started.html 28.3 kB 0 B
website/build/docs/category/guides.html 36.4 kB 0 B
website/build/docs/cli.html 63.8 kB 0 B
website/build/docs/configuration.html 103 kB +7 B (+0.01%)
website/build/docs/create-doc.html 65.3 kB +11 B (+0.02%)
website/build/docs/creating-pages.html 59.1 kB 0 B
website/build/docs/deployment.html 211 kB +7 B (0%)
website/build/docs/docs-introduction.html 53.6 kB -1 B (0%)
website/build/docs/docs-multi-instance.html 78.7 kB +3 B (0%)
website/build/docs/docusaurus-core.html 245 kB -1 B (0%)
website/build/docs/guides/whats-next.html 32.8 kB -1 B (0%)
website/build/docs/i18n/crowdin.html 151 kB +11 B (+0.01%)
website/build/docs/i18n/git.html 82.6 kB +3 B (0%)
website/build/docs/i18n/introduction.html 50.7 kB -1 B (0%)
website/build/docs/i18n/tutorial.html 171 kB +12 B (+0.01%)
website/build/docs/installation.html 74.2 kB +4 B (+0.01%)
website/build/docs/introduction/index.html 280 B 0 B
website/build/docs/markdown-features.html 83.2 kB 0 B
website/build/docs/markdown-features/admonitions.html 118 kB +3 B (0%)
website/build/docs/markdown-features/assets.html 93.5 kB +1 B (0%)
website/build/docs/markdown-features/code-blocks.html 245 kB +3 B (0%)
website/build/docs/markdown-features/diagrams.html 56 kB +13 B (+0.02%)
website/build/docs/markdown-features/head-metadata.html 52.8 kB -1 B (0%)
website/build/docs/markdown-features/links.html 43.1 kB -1 B (0%)
website/build/docs/markdown-features/math-equations.html 95.4 kB +10 B (+0.01%)
website/build/docs/markdown-features/plugins.html 101 kB +7 B (+0.01%)
website/build/docs/markdown-features/react.html 144 kB +4 B (0%)
website/build/docs/markdown-features/tabs.html 148 kB -1 B (0%)
website/build/docs/markdown-features/toc.html 88.8 kB +3 B (0%)
website/build/docs/migration.html 43 kB -2 B (0%)
website/build/docs/migration/v2.html 41.2 kB -1 B (0%)
website/build/docs/migration/v2/automated.html 42.6 kB -1 B (0%)
website/build/docs/migration/v2/manual.html 207 kB -1 B (0%)
website/build/docs/migration/v2/translated-sites.html 52.8 kB -1 B (0%)
website/build/docs/migration/v2/versioned-sites.html 67.2 kB -1 B (0%)
website/build/docs/migration/v3.html 218 kB 0 B
website/build/docs/playground.html 32.5 kB -1 B (0%)
website/build/docs/resources/index.html 325 B 0 B
website/build/docs/search.html 121 kB 0 B
website/build/docs/seo.html 93 kB +12 B (+0.01%)
website/build/docs/sidebar.html 136 kB +3 B (0%)
website/build/docs/sidebar/autogenerated.html 156 kB +12 B (+0.01%)
website/build/docs/sidebar/items.html 188 kB -1 B (0%)
website/build/docs/sidebar/multiple-sidebars.html 67.1 kB +3 B (0%)
website/build/docs/static-assets.html 56.2 kB +3 B (+0.01%)
website/build/docs/styling-layout.html 141 kB -1 B (0%)
website/build/docs/support/index.html 319 B 0 B
website/build/docs/swizzling.html 120 kB +13 B (+0.01%)
website/build/docs/team/index.html 310 B 0 B
website/build/docs/typescript-support.html 65.4 kB -1 B (0%)
website/build/docs/using-plugins.html 115 kB +12 B (+0.01%)
website/build/docs/versioning.html 87.1 kB +12 B (+0.01%)
website/build/index.html 37.7 kB 0 B

compressed-size-action

@slorber slorber merged commit 5de4832 into main Oct 3, 2024
37 checks passed
@slorber slorber deleted the slorber/add-tsconfig-target-es2022 branch October 3, 2024 13:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
CLA Signed Signed Facebook CLA pr: bug fix This PR fixes a bug in a past release.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants