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

chore: check MDX even by VS Code cspell extension #9713

Merged
merged 1 commit into from
Jan 8, 2024

Conversation

tats-u
Copy link
Contributor

@tats-u tats-u commented Jan 7, 2024

Pre-flight checklist

  • I have read the Contributing Guidelines on pull requests.
  • If this is a code change: I have written unit tests and/or added dogfooding pages to fully verify the new behavior.
  • If this is a new API or substantial change: the PR has an accompanying issue (closes #0000) and the maintainers have approved on my working plan.

Motivation

Typos in MDX files are not checked in VS Code even if we have installed the cspell extension. It works only for JS/TS and vanilla Markdowns.

Test Plan

  1. Install and enable the cspell extension for VS Code
  2. Open README.md in VS Code and add a typo there (still warned & don't save and just discard the change)
  3. Open some other MDX files and add a typo there (now warned & don't save and just discard the change)

Test links

Deploy preview: https://deploy-preview-_____--docusaurus-2.netlify.app/

Note: content has not been changed

Related issues/PRs

streetsidesoftware/vscode-spell-checker#657

@tats-u tats-u requested a review from slorber as a code owner January 7, 2024 14:55
@facebook-github-bot facebook-github-bot added the CLA Signed Signed Facebook CLA label Jan 7, 2024
Copy link

netlify bot commented Jan 7, 2024

[V2]

Built without sensitive environment variables

Name Link
🔨 Latest commit 78b3de8
🔍 Latest deploy log https://app.netlify.com/sites/docusaurus-2/deploys/659abb6a2c9400000856c57b
😎 Deploy Preview https://deploy-preview-9713--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 Jan 7, 2024

⚡️ Lighthouse report for the deploy preview of this PR

URL Performance Accessibility Best Practices SEO PWA Report
/ 🟢 94 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/installation 🟠 69 🟢 98 🟢 100 🟢 100 🟠 89 Report
/docs/category/getting-started 🟠 75 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog 🟠 70 🟢 100 🟢 100 🟢 90 🟠 89 Report
/blog/preparing-your-site-for-docusaurus-v3 🟠 63 🟢 97 🟢 100 🟢 100 🟠 89 Report
/blog/tags/release 🟠 70 🟢 100 🟢 100 🟠 80 🟠 89 Report
/blog/tags 🟠 74 🟢 100 🟢 100 🟢 90 🟠 89 Report

@slorber slorber added the pr: maintenance This PR does not produce any behavior differences to end users when upgrading. label Jan 8, 2024
@slorber
Copy link
Collaborator

slorber commented Jan 8, 2024

thanks 👍

@slorber slorber merged commit 849608b into facebook:main Jan 8, 2024
11 checks passed
@tats-u tats-u deleted the cspell-mdx branch January 8, 2024 23:30
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: maintenance This PR does not produce any behavior differences to end users when upgrading.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants