Skip to content

Commit

Permalink
docs: add a clear note that we do not strictly follow PSR/PER
Browse files Browse the repository at this point in the history
Closes #2288
  • Loading branch information
Kenneth-Sills committed Aug 6, 2024
1 parent 7e8f79e commit 1897718
Showing 1 changed file with 4 additions and 0 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,6 +37,10 @@ Prettier is an opinionated code formatter. It enforces a consistent style by par

This plugin adds support for the PHP language to Prettier.

> [!NOTE]
>
> This plugin has always used PSR / PER as guidance when making formatting decisions, but has never aimed to be fully PSR / PER compliant. The idea behind this plugin is to stay reasonably close to how Prettier for JS works.
### Can this be used in production?

We're considering the plugin to be stable when pure PHP files are formatted. Formatting of files that contain mixed PHP and HTML is still considered unstable - please see [open issues with the tag "inline"](/~https://github.com/prettier/plugin-php/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc+label%3Ainline) for details.
Expand Down

0 comments on commit 1897718

Please sign in to comment.