Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/prettier/plugin-php
Prettier PHP Plugin
https://github.com/prettier/plugin-php
autoformat beautifier formatter php php5 php7 prettier printer
Last synced: about 2 months ago
JSON representation
Prettier PHP Plugin
- Host: GitHub
- URL: https://github.com/prettier/plugin-php
- Owner: prettier
- License: mit
- Created: 2017-12-24T02:56:22.000Z (over 6 years ago)
- Default Branch: main
- Last Pushed: 2024-04-12T23:03:39.000Z (5 months ago)
- Last Synced: 2024-04-14T02:31:11.898Z (5 months ago)
- Topics: autoformat, beautifier, formatter, php, php5, php7, prettier, printer
- Language: PHP
- Homepage: https://loilo.github.io/prettier-php-playground/
- Size: 6.37 MB
- Stars: 1,703
- Watchers: 22
- Forks: 123
- Open Issues: 93
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
Awesome Lists containing this project
- awesome - plugin-php - Prettier PHP Plugin (PHP)
README
Prettier PHP Plugin
## Intro
Prettier is an opinionated code formatter. It enforces a consistent style by parsing your code and re-printing it with its own rules that take the maximum line length into account, wrapping code when necessary.
This plugin adds support for the PHP language to Prettier.
### 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.
If you want to use the plugin in production, we recommend limiting its scope to pure PHP files.
### Input
```php
"code","with"=>
function() {return "inconsistent";}
,"formatting"=>"is", "hard" => "to", "maintain"=>true));
```
### Output
```php
"code",
"with" => function () {
return "inconsistent";
},
"formatting" => "is",
"hard" => "to",
"maintain" => true,
]
);
```
## Playground
You can give the plugin a try in our [playground](https://loilo.github.io/prettier-php-playground/)!
## Install
yarn:
```bash
yarn add --dev prettier @prettier/plugin-php
# or globally
yarn global add prettier @prettier/plugin-php
```
npm:
```bash
npm install --save-dev prettier @prettier/plugin-php
# or globally
npm install --global prettier @prettier/plugin-php
```
### Activate the plugin
Create or modify your [prettier configuration file](https://prettier.io/docs/en/configuration) to activate the plugin:
```json
{
"plugins": ["@prettier/plugin-php"]
}
```
## Use
### With Node.js
If you installed prettier as a local dependency, you can add prettier as a script in your `package.json`,
```json
{
"scripts": {
"prettier": "prettier"
}
}
```
and then run it via
```bash
yarn run prettier path/to/file.php --write
# or
npm run prettier -- path/to/file.php --write
```
If you installed globally, run
```bash
prettier path/to/file.php --write
```
### In the Browser
This package exposes a `standalone.js` that can be used alongside Prettier's own `standalone.js` to make the PHP plugin work in browsers without a compile step.
First, grab both standalone scripts from an npm CDN like [unpkg](https://unpkg.com/):
```html
```
Then use Prettier with PHP, just like this:
```js
await prettier.format(YOUR_CODE, {
plugins: prettierPlugins,
parser: "php",
});
```
See this code in action [in this basic demo](https://jsbin.com/butoruw/edit?html,output).
### With Bundlers
Bundlers like webpack, Rollup or browserify automatically recognize how to handle the PHP plugin. Remember that even when using a bundler, you still have to use the standalone builds:
```js
import prettier from "prettier/standalone";
import * as prettierPluginPhp from "@prettier/plugin-php/standalone";
await prettier.format(YOUR_CODE, {
plugins: [prettierPluginPhp],
parser: "php",
});
```
## Configuration
Prettier for PHP supports the following options. We recommend that all users set the `phpVersion` option.
| Name | Default | Description |
| ------------------ | ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `phpVersion` | `"7.0"` | Allows specifying the PHP version you're using. If you're using PHP 7.1 or later, setting this option will make use of modern language features in the printed output. If you're using PHP lower than 7.0, you'll have to set this option or Prettier will generate incompatible code. |
| `printWidth` | `80` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#print-width)) |
| `tabWidth` | `4` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tab-width)), The default is `4` based on the `PSR-2` coding standard. |
| `useTabs` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#tabs)) |
| `singleQuote` | `false` | If set to `"true"`, strings that use double quotes but do not rely on the features they add, will be reformatted. Example: `"foo" -> 'foo'`, `"foo $bar" -> "foo $bar"`. |
| `trailingCommaPHP` | `true` | If set to `true`, trailing commas will be added wherever possible.
If set to `false`, no trailing commas are printed. |
| `braceStyle` | `"per-cs"` | If set to `"per-cs"`, prettier will move open brace for code blocks (classes, functions and methods) onto new line.
If set to `"1tbs"`, prettier will move open brace for code blocks (classes, functions and methods) onto same line. |
| `requirePragma` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#require-pragma)) |
| `insertPragma` | `false` | Same as in Prettier ([see prettier docs](https://prettier.io/docs/en/options.html#insert-pragma)) |
## Ignoring code
A comment `// prettier-ignore` will exclude the next node in the abstract syntax tree from formatting.
For example:
```php
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
);
// prettier-ignore
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
);
```
will be transformed to
```php
matrix(1, 0, 0, 0, 1, 0, 0, 0, 1);
// prettier-ignore
matrix(
1, 0, 0,
0, 1, 0,
0, 0, 1
)
```
## Editor integration
### Atom
The official [prettier plugin for atom](https://github.com/prettier/prettier-atom) supports plugins.
### Visual Studio Code
The official [prettier plugin for vscode](https://github.com/prettier/prettier-vscode) supports plugins since Version 1.10.0. To enable it, install the extension and make sure the plugin is installed _locally_ (in your project folder).
Visual Studio Code may not recognise the document selectors provided by this plugin, and so you can add php to your document selectors by adding the following line to `.vscode/settings.json`:
```json
"prettier.documentSelectors": [
"**/*.{js,jsx,ts,tsx,vue,html,css,scss,less,json,md,mdx,graphql,yaml,yml,php}"
]
```
You may also need to declare php as the parser in your prettier config file:
```json
{
"parser": "php",
"plugins": ["@prettier/plugin-php"]
}
```
See (this issue)[https://github.com/prettier/plugin-php/issues/1730] for more discussion around potential VS Code solutions.
### PhpStorm / IntelliJ / Jetbrains IDE
- Install prettier and plugin locally `yarn add -D prettier @prettier/plugin-php`
- Open Settings (File, Settings)
- Go to Plugins Section, Select Marketplace, Search for Prettier, Install Plugin, Restart IDE
- Open Settings, Search for Prettier, select Prettier in left settings navigation
- Check prettier package has auto-detected, should be something like `myproject/node_modules/prettier`
- Update Run for Files to include .php, eg: `{**/*,*}.{js,ts,jsx,tsx,php,json,scss,vue,md}`
- Tick the On Save button, if you want your files formatting updated on file save
- Clock OK to save settings
_Note: Just pressing save does not reformat your current file unless the file has been modified in some way,
alternatively you can use the Prettier shortcut Ctrl+Alt+Shift+P_
### Sublime Text
Sublime Text support is available through Package Control and the [JsPrettier](https://packagecontrol.io/packages/JsPrettier) plugin.
### Vim
Regarding plugin support in the official plugin vim-prettier see [this issue](https://github.com/prettier/vim-prettier/issues/119).
#### ALE
The linting plugin ALE has built-in support for prettier and its plugins. Just add prettier to your [list of fixers](https://github.com/w0rp/ale#2ii-fixing). For example:
```vim
let g:ale_fixers={
\'javascript': ['prettier'],
\'json': ['prettier'],
\'php': ['prettier'],
\}
```
#### Custom
Alternatively, adding the following to `.vimrc` will define a custom command `:PrettierPhp` that runs the plugin while preserving the cursor position and run it on save.
```vim
" Prettier for PHP
function PrettierPhpCursor()
let save_pos = getpos(".")
%! prettier --stdin --parser=php
call setpos('.', save_pos)
endfunction
" define custom command
command PrettierPhp call PrettierPhpCursor()
" format on save
autocmd BufwritePre *.php PrettierPhp
```
## Integration for other tools
### PHP-CS-Fixer
See `docs/recipes/php-cs-fixer` for integration help, code can also be found in https://gist.github.com/Billz95/9d5fad3af728b88540fa831b73261733
## Contributing
If you're interested in contributing to the development of Prettier for PHP, you can follow the [CONTRIBUTING guide from Prettier](https://github.com/prettier/prettier/blob/master/CONTRIBUTING.md), as it all applies to this repository too.
To test it out on a PHP file:
- Clone this repository.
- Run `yarn`.
- Create a file called `test.php`.
- Run `yarn prettier test.php` to check the output.
## Maintainers
