WordPress.org
Get WordPress

Make WordPress Core

Ticket #44366: 44366.patch

File 44366.patch, 6.2 KB (added by jrf, 6 years ago)

  • .gitignore 

    From 30a33cb47c5934db080156e4e2f622ef86e52cb3 Mon Sep 17 00:00:00 2001
From: jrfnl <jrfnl@users.noreply.github.com>
Date: Mon, 11 Jun 2018 18:52:35 +0200
Subject: [PATCH] Update PHPCS ruleset for WP Core and related Composer setup

`.gitignore`:
* Add the typical filenames of overloaded PHPCS configs to `.gitignore`.

Composer:
* Use the `develop` (Packagist `dev-master`) version of WPCS as it contains lots of bugfixes.
* Remove the PHPCS dependency. This is a dependency of WPCS, not of WP Core itself. This will also make sure that the PHPCS version used is always one which is supported by WPCS.
* Refreshed the ``composer.lock` file.

PHPCS ruleset:
* Comment out a reference to a sniff which doesn't exist in WPCS yet (for now).
* Use the PHPCS 3.x `basepath` option to clean up the file paths PHPCS shows in the reports.
* Use the PHPCS 3.x `parallel` option to enable parallel scanning whenever possible to speed up the scans.
* Whitelist the `wp-includes/I18n.php` file from issues being reported by the `WordPress.WP.I18n` sniff.
---
 .gitignore     |  2 ++
 composer.json  |  3 +--
 composer.lock  | 22 +++++++++++-----------
 phpcs.xml.dist | 15 ++++++++++++++-
 4 files changed, 28 insertions(+), 14 deletions(-)

diff --git a/.gitignore b/.gitignore
index fcccc17759..b1ce13bf19 100644
    a b wp-tests-config.php 
    77
    88# Files and folders related to build/test tools
    99/phpunit.xml
     10/.phpcs.xml
     11/phpcs.xml
    1012/tests/phpunit/data/plugins/wordpress-importer
    1113/tests/phpunit/data/.trac-ticket-cache*
    1214/tests/qunit/compiled.html

  • composer.json 

    diff --git a/composer.json b/composer.json
index a95151612a..c612cbbfa3 100644
    a b  
    1111        },
    1212        "require-dev": {
    1313                "dealerdirect/phpcodesniffer-composer-installer": "^0.4.4",
    14                 "squizlabs/php_codesniffer": "^3.2.3",
    15                 "wp-coding-standards/wpcs": "dev-feature/new-multi-line-comment-formatting-sniffs"
     14                "wp-coding-standards/wpcs": "dev-master"
    1615        },
    1716        "scripts": {
    1817                "format": "phpcbf --standard=phpcs.xml.dist --report-summary --report-source",

  • composer.lock 

    diff --git a/composer.lock b/composer.lock
index 9176795c8c..2d88e21514 100644
    a b  
    44        "Read more about it at https://getcomposer.org/doc/01-basic-usage.md#composer-lock-the-lock-file",
    55        "This file is @generated automatically"
    66    ],
    7     "content-hash": "4b409623b2bc5d8e87b7f45d57a60990",
     7    "content-hash": "9c2c871b813e89682ef445611d2f5363",
    88    "packages": [],
    99    "packages-dev": [
    1010        {
    … …  
    7777        },
    7878        {
    7979            "name": "squizlabs/php_codesniffer",
    80             "version": "3.2.3",
     80            "version": "3.3.0",
    8181            "source": {
    8282                "type": "git",
    8383                "url": "https://github.com/squizlabs/PHP_CodeSniffer.git",
    84                 "reference": "4842476c434e375f9d3182ff7b89059583aa8b27"
     84                "reference": "d86873af43b4aa9d1f39a3601cc0cfcf02b25266"
    8585            },
    8686            "dist": {
    8787                "type": "zip",
    88                 "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/4842476c434e375f9d3182ff7b89059583aa8b27",
    89                 "reference": "4842476c434e375f9d3182ff7b89059583aa8b27",
     88                "url": "https://api.github.com/repos/squizlabs/PHP_CodeSniffer/zipball/d86873af43b4aa9d1f39a3601cc0cfcf02b25266",
     89                "reference": "d86873af43b4aa9d1f39a3601cc0cfcf02b25266",
    9090                "shasum": ""
    9191            },
    9292            "require": {
    … …  
    124124                "phpcs",
    125125                "standards"
    126126            ],
    127             "time": "2018-02-20T21:35:23+00:00"
     127            "time": "2018-06-06T23:58:19+00:00"
    128128        },
    129129        {
    130130            "name": "wp-coding-standards/wpcs",
    131             "version": "dev-feature/new-multi-line-comment-formatting-sniffs",
     131            "version": "dev-master",
    132132            "source": {
    133133                "type": "git",
    134134                "url": "https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards.git",
    135                 "reference": "ce4d719296ebbecd01f57bc3729833e89b39ad99"
     135                "reference": "cf6b310caad735816caef7573295f8a534374706"
    136136            },
    137137            "dist": {
    138138                "type": "zip",
    139                 "url": "https://api.github.com/repos/WordPress-Coding-Standards/WordPress-Coding-Standards/zipball/ce4d719296ebbecd01f57bc3729833e89b39ad99",
    140                 "reference": "ce4d719296ebbecd01f57bc3729833e89b39ad99",
     139                "url": "https://api.github.com/repos/WordPress-Coding-Standards/WordPress-Coding-Standards/zipball/cf6b310caad735816caef7573295f8a534374706",
     140                "reference": "cf6b310caad735816caef7573295f8a534374706",
    141141                "shasum": ""
    142142            },
    143143            "require": {
    … …  
    164164                "standards",
    165165                "wordpress"
    166166            ],
    167             "time": "2017-11-30T18:28:51+00:00"
     167            "time": "2018-02-16T01:57:48+00:00"
    168168        }
    169169    ],
    170170    "aliases": [],

  • phpcs.xml.dist 

    diff --git a/phpcs.xml.dist b/phpcs.xml.dist
index e119e13d08..63c249cc16 100644
    a b  
    44
    55        <rule ref="WordPress-Core"/>
    66        <rule ref="WordPress.CodeAnalysis.EmptyStatement"/>
    7         <rule ref="WordPress.Commenting.DocblockFormat"/>
     7        <!-- Commented out in anticipation of a PR to WPCS to add this sniff properly. -->
     8        <!--<rule ref="WordPress.Commenting.DocblockFormat"/>-->
    89
    910        <arg name="extensions" value="php"/>
    1011
     12        <!-- Strip the filepaths down to the relevant bit. -->
     13        <arg name="basepath" value="./"/>
     14
     15        <!-- Check up to 20 files simultanously. -->
     16        <arg name="parallel" value="20"/>
     17
    1118        <!-- Show sniff codes in all reports -->
    1219        <arg value="ps"/>
    1320
    … …  
    6976                <exclude-pattern>/tests/phpunit/tests/db\.php</exclude-pattern>
    7077        </rule>
    7178
     79        <!-- Whitelist the I18n functions file from issues identified by the I18n sniff
     80                (such as calling the low-level translate() function). -->
     81        <rule ref="WordPress.WP.I18n">
     82                <exclude-pattern>/src/wp-includes/l10n\.php</exclude-pattern>
     83        </rule>
     84
    7285        <rule ref="Generic.Functions.FunctionCallArgumentSpacing">
    7386                <exclude-pattern>/wp-config\.php</exclude-pattern>
    7487                <exclude-pattern>/wp-config-sample\.php</exclude-pattern>