Symfony routing-file validation

[bobvandevijver]

Hi,

First of all, great project!

I want to use this project to lint Symfony routing files. Below is an example of such a file:

# app/config/routing.yml
blog_list:
    path:      /blog
    defaults:  { _controller: AppBundle:Blog:list }

blog_show:
    path:      /blog/{slug}
    defaults:  { _controller: AppBundle:Blog:show }

However, apparently the : in the controller name is not considered as valid syntax. The output below is from the linter with default configuration on the snippet above:

test.yml
  2:1       warning  missing document start "---"  (document-start)
  3:15      error    too many spaces after colon  (colons)
  4:15      error    too many spaces after colon  (colons)
  4:17      error    too many spaces inside braces  (braces)
  4:40      error    syntax error: found unexpected ':'

A solution for the linter would be to place the value in "'s, but that breaks stuff in other parts.

Do you have any suggestion on how to fix this problem? I would really like to use this linter, but as long as it generates the syntax errors it is useless for my project...

[adrienverge]

Hi @bobvandevijver,

Thanks, I wasn't aware of that limitation.

The problem comes from pyyaml, the Python YAML library (on which yamllint relies). It can be reproduced using:

$ python
>>> import yaml
>>> yaml.load('{ key: va:lue }')

yaml.scanner.ScannerError: while scanning a plain scalar

found unexpected ':'
  in "<string>", line 1, column 10:
    { key: va:lue }

I've looked into the official spec, to check that your YAML code is valid. It is. The spec states that plain scalars cannot contain ": ", but can contain ":":

Plain scalars must never contain the “: ” and “ #” character combinations.

Normally, YAML insists the “:” mapping value indicator be separated from the value by white space. A benefit of this restriction is that the “:” character can be used inside plain scalars, as long as it is not followed by white space. This allows for unquoted URLs and timestamps. It is also a potential source for confusion as “a:1” is a plain scalar and not a key: value pair.

So I suggest you report this bug at pyyaml, so this gets fixed upstream. Feel free to link this issue for reference.

In the meantime, you could use this equivalent notation (that does not break pyyaml):

blog_list:
    path: /blog
    defaults:  
        _controller: AppBundle:Blog:list

[adrienverge]

By digging further I found this open pull request at pyyaml: yaml/pyyaml#45

Hopefully it will get merged and your problem will disappear!

[freddrake]

If you want to keep the single-line format, you can quote the controller name:

# app/config/routing.yml
blog_list:
    path:      /blog
    defaults:  { _controller: "AppBundle:Blog:list" }

blog_show:
    path:      /blog/{slug}
    defaults:  { _controller: "AppBundle:Blog:show" }

[bobvandevijver]

@adrienverge Thank you for the information, lets hope that it will be merged soon 😃

@freddrake I know, but with the quotes the autocomplete in my IDE no longer works. Besides, I would have to change quite a lot of route names...

[freddrake]

@bobvandevijver: I agree getting the fix landed would be best.

[bobvandevijver]

As a temporary solution I'm using the following command/regex in order to replace the "errors" in the yaml files (might anyone be interested):

find src -type f -name *.yml -exec sed -ri 's/(_controller: )([a-zA-Z]+:[a-zA-Z\/]+:[a-zA-Z]+)/\1\"\2\"/g' {} \;

[adrienverge]

yaml/pyyaml#45 has been merged and released, and the bug doesn't appear anymore on my side.