Option for installed_paths

[bueltge]

Would be great that we have also the possibility to add options like installed_paths so we can set config like phpcs --config-set installed_paths "../../coding-standards/example/,../../automattic/phpcs-neutron-standard/"

About this option: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options#setting-the-installed-standard-paths

maybe like

inputs:
  enable_warnings:
    description: 'Enable checking for warnings (-w)'
    required: false
    default: ''
  installed_paths:
    description: 'Setting the installed standard paths'
    required: false
    default: ''

[chekalsky]

Hey, @bueltge!

Could you try branch option-installed-paths with your standard paths? To do so you need to replace @v1 to @option-installed-paths in your Github Actions YAML file.

[bueltge]

Hi @chekalsky
Thanks for your fast feedback. The branch has no hint inside the readme about this option. You see my yaml file here: https://github.com/bueltge/adminimize/blob/master/.github/workflows/php.yml
I'm not sure if is necessary to add the --config-set parameter.
you see the result here on this action https://github.com/bueltge/adminimize/runs/554501917?check_suite_focus=true

I get an error about a phpcs definition, however the option, the branch should work. Currently, I haven't any idea to fix the error, because I install them via composer, works also fine via local test but always with the phpcs there is not globally - vendort/bin/phpcs - maybe that's the point?

[jrfnl]

@bueltge If you install the standards via Composer anyway, why not add the Composer PHPCS plugin to your dependencies too ?
That way the plugin already takes care of setting the installed paths on composer install.

[bueltge]

Thanks @jrfnl for your helping hands. I have this repo include in this test repo: https://github.com/bueltge/adminimize/blob/master/composer.json#L24

On default, I use phpcs via GitHub Actions with the help of script inside the composer.json, like https://github.com/bueltge/marksimple/blob/master/.github/workflows/main.yml#L29
But I would try them via actions to reduce the custom scripts inside the composer to leave them always on the CI fror GitHub.

[jrfnl]

@bueltge You probably want to update the version of the plugin as by now, it's on 0.6.2 (Composer treats minors < 1.0. as majors), but with that setup I would expect standards to be recognized correctly without having to do anything extra for the GH Action. You'd still need a composer installanyway, so the plugin should run.

[bueltge]

I'm not sure that I understand it correctly Juliette. I update the version keys inside the composer config file. But after the action runs, I missed several packages -
After composer install via action:

Package operations: 4 installs, 0 updates, 0 removals
  - Installing composer/installers (v1.5.0): Downloading (100%)
  - Installing dg/composer-cleaner (v2.0): Downloading (100%)
  - Installing squizlabs/php_codesniffer (3.3.0): Downloading (100%)
  - Installing wp-coding-standards/wpcs (0.14.1): Downloading (100%)
Generating optimized autoload files

vs. the dependencies from the composer config.

	"require-dev": {
		"dealerdirect/phpcodesniffer-composer-installer": "*",
		"phpcompatibility/phpcompatibility-wp": "*",
		"squizlabs/php_codesniffer": "^3",
		"wp-coding-standards/wpcs": "*",
		"roave/security-advisories": "dev-master",
		"dg/composer-cleaner": "^2"

Thanks again for your time and help!

[chekalsky]

@bueltge could you please try the full path e.g. /github/workspace/vendor/wpcs (if they are installed there)

[bueltge]

I think this the right path, https://github.com/bueltge/adminimize/blob/master/.github/workflows/php.yml#L31
Run here: https://github.com/bueltge/adminimize/runs/555917633?check_suite_focus=true
wpcs will install inside the root of the source directory,

[jenkoian]

We're having the same issues here. I was hoping https://github.com/Dealerdirect/phpcodesniffer-composer-installer/ would work but don't think it will because the script is assuming use of phpcs globally (this is just a theory at this point, not tested).

Are you able to make the phpcs path configurable?

[jrfnl]

@jenkoian If PHPCS is installed using composer global, the plugin (and all external standards) should be too, but yes, then it should work fine for the global install.

[jenkoian]

Ok I got this working...here's what I had to do...

Used changes from this PR: #7

Then in my phpcs.yml I ran composer (YMMV) and then the important bit for me was the following...

- name: "Install coding standards"
run: composer run-script install-codestandards

See https://github.com/Dealerdirect/phpcodesniffer-composer-installer/#calling-the-plugin-directly for details.

[chekalsky]

@bueltge Could you please try this path? /github/workspace/vendor/phpcompatibility/php-compatibility,/github/workspace/vendor/phpcompatibility/php-compatibility-wp

I've tried it and it worked. Now I will try to make it works without absolute path.

[chekalsky]

I've tried couple of options and think that providing ability to use local phpcs is the best option. But I have a question: could we do it that way?
This allows to use Dealerdirect/phpcodesniffer-composer-installer without any hassle.

@jenkoian @jrfnl @bueltge

[jenkoian]

@chekalsky not sure about that line specifically, but the vendor/bin/phpcs won't work for all as you can configure bin directory in composer (for instance we move ours to simply ./bin