Not working with PHP_CodeSniffer 3.13

[andremacola]

There is a problem using with PHP_CodeSniffer ^3.13

Traceback (most recent call last):
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/backend.py", line 245, in execute_lint_task
    errors = linter.lint(code, view_has_changed)
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1173, in lint
    return self.filter_errors(self.parse_output(output, virtual_view))
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1196, in filter_errors
    return [
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1196, in <listcomp>
    return [
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1236, in parse_output_via_regex
    for m in self.find_errors(output):
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter-phpcs.sublime-package/linter.py", line 15, in find_errors
    data = json.loads(output)
  File "./python3.8/json/__init__.py", line 357, in loads
  File "./python3.8/json/decoder.py", line 337, in decode
  File "./python3.8/json/decoder.py", line 355, in raw_decode
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)
SublimeLinter: ERROR: Unhandled exception:

[kaste]

You should turn on debug mode. Hopefully it prints out the stdout before it catches fire.

[andremacola]

reloading settings Packages/User/SublimeLinter.sublime-settings
SublimeLinter: log_handler.py:77      Logging installed; log level INFO
SublimeLinter: backend.py:75          Delay linting 'functions.php' for 0.25s
SublimeLinter: linter.py:1137         phpcs: Checking lint mode 'on_load, on_modified' vs lint reason 'on_modified'.  Ok.
SublimeLinter: #6 linter.py:1153      phpcs: linting 'functions.php'
SublimeLinter: #6 util.py:304         PATH:
.......
SublimeLinter: #6 linter.py:922       phpcs: wanted executable is '/Users/andremacola/Work/Local/xxxx/xxxx/core/vendor/bin/phpcs'
SublimeLinter: #6 linter.py:1699      Running ...

  /Users/andremacola/Work/Local/xxxx/xxxx  (working dir)
  $ cat functions.php | /Users/andremacola/Work/Local/xxxx/xxxx/core/vendor/bin/phpcs --report=json -s --standard=/Users/andremacola/Work/Local/xxxx/xxxx/.phpcs.xml --stdin-path=/Users/andremacola/Work/Local/xxxx/xxxx/functions.php -

SublimeLinter: #6 linter.py:1233      phpcs: output:
  WARNING: The WordPress standard uses 1 deprecated sniff
  -------------------------------------------------------------------------------
  -  Generic.Functions.CallTimePassByReference
     This sniff has been deprecated since v3.12.1 and will be removed in v4.0.0.

  Deprecated sniffs are still run, but will stop working at some point in the
  future.

  {"totals":{"errors":1,"warnings":1,"fixable":2},"files":{"\/Users\/andremacola\/Work\/Local\/xxxx\/xxxx\/functions.php":{"errors":1,"warnings":1,"messages":[{"message":"Found precision alignment of 3 spaces.","source":"Universal.WhiteSpace.PrecisionAlignment.Found","severity":5,"fixable":true,"type":"WARNING","line":4,"column":1},{"message":"Expected 1 space before the array closer in a single line array. Found: no spaces","source":"NormalizedArrays.Arrays.ArrayBraceSpacing.SpaceBeforeArrayCloserSingleLine","severity":5,"fixable":true,"type":"ERROR","line":53,"column":38}]}}}
SublimeLinter: #6 backend.py:257      ERROR: Unhandled exception:
Traceback (most recent call last):
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/backend.py", line 245, in execute_lint_task
    errors = linter.lint(code, view_has_changed)
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1173, in lint
    return self.filter_errors(self.parse_output(output, virtual_view))
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1196, in filter_errors
    return [
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1196, in <listcomp>
    return [
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter.sublime-package/lint/linter.py", line 1236, in parse_output_via_regex
    for m in self.find_errors(output):
  File "/Users/andremacola/Library/Application Support/Sublime Text/Installed Packages/SublimeLinter-phpcs.sublime-package/linter.py", line 15, in find_errors
    data = json.loads(output)
  File "./python3.8/json/__init__.py", line 357, in loads
  File "./python3.8/json/decoder.py", line 337, in decode
  File "./python3.8/json/decoder.py", line 355, in raw_decode
json.decoder.JSONDecodeError: Expecting value: line 1 column 1 (char 0)
SublimeLinter: backend.py:460         Linting 'functions.php' with phpcs took 0.17s

[kaste]

Dang, we ask for a json report and it still prints out some deprecations as text.

I think eslint does the same and has some code for it. Is that printed on stderr or stdout even? Maybe you can dig a bit deeper, or @braver, as I'm on vacation.

[braver]

I have reported the issue upstream: PHPCSStandards/PHP_CodeSniffer#1165

I don't see any documented flags to disable the deprecation warnings, or any other workarounds. So perhaps we should pre-clean the output (like remove everything up to the first {)?

[braver]

think eslint does the same and has some code for it

Looks like it. It looks for some keywords in the output to look for deprecation warnings, and if it finds some it reports that as an error and basically aborts at that point (if I read it correctly). That might be the way to go.

@andremacola Do you perhaps have some sample code that triggers that deprecation?

[braver]

You might also be asking for trouble a bit running the latest version of codesniffer on PHP code that uses features that have been deprecated in PHP5 😅

[braver]

@andremacola Have a look at the reply from the maintainers of phpcs itself:

For now, deprecation notices can be silenced by using the -q flag when running PHPCS. That should already solve your problem.
PHPCSStandards/PHP_CodeSniffer#1165 (comment)

Can you try adding the -q flag to see if that removes the deprecation warning so the report start working again?

Edit: from the docs

-q                             Quiet mode; disables progress and verbose output.

[jrfnl]

Just FYI as this deprecation seems to be related to the WordPressCS standard - WordPressCS 3.2.0 was released yesterday and the offending sniff was removed from the ruleset, so for anyone who currently runs into this: update your WPCS install and all should be fine again ;-)

[braver]

@jrfnl thanks for the follow up 👍🏻 between that and the q flag I bet this one’s covered.