gerardroche / sublime-php-grammar

PHP macros for Sublime Text.

WHAT PHPGRAMMAR IS

An improved PHP syntax, good indentation rules, smart macros, and more.

Completions and snippets are provided separately by PHP Completions Kit and PHP Snippets.

INSTALLATION

Package Control installation

The preferred method of installation is Package Control.

Manual installation

Close Sublime Text, then download or clone this repository to a directory named PHPGrammar in the Sublime Text Packages directory for your platform:

OS	Command
Linux	git clone https://github.com/gerardroche/sublime-php-grammar.git ~/.config/sublime-text-3/Packages/PHPGrammar
OSX	git clone https://github.com/gerardroche/sublime-php-grammar.git ~/Library/Application\ Support/Sublime\ Text\ 3/Packages/PHPGrammar
Windows	git clone https://github.com/gerardroche/sublime-php-grammar.git %APPDATA%\Sublime/ Text/ 3/Packages/PHPGrammar

USAGE

Smart macros

To insert any literal character add Shift e.g. in a case where Enter runs a macro, to insert a newline on Enter (instead of running the macro) press Shift+Enter.

On Ctrl+Enter

<?php

array(                      //    array(
    'str|'                  //        'str',
)                           //        |
                            //    )

<?php

'str|ing'                   //    'string';
                            //    |

<?php

function_call(|)            //    function_call();
                            //    |

<?php

if ($condition|)            //    if ($condition) {
                            //        |
                            //    }

<?php

foreach ($x => $y|)         //    foreach ($x => $y) {
                            //        |
                            //    }

<?php

while ($condition|)         //    while ($condition) {
                            //        |
                            //    }

<?php

for ($i = 0; $i < ; $i++|)  //    for ($i = 0; $i < ; $i++) {
                            //        |
                            //    }

<?php

switch ($condition|)        //    switch ($condition) {
                            //        |
                            //    }

<?php

function x(|)               //    function x()
                            //    {
                            //        |
                            //    }

<?php

class x                     //    class x
{                           //    {
    public function y(|)    //        public function y()
}                           //        {
                            //            |
                            //        }
                            //    }

On Ctrl+;

'str|ing'                   //    'string';|

<?php

function_call(|)            //    function_call();|

On Enter

array(|)                    //    array(
                            //        |
                            //    )

<?php

function_call(|)            //    function_call(
                            //        |
                            //    )

<?php

new class_name(|)           //    new class_name(
                            //        |
                            //    )

On Tab

$arr = array(               //    $arr = array(
    'str|'                  //        'str' => |
)                           //    )

<?php

$arr = array(               //    $arr = array(
    'str'|                  //        'str' => |
)                           //    )

On [

$arr = |                    //    $arr = [|];

On ]

$arr = [|                   //    $arr = [|];

CONTRIBUTING

See CONTRIBUTING.md.

LICENSE

Released under the BSD 3-Clause License.

sublime-php-grammar's Issues

Missing function `boolval` from PHP built-in functions list

Tracker issue for SublimeTextIssues repo php issues

Re: jskinner/DefaultPackages#6

Error loading syntax files PHP.sublime-syntax

I'm using ST3 build 3092.

After cloning sublime-php-grammar into ~/Library/Application Support/Sublime Text 3/Packages, I get this error:

Error loading syntax file "Packages/PHP/PHP.sublime-syntax": Unable to read Packages/PHP/PHP.sublime-syntax

Third-party syntaxes, "source.php" scope not working

A package I'm using for laravel blade template syntax highlighting uses - include: 'scope:source.php' to achieve PHP syntax highlighting where appropriate. This works fine with the default PHP syntax definition, not so much with this package.

I see that the default PHP syntax is split into two files - one for the "embedding.php" scope, and one for the "source.php" scope. The embedding one is the one actually used for files, and it includes the "source.php" one, but also allows other syntax definitions to include the "source.php" scope without importing the full embedded HTML syntax.

Is this approach something this package could adopt? It would fix compatibility with the blade package and possibly others that build on top of the "source.php" scope.

https://github.com/sublimehq/Packages/blob/master/PHP/PHP.sublime-syntax
https://github.com/sublimehq/Packages/blob/master/PHP/PHP%20Source.sublime-syntax

PHP "double-slash" comments are not indented. And breaks further indentation.

Hi!

I have search in issues, but did not find anything similar, please correct me if I'm wrong:

At first, guys, Great plugin! Works great and does 'almost' all I have needed.
Except.

If I have one comment line in PHP, starting with "//", it will not be indented, but will start from first column:

<?php
class Product extends Controller {
    private $error = array();
    public function indentationTest() {
// This is comment line, 
    // both lines must start at column 3 after indentation!
        echo "test";
    }
}

And also - if the "//" comment line starts at the end of PHP line, then indentation from the next line start at column 1:

<?php
class Product extends Controller {
    private $error = array();
public function indentationTest() { // This is comment and breaks THIS line and everything further
// now this and all other lines must still start
// at column 3 ! But they don't.
    echo "test";
}
}

Is this a bug or is this a Feature?

Email address in docblock comments

In the following comment:

/**
 * (c) Some Guy <[email protected]>
 */

The @gmail bit will be highlighted as if it is an annotation similar to @var or @param.

ending comma per element in array on enter

Enter:

$arr = array(               | $arr = array(
    'str' => 'test'|        |     'str' => 'test',
)                           |     '|'
                            | )

PHP Syntax disappeared after uninstall

After I uninstalled the php grammar plugin, my PHP syntax completely disappeared. I tried to close all files. Reopened sublime. Nothing seems to help. When I take a look in the list of syntaxes, the PHP syntax is missing.

I'm using Mac OS X, ST3 build 3083.

Re-enable PHP in uninstall hook

If there is an uninstall hook/event/trigger, this package should re-enable PHP. I've no idea if it's possible.

Short array syntax indentation not working

$v = array(
array(
array(
array()
)
)
);

$v = [
[
[
[]
]
]
]

Expect

$v = array(
    array(
        array(
            array()
        )
    )
);

$v = [
    [
        [
            []
        ]
    ]
]

Actual

$v = array(
    array(
        array(
            array()
        )
    )
);

$v = [
[
[
[]
]
]
]

Only last inherited interface gets highlighted

Classes before the last one aren't highlighted at all:

This also happens on github.com, which uses this bundle for highlighting PHP code: https://github.com/mikemirten/ZExt/blob/49295321460207a5f2db4e6d7c05082c3502a6ef/library/ZExt/Di/ContainerInterface.php#L38. It was reported by one of our users.

Re: textmate php.tmbundle issue 53

Add .php_cs php filetype

re: atom/language-php/pull/94

@foo@ should not be matched as a phpdoc tag

The following should be a phpdoc tag.

/**
 * @foo@
 */
``

Similar to #11.

Array string macro not working for short array syntax

Append comma newline macro not working in short array syntax string.

Re: #1 (comment)

[
    'x|'
]

Actual

[
    'x
|'
]

Expect

[
    'x',
    |
]

PSR 2 switch case

See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md#52-switch-case

Expected

switch ($expr) {
    case 0:
        echo 'First case, with a break';
        break;
    case 1:
        echo 'Second case, which falls through';
        // no break
    case 2:
    case 3:
    case 4:
        echo 'Third case, return instead of break';
        return;
    default:
        echo 'Default case';
        break;
}

Actual

switch ($expr) {
    case 0:
    echo 'First case, with a break';
    break;
    case 1:
    echo 'Second case, which falls through';
        // no break
    case 2:
    case 3:
    case 4:
    echo 'Third case, return instead of break';
    return;
    default:
    echo 'Default case';
    break;
}

PSR 2 method arguments

Expected

namespace Vendor\Package;

class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []
    ) {
        echo 'method body';
    }
}

Actual

namespace Vendor\Package;

class ClassName
{
    public function aVeryLongMethodName(
        ClassTypeHint $arg1,
        &$arg2,
        array $arg3 = []
        ) {
        echo 'method body';
    }
}

See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md#44-method-arguments

Error loading syntax file dialog

When installing php-grammar sometimes an error dialog pops up with "Error loading syntax file".

Error loading syntax file "Packages/HTML/HTML.tmLanguage": Unable to open Packages/PHP/PHP.tmLanguage

Error loading syntax file "Packages/php-grammar/PHP.sublime-syntax": Unable to read Packages/php-grammar/PHP.sublime-syntax

To resolve this, close any opened php files. Once closed reopening them will have the new installed syntax applied and there will be no more error dialogs.

The reason this happens is because ST caches the syntax definition applied to the opened views. When the new syntax is installed it is not automatically applied to opened views by ST.

When opening other workspaces that had the old syntax applied, if the workspace starts with opened files there may be the error dialog again. Closing the open files will resolve it.

This only needs to be done once on install if there open php files when php-grammar is installed and once for workspaces created before installing php-grammar and that start with opened files.

re: #9 (comment)

Fix assignment operator consuming comparison operators

re: atom/language-php#114

final class should not be storage.modifier.abstract

Actual

abstract class Name {}
// ^ meta.class storage.modifier.abstract

final class Name {}
// ^ meta.class storage.modifier.abstract

Expected

abstract class Name {}
// ^ meta.class storage.modifier.abstract

final class Name {}
// ^ meta.class storage.modifier.final

Multiline function arguments, last argument with no type or default

In the following example, $bar will not receive the variable.other.php type, causing it not to be coloured. Adding a type (MyType $bar) or default value ($bar = null) fixes it.

function f(
    $foo,
    $bar
) {}

PSR 2 extended and implemented classes on newlines

Indentation

Expected

class ClassName extends ParentClass implements
    \ArrayAccess,
    \Countable,
    \Serializable
{
    // constants, properties, methods
}

Actual

class ClassName extends ParentClass implements
\ArrayAccess,
\Countable,
\Serializable
{
    // constants, properties, methods
}

See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md#41-extends-and-implements

Add "array" to storage type in function arguments

function x(array $a) {}

The array type hint scope is:

meta.function meta.function.arguments meta.function.argument.array storage.type

it could be:

meta.function meta.function.arguments meta.function.argument.array storage.type.array

Function call and class instantiation parens should increase indentation

Indentation between parens for fucntion calls and instantiation should at least not decrease indentation.

Ideally the indentation is increased. And better still, a macro to put the closing parent on a newline.

Example 1 - Instantiation

function test() {
    throw new InvalidArgumentException(|)
}

Expected at least

function test() {
    throw new InvalidArgumentException(
    |)
}

Actual

function test() {
    throw new InvalidArgumentException(
|)
}

Ideal

function test() {
    throw new InvalidArgumentException(
        |
    )
}

Example 2 - Function calls

function test2() {
    test(|)
}

Expected at least

function test2() {
    test(
    |)
}

Actual

function test2() {
    test(
|)
}

Ideal

function test2() {
    test(
        |
    )
}

autocomplete conflict

Enter

```php
$val = array(               | $val = array(
    'str|'                  |     'str',
)                           |     |
                            | )
```

this should use Ctrl + Enter instead because when typing 'string' if has an autocomplete popup visible, press Enter should select autocomplete value instead of run the macro.

Callable type hint is identified as class - potential bug

re: atom/language-php#108

function arguments missing a comma separator should not be legal

Both of the blow examples should not be legal function arguments because they are missing the comma separator.

Re: #12 (comment)

<?php

function x(
$a
$b
$c
) { }

<?php

function y(
$a # something
$b # comment
$c # etc
) { }

Add smart array ` => ` macro completion

Pressing tab at:

$x = array(
    'str'|           
);                  

Should complete as:

$x = array(
    'str' => |
);

Language syntax test suite

Long array definition with empty spaces in values assignment breaks indentation

I have strange problem - with this kind of "long" array definition,

<?php
class Test {
public function testFunction($product_id, $exclude = '') {
if ($product_id) {
$result = array(
'product_id'       => $query->row['product_id'],
'name'            => $query->row['name'],
'subtitle'         => $query->row['subtitle'],
'description'      => $query->row['description'],
'meta_description' => $query->row['meta_description'],
'meta_keyword'     => $query->row['meta_keyword'],
'tag'              => $query->row['tag'],
'model'            => $query->row['model'],
'sku'             => $query->row['sku'],
'upc'                => $query->row['upc'],
'ean'              => $query->row['ean'],
'jan'        => $query->row['jan'],
'a' => $query->row['a'],
'b' => $query->row['b'],
'c' => $query->row['c'],
'd' => $query->row['d'],
'f' => $query->row['f'],
'image'            => $query->row['image']);
echo "test";
}
}
}

Indentation works only till array definition closure.

Untill you delete "at least one" empty space character in any array element assigmen

'product_id'---delete-one-space-here-e.g.-=> $query->row['product_id'],

Then, indentation works!!! This is slosest I've got with debug.

Whitespace around reference char should not include storage.modifier.reference

Test case

function    &  x() {}
//             ^ -storage.modifier.reference
//              ^ storage.modifier.reference
//               ^ -storage.modifier.reference

Refactor test utils into common package library

Indentation test utils and language test utils can be refactored so that other language packages can use it.

Consistent function argument scopes

Argument parsing could be consistent with "default" and "no-default" scopes.

Either add them to all function arguments or remove them.

Example of adding them:

Actual

