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

Edits to the paragraph about Prettier #7179

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

DNin01
Copy link
Member

@DNin01 DNin01 commented Feb 17, 2024

Changes

I removed the mention of Prettier for VS Code as I think it always uses the latest version and you also need to change the settings for it to work with our code style, and I don't really want to take up space to explain how to configure it. The parser it uses also cannot format CSS, even though Prettier has an official CSS parser.

I was thinking of also linking to the online Prettier playground as an easy-to-use alternative, but that also appears to only be able to use the latest version. That would be fine except that, like many developers, we hardcode a version, after we learned how automatic updates go the hard way.

I haven't tried Prettier on RunKit yet, but that might be one other option for those who aren't ready to install Node.js just to format code. If anyone knows of any other easy ways to get code formatted with Prettier's algorithms before committing changes that 1. can be configured and 2. can use a specific version, let me know.

Despite all of these removed references, I did add a link to the prettier package on npm, and continue to recommend enabling the Actions feature.

@DNin01 DNin01 added scope: documentation Related to docs located on the repository. Mind that Scratch Addons Docs is available on website-v2. type: enhancement New feature for the project scope: development Related to developing, documentation, DevEx, etc. labels Feb 17, 2024
@Hans5958
Copy link
Member

Hans5958 commented Feb 18, 2024

Again and again, these issues can be solved if we have package.json. Almost feels like we should have done this.

@DNin01
Copy link
Member Author

DNin01 commented Feb 18, 2024

Again and again, these issues can be solved if we have package.json. Almost feels like we should have done this.

It would also be a great opportunity to add other developer tools like chrome-types and ESLint, wherever that is.

Copy link
Member

@Samq64 Samq64 left a comment

Choose a reason for hiding this comment

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

The changes look good assuming we're not adding a package.json.

@Samq64 Samq64 added the status: needs review [Use when there's already 1 approval] Review needed on the PR label Feb 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
scope: development Related to developing, documentation, DevEx, etc. scope: documentation Related to docs located on the repository. Mind that Scratch Addons Docs is available on website-v2. status: needs review [Use when there's already 1 approval] Review needed on the PR type: enhancement New feature for the project
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants