Light

ennosuke / php-codebeautifier Goto Github PK

View Code? Open in Web Editor NEW

13.0 3.0 7.0 5 KB

This is a plugin for Sublime Text 3 that gives the option to run the phpcbf

License: MIT License

JavaScript 65.43% Python 34.57%

php-codebeautifier's Introduction

PHP-Codebeautifier

This is a plugin for Sublime Text 3 that gives the option to run the phpcbf

Prerequisite

You need the PHP Codesniffer more precise the code beautifier from them.

Install

Clone this repo into your Packages folder of Sublime Text. If phpcbf is in your path you don't need to do much setup. Otherwise create a user config for this plugin and set the path to your executable.

{
  "path": "/path/to/your/phpcbf"
}

Please note that the executable has to be in the string.

Usage

The usage is pretty straight forward just press CTRL+ALT+F or use the button in the Tools menu to execute it. For longer files give it a bit to run.

Configuration

Nearly all configuration options from phpcbf are bound to options in the settings file. Please refer to the documentiation for phpcbf to know what they do.

The three most important ones are

path - Sets the path to the phpcbf executable
level - Sets the code standard to follow. Default: psr-2
patch - Sets whenether patch command should be used.

php-codebeautifier's People

Contributors

Stargazers

Watchers

Forkers

curtisgibby ikuiki amitpaneli bross07 fernandogonzalez ollyollyollyltd

php-codebeautifier's Issues

Set `lineLimit` for phpcbf.

Thanks for this great plugin! How do I set the lineLimit property?

can't find file to patch at input line 3

It looks like it can find problems, but it can't fix it by default. Here is the output from console:

Changing into directory /home/---/Projects/magento2/app/etc
Processing config.php [PHP => 816 tokens in 105 lines]... DONE in 16ms (1 fixable violations)
    => Fixing file: 1/1 violations remaining

    => Fixing file: 1/1 violations remaining [made 1 pass]... 

    => Fixing file: 0/1 violations remaining [made 2 passes]... �[32mDONE�[0m in 35ms
Array
(
    [0] => Ignoring potentially dangerous file name /home/---/Projects/magento2/app/etc/config.php
    [1] => can't find file to patch at input line 3
    [2] => Perhaps you used the wrong -p or --strip option?
    [3] => The text leading up to this was:
    [4] => --------------------------
    [5] => |--- /home/---/Projects/magento2/app/etc/config.php
    [6] => |+++ PHP_CodeSniffer
    [7] => --------------------------
    [8] => File to patch:
    [9] => Skip this patch? [y]
    [10] => Skipping patch.
    [11] => 1 out of 1 hunk ignored
)
Returned: 1
Time: 82ms; Memory: 5.5Mb

I know it's a phpcbf problem, it somehow can't create the patch file, so after adding this to to the user configuration file, it's working:

  "patch": 0

Syntaxes settings issue causing silent failure / return

Not an issue as such but took me some hair pulling to figure out, maybe someone else will

By default the supported syntaxes setting is an array containing only Packages/PHP/PHP.sublime-syntax. For some reason my ST3 uses Packages/PHP/PHP.tmLanguage instead, which was causing the run command to fail silently. Adding

"syntaxes": [
    "Packages/PHP/PHP.tmLanguage",
    "Packages/PHP/PHP.sublime-syntax"
]

to my user settings fixed the problem!

Recommend Projects

React

A declarative, efficient, and flexible JavaScript library for building user interfaces.
Vue.js

🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
Typescript

TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
TensorFlow

An Open Source Machine Learning Framework for Everyone
Django

The Web framework for perfectionists with deadlines.
Laravel

A PHP framework for web artisans
D3

Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

javascript

JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
web

Some thing interesting about web. New door for the world.
server

A server is a program made to process requests and deliver data to clients.
Machine learning

Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
Visualization

Some thing interesting about visualization, use data art
Game

Some thing interesting about game, make everyone happy.

Recommend Org

Facebook

We are working to build community through open source technology. NB: members must have two-factor auth.
Microsoft

Open source projects and samples from Microsoft.
Google

Google ❤️ Open Source for everyone.
Alibaba

Alibaba Open Source for everyone
D3

Data-Driven Documents codes.
Tencent

China tencent open source team.