phpfmt extension for coc.nvim
npm install coc-phpfmtphpfmt extension for coc.nvim. Forked from vscode-phpfmt
:CocInstall coc-phpfmt
| name | description |
| -------------------------- | ---------------------------- |
| phpfmt.listTransformations | phpfmt: List Transformations |
| phpfmt.openOutput | phpfmt: Open Output |
Q: How to use phpfmt.php_bin with spaces such as C:\Program Files\php\php.exe ?
A: Wrap your path with quotes like:
``json`
{
"phpfmt.php_bin": "\"C:\\Program Files\\php\\php.exe\""
}
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:
`json`
{
"phpfmt.passes": [
"PSR2KeywordsLowerCase",
"PSR2LnAfterNamespace",
"PSR2CurlyOpenNextLine",
"PSR2ModifierVisibilityStaticOrder",
"PSR2SingleEmptyLineAndStripClosingTag",
"ReindentSwitchBlocks"
],
"phpfmt.exclude": ["ReindentComments", "StripNewlineWithinClassBody"],
"phpfmt.psr2": false
}
Q: Is fmt.phar (phpfmt itself) still maintained ?
A: Since phpfmt has no maintainers, only Serious bugs will be fixed.
| Key | Type | Description | Default |
| ---------------------------------- | -------------------- | --------------------------------------------------------------------------- | ------- |
| phpfmt.php_bin | string | php executable path | "php" |boolean
| phpfmt.detect_indent | | auto detecting indent type and size (will ignore indent_with_space) | false |boolean
| phpfmt.psr1 | | activate PSR1 style | false |boolean
| phpfmt.psr1_naming | | activate PSR1 style - Section 3 and 4.3 - Class and method names case. | false |boolean
| phpfmt.psr2 | | activate PSR2 style | true |integer \| boolean
| phpfmt.indent_with_space | | use spaces instead of tabs for indentation. Default 4 | 4 |boolean
| phpfmt.enable_auto_align | | enable auto align of ST_EQUAL and T_DOUBLE_ARROW | false |boolean
| phpfmt.visibility_order | | fixes visibiliy order for method in classes - PSR-2 4.2 | false |array
| phpfmt.passes | | call specific compiler pass | [] |array
| phpfmt.exclude | | disable specific passes | [] |boolean
| phpfmt.smart_linebreak_after_curly | | convert multistatement blocks into multiline blocks | false |boolean
| phpfmt.yoda | | yoda-style comparisons | false |boolean
| phpfmt.cakephp | | Apply CakePHP coding style | false |string` | provide custom arguments to overwrite default arguments generated by config | "" |
| phpfmt.custom_arguments |
| Key | Description | |
| --------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------- | ------------------------------------------- |
| 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 (=>). | |
| AlignDoubleSlashComments | Vertically align "//" comments. | |
| AlignEquals | Vertically align "=". | |
| 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 "| DocBlockToComment | Replace docblocks with regular comments when used in non structural elements. | |
| DoubleToSingleQuote | Convert from double to single quotes. | |
| EchoToPrint | Convert from T_ECHO to print. | |
| EncapsulateNamespaces | Encapsulate namespaces with curly braces | |
| GeneratePHPDoc | Automatically generates PHPDoc blocks | |
| IndentTernaryConditions | Applies indentation to ternary conditions. | |
| JoinToImplode | Replace implode() alias (join() -> 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. | |
| RemoveIncludeParentheses | Remove parentheses from include declarations. | |
| RemoveSemicolonAfterCurly | Remove semicolon after closing curly brace. | |
| RemoveUseLeadingSlash | Remove leading slash in T_USE imports. | |
| ReplaceBooleanAndOr | Convert from "and"/"or" to "&&"/" | Danger! This pass leads to behavior change. |
| ReplaceIsNull | Replace is_null($a) with null === $a. | |
| RestoreComments | Revert any formatting of comments content. | |
| ReturnNull | Simplify empty returns. | |
| ShortArray | Convert old array into new array. (array() -> []) | |
| SmartLnAfterCurlyOpen | Add line break when implicit curly block is added. | |
| SortUseNameSpace | Organize use clauses by length and alphabetic order. | |
| SpaceAroundControlStructures | Add space around control structures. | |
| SpaceAfterExclamationMark | Add space after exclamation mark. | |
| SpaceAroundExclamationMark | Add spaces around exclamation mark. | |
| SpaceAroundParentheses | Add spaces inside parentheses. | |
| SpaceBetweenMethods | Put space between methods. | |
| StrictBehavior | Activate strict option in array_search, base64_decode, in_array, array_keys, mb_detect_encoding. Danger! This pass leads to behavior change. | |
| StrictComparison | All comparisons are converted to strict. Danger! This pass leads to behavior change. | |
| StripExtraCommaInArray | Remove trailing commas within array blocks | |
| StripNewlineAfterClassOpen | Strip empty lines after class opening curly brace. | |
| StripNewlineAfterCurlyOpen | Strip empty lines after opening curly brace. | |
| StripNewlineWithinClassBody | Strip empty lines after class opening curly brace. | |
| StripSpaces | Remove all empty spaces | |
| StripSpaceWithinControlStructures | Strip empty lines within control structures. | |
| TightConcat | Ensure string concatenation does not have spaces, except when close to numbers. | |
| TrimSpaceBeforeSemicolon | Remove empty lines before semi-colon. | |
| UpgradeToPreg | Upgrade ereg\ calls to preg\ | |
| WordWrap | Word wrap at 80 columns. | |
| WrongConstructorName | Update old constructor names into new ones. http://php.net/manual/en/language.oop5.decon.php | |
| YodaComparisons | Execute Yoda Comparisons. | |
MIT
---
> This extension is built with create-coc-extension