Skip to content

Add reference link comment for Prettier filename matching patterns #600

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

Merged
merged 1 commit into from
Jun 18, 2025

Conversation

per1234
Copy link
Contributor

@per1234 per1234 commented Jun 18, 2025

Projects may use data files written in the TOML language. A common example of such is the pyproject.toml file present in projects that use the Poetry Python package management tool (either for project code dependencies, or development tools).

In cases where the TOML content is edited directly by human contributors, it will be useful to provide code formatting infrastructure for TOML files, and to enforce consistent formatting. This is easily accomplished by adding TOML support to the existing code formatting infrastructure via the prettier-plugin-toml plugin for the Prettier formatting tool.

Poetry's poetry.lock file is also written in the TOML language. This file is automatically generated and never manually edited. In this case, the automatically generated content is accepted as-is. So Prettier is configured to exclude the poetry.lock file from formatting.

Projects may use data files written in the TOML language. A common example of such is the `pyproject.toml` file present
in projects that use the Poetry Python package management tool (either for project code dependencies, or development
tools).

In cases where the TOML content is edited directly by human contributors, it will be useful to provide code formatting
infrastructure for TOML files, and to enforce consistent formatting. This is easily accomplished by adding TOML support
to the existing code formatting infrastructure via the "prettier-plugin-toml" plugin for the Prettier formatting tool.

Poetry's `poetry.lock` file is also written in the TOML language. This file is automatically generated and never
manually edited. In this case, the automatically generated content is accepted as-is. So Prettier is configured to
exclude the `poetry.lock` file from formatting.
@per1234 per1234 self-assigned this Jun 18, 2025
@per1234 per1234 added type: enhancement Proposed improvement topic: code Related to content of the project itself topic: infrastructure Related to project infrastructure labels Jun 18, 2025
@per1234 per1234 merged commit d73cfe0 into arduino:main Jun 18, 2025
51 checks passed
@per1234 per1234 deleted the check-toml branch June 18, 2025 06:51
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
topic: code Related to content of the project itself topic: infrastructure Related to project infrastructure type: enhancement Proposed improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant