Releasing v1.0.0 - Updating all libraries and standards

Author: davelavoie

README.md

@@ -3,15 +3,15 @@ c9.ide.language.php.wordpress
 
 __Name__ : WordPress Coding Standards Linter for Cloud9 
 
-__Current Version__: 0.0.2a
+__Current Version__: 1.0.0 (2018-10-10)
 
 __Author__ : [EP4](https://ep4.com)
 
 __Contributors__ : [Dave Lavoie](https://github.com/davelavoie)
 
 __License__ : GPLv3 or later
 
-Provides a linter in Cloud9 IDE for WordPress development using PHP CodeSniffer (PHPCS) based on WordPress Coding Standards (WPCS) and PHPCompatibility rules.
+Provides a linter in Cloud9 IDE for WordPress development using PHP CodeSniffer (PHPCS) based on WordPress Coding Standards (WPCS) and PHPCompatibility/PHPCompabitityWP rules.
 
 Installation
 ------------
@@ -69,18 +69,33 @@ Since there is no simple way to allow HTML in these tooltips, we use some custom
 Ressources
 ----------
 
-* PHP CodeSniffer : [GitHub repo](https://github.com/squizlabs/PHP_CodeSniffer) & [Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki)
+* PHP CodeSniffer : [GitHub Repo](https://github.com/squizlabs/PHP_CodeSniffer), [Wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki) & [Analysis of Coding Conventions for WP](https://squizlabs.github.io/PHP_CodeSniffer/analysis/WordPress/WordPress/index.html)
 * WordPress Coding Standards : [GitHub Repo](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards), [Wiki](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki) & [Whitelisting code which flags errors](https://github.com/WordPress-Coding-Standards/WordPress-Coding-Standards/wiki/Whitelisting-code-which-flags-errors)
-* PHPCompatibility : [GitHub Repo](https://github.com/wimg/PHPCompatibility)
+* PHPCompatibility : [GitHub Repo](https://github.com/PHPCompatibility/PHPCompatibility)
+* PHPCompatibilityWP : [GitHub Repo](https://github.com/PHPCompatibility/PHPCompatibilityWP)
 * Cloud9 : [SDK](https://cloud9-sdk.readme.io/) & [API](https://apidoc.c9.io)
 
 Changelog
 ---------
 
+### 1.0.0 - 2018-10-10
+
+* Updating PHP_CodeSniffer library to version 3.3.2.
+* Updating WordPress Coding Standards to version 1.1.0.
+* Updading PHPCompabitity standards to version 9.0.0.
+* Adding PHPCompabitityWP 2.0.0 and PHPCompatibilityParagonie 1.0.0 standards.
+* Increasing the stdout max output from 200KB to 500KB.
+* Increasing the timeout from 5 to 10 seconds.
+* Moving the checkmark icon (✔) after the position in the tooltip.
+* Including license files for each coding standards.
+* Removing the CSS rule used for hiding the debug bar since the plugin can be used without activating the debug mode now.
+* Some code refactoring.
+* Updating the 'Installation' section of the docs.
+
 ### 0.0.2a - 2017-02-13
 
-* Updating WP Coding Standards with the latest release as of 2017-02-10.
-* Updading PHPCompabitity with the latest release as of 2017-02-06
+* Updating WordPress Coding Standards with the latest release as of 2017-02-10.
+* Updading PHPCompabitity standards with the latest release as of 2017-02-06
 
 ### 0.0.1 (alpha) - 2017-02-10
 

package.json

@@ -1,12 +1,12 @@
 {
   "name": "phpcs.wpcs",
   "description": "Displays warnings in the IDE with the help of PHP CodeSniffer configured with WordPress Coding Standards and PHPCompatibility rules.",
-  "version": "0.0.2",
+  "version": "1.0.0",
   "author": "EP4",
   "contributors": [
     {
       "name": "Dave Lavoie",
-      "email": "dave.lavoie+c9@ep4.com"
+      "email": "dave.lavoie@ep4.com"
     }
   ],
   "repository": {

phpcs.wpcs.js

@@ -1,5 +1,6 @@
+// @see https://cloud9-sdk.readme.io/docs/language-handlers
 define(function(require, exports, module) {
-    main.consumes = ["Plugin", "language","ui"];
+    main.consumes = ["Plugin", "language", "ui"];
     main.provides = ["phpcs.wpcs"];
     return main;
 

server/phpcs/README.md

@@ -0,0 +1,107 @@
+## About
+
+PHP\_CodeSniffer is a set of two PHP scripts; the main `phpcs` script that tokenizes PHP, JavaScript and CSS files to detect violations of a defined coding standard, and a second `phpcbf` script to automatically correct coding standard violations. PHP\_CodeSniffer is an essential development tool that ensures your code remains clean and consistent.
+
+[![Build Status](https://travis-ci.org/squizlabs/PHP_CodeSniffer.svg?branch=phpcs-fixer)](https://travis-ci.org/squizlabs/PHP_CodeSniffer) [![Code consistency](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer/grade.svg)](http://squizlabs.github.io/PHP_CodeSniffer/analysis/squizlabs/PHP_CodeSniffer) [![Join the chat at https://gitter.im/squizlabs/PHP_CodeSniffer](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/squizlabs/PHP_CodeSniffer?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)
+
+## Requirements
+
+PHP\_CodeSniffer requires PHP version 5.4.0 or greater, although individual sniffs may have additional requirements such as external applications and scripts. See the [Configuration Options manual page](https://github.com/squizlabs/PHP_CodeSniffer/wiki/Configuration-Options) for a list of these requirements.
+
+## Installation
+
+The easiest way to get started with PHP\_CodeSniffer is to download the Phar files for each of the commands:
+```
+# Download using curl
+curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+curl -OL https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
+
+# Or download using wget
+wget https://squizlabs.github.io/PHP_CodeSniffer/phpcs.phar
+wget https://squizlabs.github.io/PHP_CodeSniffer/phpcbf.phar
+
+# Then test the downloaded PHARs
+php phpcs.phar -h
+php phpcbf.phar -h
+```
+
+### Composer
+If you use Composer, you can install PHP_CodeSniffer system-wide with the following command:
+
+    composer global require "squizlabs/php_codesniffer=*"
+
+Make sure you have the composer bin dir in your PATH. The default value is `~/.composer/vendor/bin/`, but you can check the value that you need to use by running `composer global config bin-dir --absolute`.
+
+Or alternatively, include a dependency for `squizlabs/php_codesniffer` in your `composer.json` file. For example:
+
+```json
+{
+    "require-dev": {
+        "squizlabs/php_codesniffer": "3.*"
+    }
+}
+```
+
+You will then be able to run PHP_CodeSniffer from the vendor bin directory:
+
+    ./vendor/bin/phpcs -h
+    ./vendor/bin/phpcbf -h
+
+### Phive
+If you use Phive, you can install PHP_CodeSniffer as a project tool using the following commands:
+
+    phive install phpcs
+    phive install phpcbf
+
+You will then be able to run PHP_CodeSniffer from the tools directory:
+
+    ./tools/phpcs -h
+    ./tools/phpcbf -h
+
+### PEAR
+If you use PEAR, you can install PHP\_CodeSniffer using the PEAR installer. This will make the `phpcs` and `phpcbf` commands immediately available for use. To install PHP\_CodeSniffer using the PEAR installer, first ensure you have [installed PEAR](http://pear.php.net/manual/en/installation.getting.php) and then run the following command:
+
+    pear install PHP_CodeSniffer
+
+### Git Clone
+You can also download the PHP\_CodeSniffer source and run the `phpcs` and `phpcbf` commands directly from the Git clone:
+
+    git clone https://github.com/squizlabs/PHP_CodeSniffer.git
+    cd PHP_CodeSniffer
+    php bin/phpcs -h
+    php bin/phpcbf -h
+
+## Documentation
+
+The documentation for PHP\_CodeSniffer is available on the [Github wiki](https://github.com/squizlabs/PHP_CodeSniffer/wiki).
+
+## Issues
+
+Bug reports and feature requests can be submitted on the [Github Issue Tracker](https://github.com/squizlabs/PHP_CodeSniffer/issues).
+
+## Contributing
+
+See [CONTRIBUTING.md](CONTRIBUTING.md) for information.
+
+## Versioning
+
+PHP_CodeSniffer uses a `MAJOR.MINOR.PATCH` version number format.
+
+The `MAJOR` version is incremented when:
+- backwards-incompatible changes are made to how the `phpcs` or `phpcbf` commands are used, or
+- backwards-incompatible changes are made to the `ruleset.xml` format, or
+- backwards-incompatible changes are made to the API used by sniff developers, or
+- custom PHP_CodeSniffer token types are removed
+
+The `MINOR` version is incremented when:
+- new backwards-compatible features are added to the `phpcs` and `phpcbf` commands, or
+- backwards-compatible changes are made to the `ruleset.xml` format, or
+- backwards-compatible changes are made to the API used by sniff developers, or
+- new sniffs are added to an included standard
+
+> NOTE: Backwards-compatible changes to the API used by sniff develpers will allow an existing sniff to continue running without producing fatal errors but may not result in the sniff reporting the same errors as it did previously without changes being required.
+
+The `PATCH` version is incremented when:
+- backwards-compatible bug fixes are made
+
+> NOTE: As PHP_CodeSniffer exists to report and fix issues, most bugs are the result of coding standard errors being incorrectly reported or coding standard errors not being reported when they should be. This means that the messages produced by PHP_CodeSniffer, and the fixes it makes, are likely to be different between PATCH versions.

server/phpcs/licence.txt

@@ -0,0 +1,24 @@
+Copyright (c) 2012, Squiz Pty Ltd (ABN 77 084 670 600)
+All rights reserved.
+
+Redistribution and use in source and binary forms, with or without
+modification, are permitted provided that the following conditions are met:
+    * Redistributions of source code must retain the above copyright
+      notice, this list of conditions and the following disclaimer.
+    * Redistributions in binary form must reproduce the above copyright
+      notice, this list of conditions and the following disclaimer in the
+      documentation and/or other materials provided with the distribution.
+    * Neither the name of Squiz Pty Ltd nor the
+      names of its contributors may be used to endorse or promote products
+      derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND
+ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
+WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY
+DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
+(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND
+ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
+(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS
+SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

server/phpcs/phpcbf.phar

@@ -1,35 +1,37 @@
 <?php
 /**
- * PHPCompatibility_AbstractComplexVersionSniff.
+ * \PHPCompatibility\AbstractComplexVersionSniff.
  *
  * @category PHP
  * @package  PHPCompatibility
  * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
  */
 
+namespace PHPCompatibility;
+
 /**
- * PHPCompatibility_AbstractComplexVersionSniff.
+ * \PHPCompatibility\AbstractComplexVersionSniff.
  *
  * @category PHP
  * @package  PHPCompatibility
  * @author   Juliette Reinders Folmer <phpcompatibility_nospam@adviesenzo.nl>
  */
-abstract class PHPCompatibility_AbstractComplexVersionSniff extends PHPCompatibility_Sniff implements PHPCompatibility_ComplexVersionInterface
+abstract class AbstractComplexVersionSniff extends Sniff implements ComplexVersionInterface
 {
 
 
     /**
      * Handle the retrieval of relevant information and - if necessary - throwing of an
      * error/warning for an item.
      *
-     * @param PHP_CodeSniffer_File $phpcsFile The file being scanned.
-     * @param int                  $stackPtr  The position of the relevant token in
-     *                                        the stack.
-     * @param array                $itemInfo  Base information about the item.
+     * @param \PHP_CodeSniffer_File $phpcsFile The file being scanned.
+     * @param int                   $stackPtr  The position of the relevant token in
+     *                                         the stack.
+     * @param array                 $itemInfo  Base information about the item.
      *
      * @return void
      */
-    public function handleFeature(PHP_CodeSniffer_File $phpcsFile, $stackPtr, array $itemInfo)
+    public function handleFeature(\PHP_CodeSniffer_File $phpcsFile, $stackPtr, array $itemInfo)
     {
         $itemArray = $this->getItemArray($itemInfo);
         $errorInfo = $this->getErrorInfo($itemArray, $itemInfo);
@@ -101,8 +103,8 @@ abstract protected function getErrorMsgTemplate();
      * Allow for concrete child classes to filter the error message before it's passed to PHPCS.
      *
      * @param string $error     The error message which was created.
-     * @param array  $itemInfo  Base information about the item this error message applied to.
-     * @param array  $errorInfo Detail information about an item this error message applied to.
+     * @param array  $itemInfo  Base information about the item this error message applies to.
+     * @param array  $errorInfo Detail information about an item this error message applies to.
      *
      * @return string
      */
@@ -116,8 +118,8 @@ protected function filterErrorMsg($error, array $itemInfo, array $errorInfo)
      * Allow for concrete child classes to filter the error data before it's passed to PHPCS.
      *
      * @param array $data      The error data array which was created.
-     * @param array $itemInfo  Base information about the item this error message applied to.
-     * @param array $errorInfo Detail information about an item this error message applied to.
+     * @param array $itemInfo  Base information about the item this error message applies to.
+     * @param array $errorInfo Detail information about an item this error message applies to.
      *
      * @return array
      */