Download the PHP package jrfnl/qawpprojects without Composer

On this page you can find all versions of the php package jrfnl/qawpprojects. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package qawpprojects

Using PHP Codesniffer for QA reviews of WordPress projects

Build Status

Introduction

This project primarily was created as an example / proof of concept for talks about how to use a variety of PHPCS rules and standards to get an indication of code quality for WordPress plugins and themes.

As a secondary use-case, this project can be used to install all relevant WordPress related PHP_CodeSniffer rulesets in one go.

Note: This repository will not be actively maintained.

Talks

Presentations which feature this repo:

Date Event Slides Video
Dec 2019 WP Leiden meetup Slides
Mar 2018 WordCamp Rotterdam Slides Video
Nov 2017 WordCamp Utrecht Slides Video
Sep 2017 WP Fryslân meetup Slides

Installation

Requirements

Installation for a specific project

About project based installation:

Using this method, the tooling will only be available to that specific project.

Pros: Using a project based install, you document what tooling the project uses and make it easy for other contributors to the project to install that tooling.

Cons: For each additional project, you will need to do the installation again.

From the project root, run the following command:

The PHP_CodeSniffer command will now be available from the project root as vendor/bin/phpcs.

To update the install in the future, run the following command from the project root:

Global installation

About global installation:

Using this method, the tooling will be available from anywhere on your system.

Pros: You only need to install it once.

Cons: If you use the tooling for your projects and the projects are open to other contributors, it will be unclear what tooling you expect them to use.

Run the following command from anywhere on your system:

Make sure the Composer "home" vendor/bin directory is in your system path. To find out what the Composer "home" directory is, run composer config --list --global and see what's listed under home. Take that directory, add /vendor/bin to it and make sure it's in your operating system's $PATH variable.

The PHP_CodeSniffer command will now be available from anywhere on your computer as phpcs.

To update the install in the future, run the following command from anywhere on your system:

Verify the install succeeded

Once the installation is finished, run the following command to verify the installation was succesfull:

The output should look like this:

Using the installed rulesets

After installation, you can use any of the above listed PHPCS rulesets, or a combination of them, for your projects.

For plugins and themes, using either WordPress or WordPress-Extra is recommended.

It is strongly recommended to document the settings you use in a custom ruleset and to add some minimal sniff configuration for optimal results.

An example ruleset which you can place in the root of your project, including documentation on what you should adjust, can be found in the sample-project-ruleset directory.

Reviewing WordPress plugins and themes

This repository comes with two native rulesets - WP-QA-Basic and WP-QA-Strict - which are specifically intended for reviewing WordPress plugins and themes without much knowledge of code.

These rulesets do not look at the code style consistency of code. They will only evaluate whether code is well documented, tested and whether there are any code quality issues detected.

When you run either of these rulesets over a project, a customized report will be displayed to give you a fingerspitzengefuhl of the code quality of a project.

Before running the tool

To use this tool to review WordPress plugins and themes, the tool needs a little bit of information about the plugin/theme you want to review.

How to run ?

Run the tool from the project root like so (command based on global install):

:warning: Do replace the various values in the command with the values you looked up in the previous step.

The output will look something like this:

:bulb: Pro-tip

Use a custom ruleset instead of this long command. See the sample-project-ruleset for a starting point and replace <rule ref="WordPress"/> in the Set the rules section with the WP-QA ruleset you want to use.

Once you have a custom ruleset set up, the command simply becomes:

How to interpret the results ?

If the resulting report is a mystery to you, I'd recommend watching the video from the talk at WordCamp Rotterdam to hear how to interpret the results.

License

This code is released under the MIT License.

All versions of qawpprojects with dependencies

PHP Build Version
Package Version
Requires php Version >=5.4
squizlabs/php_codesniffer Version ^3.5.2
wp-coding-standards/wpcs Version ^2.2.0
phpcompatibility/phpcompatibility-wp Version ^2.1.0
dealerdirect/phpcodesniffer-composer-installer Version ^0.6
wptrt/wpthemereview Version ^0.2
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package jrfnl/qawpprojects contains the following files

Loading the files please wait ...