PHPackages silverstripe/moduleratings-plugin - PHPackages - PHPackages [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register) 1. [Directory](/) 2. / 3. [Utility & Helpers](/categories/utility) 4. / 5. silverstripe/moduleratings-plugin ActiveComposer-plugin[Utility & Helpers](/categories/utility) silverstripe/moduleratings-plugin ================================= A Composer plugin to provide ability to rate your local modules 0.2.0(5y ago)13871BSD-3-ClausePHPCI failing Since Jan 8Pushed 5y ago5 watchersCompare [ Source](https://github.com/silverstripe/moduleratings-plugin)[ Packagist](https://packagist.org/packages/silverstripe/moduleratings-plugin)[ RSS](/packages/silverstripe-moduleratings-plugin/feed)WikiDiscussions master Synced 2d ago READMEChangelogDependencies (4)Versions (4)Used By (0) SilverStripe module ratings plugin ================================== [](#silverstripe-module-ratings-plugin) [![Scrutinizer Code Quality](https://camo.githubusercontent.com/71f2b9f02a9a17538294d6c9cdcc424bd56613e9e603279554ca5ced6b5fe929/68747470733a2f2f7363727574696e697a65722d63692e636f6d2f672f73696c7665727374726970652f6d6f64756c65726174696e67732d706c7567696e2f6261646765732f7175616c6974792d73636f72652e706e673f623d6d6173746572)](https://scrutinizer-ci.com/g/silverstripe/moduleratings-plugin/?branch=master) This package provides a [Composer plugin](https://github.com/silverstripe/silverstripe-contentreview/issues/74) which enables the functionality for the SilverStripe module ratings package to be used via Composer on the command line. Installation ------------ [](#installation) Install with Composer: ``` composer require silverstripe/moduleratings-plugin ``` Usage ----- [](#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: ``` $ composer rate-module --help Usage: rate-module [options] [--] Arguments: module-path The path to the module folder, relative to the current working directory Options: --slug[=SLUG] The module's GitHub repository slug, e.g. silverstripe/silverstripe-blog - used for API checks -h, --help Display this help message -q, --quiet Do not output any message -V, --version Display this application version --ansi Force ANSI output --no-ansi Disable ANSI output -n, --no-interaction Do not ask any interactive question --profile Display timing and memory usage information --no-plugins Whether to disable plugins. -d, --working-dir=WORKING-DIR If specified, use the given directory as working directory. -v|vv|vvv, --verbose Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug Help: This command will assess the provided module based on a selection of pre-defined quality checks, and provide a rating out of 100. You must provide the module-path to map the path from the current working directory to the source code of the module, and you may optionally provide the slug argument which will enable API based status checks. Note that without providing slug the module will never be able to achieve a 100% score. ``` 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 ------- [](#example) To run a rating check on the [spam protection module](https://github.com/silverstripe/silverstripe-spamprotection), you could run the following command: ``` $ composer rate-module vendor/silverstripe/spamprotection/ --slug=silverstripe/silverstripe-spamprotection +---------------------------------------------------------------------------------------+--------+---------+ | Check description | Points | Maximum | +---------------------------------------------------------------------------------------+--------+---------+ | Has a "good" level of code coverage (greater than 40%, requires slug) | 5 | 5 | | Has a "great" level of code coverage (greater than 60%, requires slug) | 5 | 5 | | Has a code of conduct file | 2 | 2 | | Has source code in either a "code" or a "src" folder | 5 | 5 | | The PHP code in this module passes the SilverStripe lint rules (mostly PSR-2) | 10 | 10 | | Has a contributing guide file | 0 | 2 | | Has a .editorconfig file | 5 | 5 | | Has a .gitattributes file | 2 | 2 | | Has a license file | 5 | 5 | | Has a readme file | 5 | 5 | | Has Scrutinizer CI configured and a "good" score (greater than 6.5/10, requires slug) | 10 | 10 | | Has Travis CI configured and the last build passed successfully (requires slug) | 10 | 10 | +---------------------------------------------------------------------------------------+--------+---------+ | TOTAL SCORE (normalised) | 97 | 100 | +---------------------------------------------------------------------------------------+--------+---------+ ``` In the above example you will see the results of each of [the checks](https://github.com/silverstripe/moduleratings#available-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 -------------------------- [](#further-info-on-the-checks) For more information on the check suite itself, please see the [module ratings package](https://github.com/silverstripe/moduleratings). ### Health Score 29 — LowBetter than 60% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity17 Limited adoption so far Community16 Small or concentrated contributor base Maturity55 Maturing project, gaining track record Bus Factor1 Top contributor holds 75% of commits — single point of failure How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window. **Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores. **Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement. **Maturity (30%)** — Project age, version count, PHP version support, and release stability. ### Release Activity Cadence Every ~522 days Total 3 Last Release 2003d ago ### Community Maintainers ![](https://www.gravatar.com/avatar/b0cba8b534e20e6ab4fff555a97b237a18436ebca1446fc0b29c8a8b504038b9?d=identicon)[GuySartorelli](/maintainers/GuySartorelli) ![](https://avatars.githubusercontent.com/u/111025?v=4)[Ingo Schommer](/maintainers/chillu)[@chillu](https://github.com/chillu) ![](https://www.gravatar.com/avatar/a25bc04c5720a36869d5a39c6449dde7eb43e19b7c8e666d5f632d6a9ab440b1?d=identicon)[emteknetnz](/maintainers/emteknetnz) ![](https://www.gravatar.com/avatar/afbb3dcc9ef29c1a6eedd6addcae5fce9ab1271915a85a4c349301b71237368d?d=identicon)[silverstripe-machine01](/maintainers/silverstripe-machine01) ![](https://www.gravatar.com/avatar/be6648e60fbab6f70bfc34dd8c14259562d28a47510a934ea9c01fe98633f3c2?d=identicon)[sminnee](/maintainers/sminnee) ![](https://avatars.githubusercontent.com/u/1168676?v=4)[Maxime Rainville](/maintainers/maxime-rainville)[@maxime-rainville](https://github.com/maxime-rainville) --- Top Contributors [![robbieaverill](https://avatars.githubusercontent.com/u/5170590?v=4)](https://github.com/robbieaverill "robbieaverill (9 commits)")[![chillu](https://avatars.githubusercontent.com/u/111025?v=4)](https://github.com/chillu "chillu (3 commits)") ### Code Quality TestsPHPUnit ### Embed Badge ![Health badge](/badges/silverstripe-moduleratings-plugin/health.svg) ``` [![Health](https://phpackages.com/badges/silverstripe-moduleratings-plugin/health.svg)](https://phpackages.com/packages/silverstripe-moduleratings-plugin) ``` ### Alternatives [vaimo/composer-patches Applies a patch from a local or remote file to any package that is part of a given composer project. Patches can be defined both on project and on package level. Optional support for patch versioning, sequencing, custom patch applier configuration and patch command for testing/troubleshooting added patches. 2994.3M16](/packages/vaimo-composer-patches)[mglaman/composer-drupal-lenient 1317.4M15](/packages/mglaman-composer-drupal-lenient)[drupal/core-composer-scaffold A flexible Composer project scaffold builder. 5341.9M446](/packages/drupal-core-composer-scaffold)[drupal/core-project-message Adds a message after Composer installation. 2122.6M172](/packages/drupal-core-project-message)[olvlvl/composer-attribute-collector A convenient and near zero-cost way to retrieve targets of PHP 8 attributes 184108.8k8](/packages/olvlvl-composer-attribute-collector)[lullabot/drainpipe An automated build tool to allow projects to have a set standardized operations scripts. 41716.4k2](/packages/lullabot-drainpipe) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)