Issue Labels
Issue labels fall into the following groups.
Areas are parts of the code-base.
-
area:api
Issues about Prettier's Application Programming Interface.
-
area:cli
Issues about Prettier's Command Line Interface.
-
area:tests
Issues about Prettier's tests and test infrastructure.
-
area:comments
Comments are one of the most complicated parts of prettier. This label means the issue relates to how prettier is printing comments.
-
area:multiparser
Multi-parser is the code that makes it possible to format one programming language inside another, such as CSS-in-JS.
-
area:playground
Issues about the playground.
-
area:website
Issues about the website, excluding playground.
Difficulty is used to mark how much time it will likely take to resolve an issue, or how much nuance there is to a particular issue.
-
difficulty:easy
This issue is easy. Resolve me on the train to work!
-
difficulty:hard
This issue might take an entire weekend, or require a tough decision.
Prettier supports a growing number of languages so it is useful to tag them.
-
lang:css/scss/less
This issue affects CSS, LESS or SCSS.
-
lang:flow
This issue affects Flow.
-
lang:graphql
This issue affects GraphQL.
-
lang:javascript
This issue affects JavaScript.
-
lang:json
This issue affects JSON.
-
lang:jsx
This issue affects JSX.
-
lang:markdown
This issue affects Markdown.
-
lang:typescript
This issue affects TypeScript.
-
lang:handlebars
This issue affects Handlebars.
-
priority:facebook blocker
Although Prettier is not an official project of Facebook OpenSource, engineers working at Facebook (primarily @vjeux) have devoted a significant number of working hours to improving Prettier for everybody. Facebook use Prettier internally, and issues marked with this label block Facebook upgrading Prettier.
-
priority:high
High priority issues are ones that either re-print code in a way that unintentionally changes the AST, or are significant regressions and need to be fixed urgently.
-
scope:dependency
This is a real issue but cannot be solved by modifying Prettier itself, it must be fixed in one of our dependencies.
-
scope:external
This issue cannot be resolved in Prettier itself, it is an issue with something external, such as an editor integration.
Status labels are particularly useful for finding issues that need attention.
-
status:awaiting response
In a pull request, this means a review has been left that requires the author to reply. On an issue, this means that a collaborator has replied and requires more information from the reporter to proceed.
-
status:has pr
This issue has an accompanying PR. By excluding this label from your search it is easier to find actionable items.
-
help wanted
Help! We're only a small group of collaborators who unfortunately can't get to every issue promptly. This label means we think the issue should be addressed but don't have the capacity to resolve it now. Great for first-time contributors!
-
status:needs discussion
This issue needs discussion and ultimately a decision to be made before it is actionable.
-
status:wip
In a pull request, marks that the code changes are a work in progress and should not be merged.
Issue types are categories that an issue might fall into. Generally an issue should have exactly one type.
Want to triage some issues? This query lists all open issues without a type label.
-
type:bug
Red alert! Issues with this label are bugs in Prettier. Most bugs are cases where Prettier does not produce the expected output. If the output means the code can no-longer be parsed, or the meaning of the code has changed, add the priority:high label, too.
-
type:docs
This issue requires amending or adding new documentation.
-
type:duplicate
This issue is a duplicate of a previous issue.
-
type:editor support
This issue pertains to ensuring Prettier provides the right tools to be used inside editor integrations.
-
type:enhancement
Working as intended! Issues with this label represent a potential new feature to be added to Prettier.
-
type:infra
This issue is about CI, publishing to npm, or similar.
-
type:intended
Bug reports that are actually prettier working as intended.
-
type:meta
The status of Prettier, or anything else about Prettier itself.
-
type:option request
Prettier gets a lot of requests to add options to change the way it will print some code. Because Prettier is opinionated, and due to the cost of maintaining options, we will often refuse to add them. Read this for more context.
-
type:question
Questions and support requests. Issues marked as questions are automatically closed by a bot suggesting to use Stack Overflow instead. The issue tracker is only for development.
-
type:tests
Tests that are not correct, suggestions for tests that should be added, or similar.