search

Getbeans / Beans

Beans WordPress Theme Framework. The default branch is set to development, please switch to the master branch for production.
https://www.getbeans.io
Other
392 stars 61 forks source link

[WIP] Fix - WPCS 1.10 will cause errors and warnings #340

Closed lrobi2014 closed 6 years ago

lrobi2014 commented 6 years ago

This PR includes a lot of class and file renaming.

christophherr commented 6 years ago

Hi @lrobi2014, Thank you for taking on this issue :)

How are you running phpcs? Our phpcs.xml.dist is ignoring file and class names, you should not receive any errors/warnings about those. Or in other words, we are not going to rename them. As a matter of convention, file or class names starting with _ are considered private, i.e. only for internal use.

We are ignoring the files in lib/api/compiler/vendors because they are from external sources.

lrobi2014 commented 6 years ago

Hi @christophherr,

Erm, maybe I made a mistake in the way I was running it 😓

I use, for example: phpcs --extensions=php --standard=Wordpress-Core lib/api-v

I can revert the renaming?

christophherr commented 6 years ago

Hi @lrobi2014,

That looks like you are running a globally installed version of phpcs.

If possible, you should only run the versions that a project is using. To do that, you have to run composer install in the directory with the Beans theme. Then you can also use our composer scripts, e.g. composer run-phpcs or composer run-tests. (Take a look in composer.json to see the available scripts)

Tonya wrote up instructions in our Wiki: https://github.com/Getbeans/Beans/wiki/Contributors-Quick-Start

If you have any questions, you can also contact me in the Beans Slack group.