vitalif-js
/
prettier
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity
prettier/website/blog/2018-04-09-plugin-php-0.1.md

3.5 KiB
Raw Permalink Blame History

author: Christian Zosel (@chrzosel) authorURL: https://twitter.com/chrzosel title: Prettier for PHP 0.1: First alpha release 🎉

After more than 200 merged pull requests since mid December 2017, we're happy to announce the first alpha release of Prettier for PHP. In this blog post, we'd like to give a short overview of how the plugin works, its philosophy, and what to expect in the future.

How does it work?

Adding support for a new language to Prettier requires two things:

  • A parser, which turns your source code into an abstract syntax tree (AST). Since Prettier is written in JavaScript, we're using php-parser, which is a PHP parser written in JS.

  • A printer, that turns the AST into a special format called doc that Prettier requires to do its magic. It is basically your source code plus some information about where linebreaks can be added, how it should be indented, and so on.

While we could benefit from existing work on the parsing side, the printer had to be developed from scratch to support all of PHP's various AST node types. Our first alpha release today means that we are confident that the printer can re-print your code without breaking it.

If you'd like to read more about the plugin API, see the docs.

Philosophy

When building a code formatter, it can be tempting to add many options to account for all the different code styles there are. The PHP plugin sticks to Prettier's opinionated philosophy and doesn't add any new options. Instead, we identified PSR-1, PSR-2 and PSR-12 as one of the most popular coding styles in the PHP community, and decided to use this as our guide when it came to formatting our re-printed PHP code.

From the experience gained with Prettier for JavaScript, we believe that offering as few configuration options as possible is one of Prettier's biggest strengths. After our first stable release, we will consider adding a very limited set of options for the most controversial styling decisions (e.g. brace style), but remain conservative about it.

What's next

For our first stable release, the following milestones still have to be reached:

  1. 100% safety that we're not breaking code during formatting.

    We're quite close to this goal already today.

  2. Pretty output

    The plugin doesn't deserve its name if the output isn't pretty. While it is already quite good today, handling all the edge cases will require some more work.

  3. Integrations

    Today, you can try the plugin from the command line by following the instructions in the README. Plugin support in your favorite editor might not work yet, though (see the related issues for VS Code, Atom and Vim). Also, the PHP plugin is not integrated in Prettier's playground yet.

Are you excited about Prettier for PHP? Then we'd love you to help us reach our first stable release by