phpcs with SPIP coding standards

[bricebou]

Hi,

I'm trying to use SPIP Coding Standards (https://packagist.org/packages/spip/coding-standards) for phpcs.

$ phpcs -i
The installed coding standards are MySource, PEAR, PSR1, PSR2, PSR12, Squiz, Zend, PHPCompatibility, SCS1, SPIP40 and SPIP41

As you can see they are well installed and I can use them with the command-line phpcs --standard=SPIP41 . for example...

But when I try to use this SPIP41 standard within AstroNVim with null-ls plugin, I have this error 👍

[TRACE ven. 06 janv. 2023 18:20:02] .../pack/packer/opt/null-ls.nvim/lua/null-ls/generators.lua:21: running generators for method NULL_LS_DIAGNOSTICS_ON_OPEN
[DEBUG ven. 06 janv. 2023 18:20:02] ...t/null-ls.nvim/lua/null-ls/helpers/generator_factory.lua:320: spawning command "phpcs" at /home/bricebou/test with args { "--report=json", "-q", "-s", "--runtime-set", "ignore_warnings_on_exit", "1", "--runtime-set", "ignore_errors_on_exit", "1", "--stdin-path=/home/bricebou/test/index.php", "--basepath=" }
[TRACE ven. 06 janv. 2023 18:20:02] ...t/null-ls.nvim/lua/null-ls/helpers/generator_factory.lua:204: error output: ERROR: Referenced sniff "SPIP41" does not exist

I'm using this simple phpcs.xml.dist :

<?xml version="1.0"?>
<ruleset xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" name="PHP_CodeSniffer" xsi:noNamespaceSchemaLocation="phpcs.xsd">
    <description>The coding standard for PHP_CodeSniffer itself.</description>

    <file>index.php</file>

    <arg name="basepath" value="."/>
    <arg name="colors"/>
    <arg name="parallel" value="75"/>
    <arg value="np"/>

    <rule ref="SPIP41"></rule>
</ruleset>

Any idea ? Thanks :)

[bricebou]

I've managed to solve this issue by running

$ ./phpcs --config-set installed_paths /home/$USER/.config/composer/vendor/spip/coding-standards/src/,/home/$USER/.config/composer/vendor/phpcompatibility/php-compatibility

within the ~/.local/share/nvim/mason/packages/phpcs folder...

But now, I get this error...

[DEBUG ven. 06 janv. 2023 18:57:39] ...t/null-ls.nvim/lua/null-ls/helpers/generator_factory.lua:320: spawning command "phpcs" at /home/bricebou/test with args { "--report=json", "-q", "-s", "--runtime-set", "ignore_warnings_on_exit", "1", "--runtime-set", "ignore_errors_on_exit", "1", "--stdin-path=/home/bricebou/test/index.php", "--basepath=" }
[TRACE ven. 06 janv. 2023 18:57:39] ...t/null-ls.nvim/lua/null-ls/helpers/generator_factory.lua:204: error output: PHP Fatal error:  Uncaught Error: Class "Spip\CodingStandards\Strings\SnakeCase" not found in /home/bricebou/.config/composer/vendor/spip/coding-standards/src/SCS1/Sniffs/NamingConventions/SnakeCaseVariableNameSniff.php:82

What is the difference between the globally installer phpcs and the one installed with Mason ? Same version... Same phpcs -i output...

Any idea ?

Thanks in advance !

[jose-elias-alvarez]

Since your setup has a lot of layers, I really can't say. Have you tried running it without Mason?

[bricebou]

Yeah, I've just managed to find a solution ; I'm using AstroNVim and here is the config part concerning my setup :

plugins = {
        -- All other entries override the require("<key>").setup({...}) call for default plugins
        ["null-ls"] = function(config) -- overrides `require("null-ls").setup(config)`
            -- config variable is the default configuration table for the setup functino call
            local null_ls = require "null-ls"
            -- Check supported formatters and linters
            -- https://github.com/jose-elias-alvarez/null-ls.nvim/tree/main/lua/null-ls/builtins/formatting
            -- https://github.com/jose-elias-alvarez/null-ls.nvim/tree/main/lua/null-ls/builtins/diagnostics
            config.setup = {
                debug = true
            }
            config.sources = {
                -- Set a formatter that is manually installed
                null_ls.builtins.diagnostics.phpcs.with({
                    command = "/home/bricebou/.config/composer/vendor/bin/phpcs"
                }),
                null_ls.builtins.formatting.phpcbf.with({
                    command = "/home/bricebou/.config/composer/vendor/bin/phpcbf",
                    args = {
                        "-q",
                        -- passes the filename to phpcs, so it respects all include and exclude patterns
                        "--stdin-path=$FILENAME",
                        -- process stdin
                        "-",
                    },
                    to_stdin = true,
                    check_exit_code = function(code)
                        -- phpcbf return a 1 or 2 exit code if it detects warnings or errors
                        -- return code <= 2
                    end,
                })
            }
            return config -- return final config table to use in require("null-ls").setup(config)
        end,   
    }

[bricebou]

I had to comment the content of the function for the check_exit_code entry because the output was replacing the content of the ignred files...

[jose-elias-alvarez]

Glad you figured it out, no idea on the check_exit_code issue. If you're able to replicate it without Mason + a config layer, feel free to open an issue.