Skip to content

feat: add explanation for Prettier plugin order to Editor setup page #11688

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from

Conversation

anaxite
Copy link
Contributor

@anaxite anaxite commented May 15, 2025

Description

This change adds an extra step to the Prettier setup instructions of editor-setup.mdx. The extra step discusses adding other Prettier plugins, making sure to mention the importance of their order. There is an example that specifically shows prettier-plugin-tailwindcss as the last one.

I went with an extra step to avoid cluttering step 2, and to try keeping concepts separate.

Related issues & labels

Copy link

netlify bot commented May 15, 2025

Deploy Preview for astro-docs-2 ready!

Built without sensitive environment variables

Name Link
🔨 Latest commit bdd5b2c
🔍 Latest deploy log https://app.netlify.com/projects/astro-docs-2/deploys/6825c22936365e00083dd231
😎 Deploy Preview https://deploy-preview-11688--astro-docs-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 project configuration.

@astrobot-houston
Copy link
Contributor

Lunaria Status Overview

🌕 This pull request will trigger status changes.

Learn more

By default, every PR changing files present in the Lunaria configuration's files property will be considered and trigger status changes accordingly.

You can change this by adding one of the keywords present in the ignoreKeywords property in your Lunaria configuration file in the PR's title (ignoring all files) or by including a tracker directive in the merged commit's description.

Tracked Files

File Note
en/editor-setup.mdx Source changed, localizations will be marked as outdated.
Warnings reference
Icon Description
🔄️ The source for this localization has been updated since the creation of this pull request, make sure all changes in the source have been applied.

Copy link
Member

@sarah11918 sarah11918 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This looks great, and thank you for jumping on this issue!

Just had one small comment about the code comment line. Maybe we can get that shorter?

{
"plugins": [
"prettier-plugin-astro",
"prettier-plugin-tailwindcss" // needs to appear after other Prettier plugins
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
"prettier-plugin-tailwindcss" // needs to appear after other Prettier plugins
"prettier-plugin-tailwindcss" // needs to be last

Something shorter here would avoid any horizontal scroll on the code snippet!

If this is a prettier file, and this is the plugins section, is there anything other than a Prettier plugin that could be listed here? Maybe we don't need to be so specific?

@sarah11918
Copy link
Member

Looks like we all got busy, @anaxite ! 😂 I did leave a quick comment, which big if true! (If true, I think it's better?)

Otherwise, this one really should be able to get done, so let me know about that comment, and we'll get it merged in! 🙌

@sarah11918 sarah11918 added the improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes) label May 28, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
improve or update documentation Enhance / update existing documentation (e.g. add example, improve description, update for changes)
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Plugin required disclaimer for Prettier section of the editor setup docs
3 participants