function x($a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.no-default
function x($a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default
function x(array $a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.array
function x(array $a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.array
function x(array $a = []) {}
//          ^ meta.function meta.function.arguments meta.function.argument.array
function x(array $a = array()) {}
//          ^ meta.function meta.function.arguments meta.function.argument.array
function x(Name $a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.typehinted
function x(Name $a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.typehinted

Expected

function x($a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.no-default
function x($a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default
function x(array $a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.no-default.array
function x(array $a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default.array
function x(array $a = []) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default.array
function x(array $a = array()) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default.array
function x(Name $a) {}
//          ^ meta.function meta.function.arguments meta.function.argument.no-default.typehinted
function x(Name $a = null) {}
//          ^ meta.function meta.function.arguments meta.function.argument.default.typehinted

Test suite for macros

For example to test bugs like #6

ctrl + enter macro

if ($some_var == 'some value'|) 

ctrl+enter then should be:

| if ($some_var == 'some value') 
|    |

or

| if ($some_var == 'some value') {
|    |
| }

instead of:

| if ($some_var == 'some value');
|

No HTML syntax highlighting

Any HTML that is outside PHP tags is not getting highlighted. Tags, attributes etc just come up black. The default PHP syntax highlighting has this (plus CSS/JS where appropriate).

Using ST build 3083 (latest stable). Using the "Lazy" colour scheme but changing it doesn't make a difference - the HTML is all one colour.

Add smart array ` => ` macro completion at end of string

Re: #41 (comment)

Add Package Settings Menu with README, CHANGELOG, and LICENSE links

One line control statements should not cause indentation

Actual

if (true) { }
    if (true) { }
        if (true) { }
            foreach (array() as $item) { }
                foreach (array() as $item) { }
                    foreach (array() as $item) { }

Expect

if (true) { }
if (true) { }
if (true) { }
foreach (array() as $item) { }
foreach (array() as $item) { }
foreach (array() as $item) { }

HTML has no effect by color scheme

My HTML code has no effect by color scheme when i ignored PHP package in sublime-setting. How to resolved it?

Thanks!

Incorrect phtml declare() statement indentation in ST3

ST3 dependency issue with the HTML and PHP packages.

The following is due to the HTML package doing PHP indentation and the PHP is not able to override it and fix it.

Some existing indentation are failing because of this.

Expect

    <?php declare(ticks = 0) : ?>
        <?php echo "Statement 1\n"; ?>
        <?= "Statement 2\n"; ?>
    <?php enddeclare; ?>

Actual

    <?php declare(ticks = 0) : ?>
    <?php echo "Statement 1\n"; ?>
    <?= "Statement 2\n"; ?>
    <?php enddeclare; ?>

Consider contributing to official packages

https://github.com/sublimehq/Packages
Not everything from php-grammar goes there, but for example the syntax is a great start. Oh, also: sublimehq/Packages#22. Maybe you two could work together to ultimately improve the official package? @jobedom

A possible wrong indentation?

Let's take the preg_replace for an example.
Sometimes it's long to write a preg_replace(...) statement in a single line so I write it in the form of the following.

$str = preg_replace(
    my_pattern_string,
    my_replacement_string,
    $str
);

But it causes a weird indentation which is shown as the following screenshot.
(This is tested under a clean Sublime Text 3092 dev.)

<?php
if (1) {
    $a = preg_replace(|)
}

After pressing Enter:

<?php
if (1) {
    $a = preg_replace(
|)
}

---

Is this a bug?

Trait declaration not matching comments

Expected

trait Name
// one line comment
// ^ comment.line.double-slash
{

}

PSR 2 closures

See https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md#6-closures

$longArgs_noVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) {
   echo 'body';
};

$noArgs_longVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
   echo 'body';
};

$longArgs_longVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
   echo 'body';
};

$longArgs_shortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
) use ($var1) {
   echo 'body';
};

$shortArgs_longVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
) {
   echo 'body';
};

Actual

$longArgs_noVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
    ) {
 echo 'body';
};

$noArgs_longVars = function () use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
    ) {
 echo 'body';
};

$longArgs_longVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
    ) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
    ) {
     echo 'body';
 };

 $longArgs_shortVars = function (
    $longArgument,
    $longerArgument,
    $muchLongerArgument
    ) use ($var1) {
     echo 'body';
 };

 $shortArgs_longVars = function ($arg) use (
    $longVar1,
    $longerVar2,
    $muchLongerVar3
    ) {
     echo 'body';
 };

Remove leading whitespace from various scopes

Related to #36 27

See also textmate/php.tmbundle@d4b0b30 for example where leading whitespace should be removed.

Nonempty array as default value in typehinted arguments isn't highlighted correctly

atom/language-php#112

namespace scope should be consistent with other scopes like classes and functions

Example

Actual

namespace Xyz;
//  ^ meta.namespace keyword.other.namespace
//        ^ meta.namespace entity.name.type.namespace

class Name
// ^ meta.class storage.type.class
//      ^ meta.class entity.name.type.class

Expected

namespace Xyz;
// ^ meta.namespace storage.type.namespace
//        ^ meta.class entity.name.type.namespace

class Name
// ^ meta.class storage.type.class
//      ^ meta.class entity.name.type.class

Tab no working

Hi, when I put the following does not work

$g = array(
                'sdfdofokosdf',
                'hola',
                "hola(PRESS TAB)"

            )
             ?>

The result should be

$g = array(
                'sdfdofokosdf',
                'hola',
                "hola" => 

            )
             ?>

but it does not work, it can be happening?

Package Control?

Is this available in Package Control? If not, can you add?

Strings e.g. "SELECT", "DELETE", etc should not be matched as sql

e.g.

$x = "SELECT * FROM tbl";

Should match as sql, but

$x = "SELECT"; 

should not.

Tab highlighting changes color before return in PHP files

Re: jskinner/DefaultPackages#147

See also textmate/php.tmbundle@d4b0b30

Related: #27