phpfmt - PHP formatter installs statistics

phpfmt for Visual Studio Code

The missing phpfmt extension for Visual Studio Code.

Installation

Open command palette F1 and select Extensions: Install Extension, then search for phpfmt.

Note: PHP 5.6 or newer is required in the machine to run this plugin.

Usage

F1 -> phpfmt: Format This File

or keyboard shortcut Ctrl + Shift + I which is Visual Studio Code default formatter shortcut

or right mouse context menu Format Document or Format Selection

Format On Save

Respects editor.formatOnSave setting.

You can turn off format-on-save on a per-language basis by scoping the setting:

Q&A

Q: How to use phpfmt.php_bin with spaces such as C:\Program Files\php\php.exe ? A: Wrap your path with quotes like:

It is recommended to add the directory of the php.exe to the PATH environment variable on Windows. If it still not working, refer to #1 and Stack Overflow Related.

Q: How use tabs instead of spaces with PSR2 enabled ? A: For PSR2, code MUST use 4 spaces for indenting, not tabs. But if you like PSR2, and do not like 4 spaces for indentation, add following configuration:

Q: Is fmt.phar (phpfmt itself) still maintained ? ~~A: Since phpfmt has no maintainers, only Serious bugs will be fixed.~~ A: We now use fmt.stub.php from driade's phpfmt8 which is very updated.

Configuration

| Key | Type | Description | Default | | - | - | - | - | | phpfmt.php_bin | string | php executable path | "php" | | phpfmt.use_old_phpfmt | boolean | use old fmt.phar which supports 5.6 | false | | phpfmt.detect_indent | boolean | auto detecting indent type and size (will ignore indent_with_space) | false | | phpfmt.psr1 | boolean | activate PSR1 style | false | | phpfmt.psr1_naming | boolean | activate PSR1 style - Section 3 and 4.3 - Class and method names case. | false | | phpfmt.psr2 | boolean | activate PSR2 style | true | | phpfmt.wp | boolean | activate WP style | false | | phpfmt.indent_with_space | integer \| boolean | use spaces instead of tabs for indentation. Default 4 | 4 | | phpfmt.enable_auto_align | boolean | enable auto align of ST_EQUAL and T_DOUBLE_ARROW | false | | phpfmt.visibility_order | boolean | fixes visibiliy order for method in classes - PSR-2 4.2 | false | | phpfmt.ignore | array | ignore file names whose names contain any pattern that could be matched with .match JS string method | [] | | phpfmt.passes | array | call specific compiler pass | ["AlignDoubleArrow","AlignPHPCode","SpaceAfterExclamationMark","AlignConstVisibilityEquals","AutoSemicolon","ConvertOpenTagWithEcho","AlignEquals","MergeNamespaceWithOpenTag","RemoveSemicolonAfterCurly","RestoreComments","ShortArray","ExtraCommaInArray","AlignDoubleSlashComments","IndentTernaryConditions","IndentPipeOperator","AlignSuperEquals"] | | phpfmt.exclude | array | disable specific passes | [] | | phpfmt.smart_linebreak_after_curly | boolean | convert multistatement blocks into multiline blocks | false | | phpfmt.yoda | boolean | yoda-style comparisons | false | | phpfmt.cakephp | boolean | Apply CakePHP coding style | false | | phpfmt.custom_arguments | string | provide custom arguments to overwrite default arguments generated by config | "" |

Supported Transformations

F1 -> phpfmt: List Transformations to get the example of each transformation.

| Key | Description | | - | - | | SmartLnAfterCurlyOpen | Add line break when implicit curly block is added. | | AddMissingParentheses | Add extra parentheses in new instantiations. | | AliasToMaster | Replace function aliases to their masters - only basic syntax alias. | | AlignConstVisibilityEquals | Vertically align "=" of visibility and const blocks. | | AlignDoubleArrow | Vertically align T_DOUBLE_ARROW (=>). | | AlignComments | Vertically align "//" comments. | | AlignDoubleSlashComments | Vertically align "//" comments. | | AlignEquals | Vertically align "=". | | AlignSuperEquals | Vertically align "=", ".=", "&=", ">>=", etc. | | AlignGroupDoubleArrow | Vertically align T_DOUBLE_ARROW (=>) by line groups. | | AlignPHPCode | Align PHP code within HTML block. | | AlignTypehint | Vertically align function type hints. | | AllmanStyleBraces | Transform all curly braces into Allman-style. | | AutoPreincrement | Automatically convert postincrement to preincrement. | | AutoSemicolon | Add semicolons in statements ends. | | CakePHPStyle | Applies CakePHP Coding Style | | ClassToSelf | "self" is preferred within class, trait or interface. | | ClassToStatic | "static" is preferred within class, trait or interface. | | ConvertOpenTagWithEcho | Convert from " implode()). | | LeftWordWrap | Word wrap at 80 columns - left justify. | | LongArray | Convert short to long arrays. | | MergeElseIf | Merge if with else. | | SplitElseIf | Merge if with else. | | MergeNamespaceWithOpenTag | Ensure there is no more than one linebreak before namespace | | MildAutoPreincrement | Automatically convert postincrement to preincrement. (Deprecated pass. Use AutoPreincrement instead). | | NewLineBeforeReturn | Add an empty line before T_RETURN. | | OrganizeClass | Organize class, interface and trait structure. | | OrderAndRemoveUseClauses | Order use block and remove unused imports. | | OnlyOrderUseClauses | Order use block - do not remove unused imports. | | OrderMethod | Organize class, interface and trait structure. | | OrderMethodAndVisibility | Organize class, interface and trait structure. | | PHPDocTypesToFunctionTypehint | Read variable types from PHPDoc blocks and add them in function signatures. | | PrettyPrintDocBlocks | Prettify Doc Blocks | | PSR2EmptyFunction | Merges in the same line of function header the body of empty functions. | | PSR2MultilineFunctionParams | Break function parameters into multiple lines. | | ReindentAndAlignObjOps | Align object operators. | | ReindentSwitchBlocks | Reindent one level deeper the content of switch blocks. | | ReindentEnumBlocks | Reindent one level deeper the content of enum blocks. | | RemoveIncludeParentheses | Remove parentheses from include declarations. |…

Description from the VS Code Marketplace listing.