Download the PHP package silverstripe/moduleratings-plugin without Composer
On this page you can find all versions of the php package silverstripe/moduleratings-plugin. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.
Download silverstripe/moduleratings-plugin
More information about silverstripe/moduleratings-plugin
Files in silverstripe/moduleratings-plugin
Package moduleratings-plugin
Short Description A Composer plugin to provide ability to rate your local modules
License BSD-3-Clause
Informations about the package moduleratings-plugin
SilverStripe module ratings plugin
This package provides a Composer plugin which enables the functionality for the SilverStripe module ratings package to be used via Composer on the command line.
Installation
Install with Composer:
Usage
Once installed, you will see a new rate-module
command. As with other Composer (and Symfony console) commands, you
can add --help
to the command to see information about what it does and how to use and manipulate it:
As noted above, the path to the module's code is required (e.g. vendor/silverstripe/cms
from your project root).
The --slug
argument will allow the check suite to run external API based checks, e.g. code coverage and Travis builds.
This is an optional addition, but you won't be able to achieve a 100% score without providing it.
Example
To run a rating check on the spam protection module, you could run the following command:
In the above example you will see the results of each of the checks, with the Points that were awarded for meeting the check's criteria, and the maximum potential points that could be attained from the check if it were successful.
The total score is awarded as a percentage, e.g. 97% in this example. Note that the result is normalised, so 97/100 rather than 64/66 (if you'd added each check result up).
Further info on the checks
For more information on the check suite itself, please see the module ratings package.