PHPackages                             rikkeisoft/sonar-rules - 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. rikkeisoft/sonar-rules

AbandonedApplication[Utility & Helpers](/categories/utility)

rikkeisoft/sonar-rules
======================

Make documents about Sonar rules

242[13 issues](https://github.com/rikkeisoft/sonar-rules/issues)[11 PRs](https://github.com/rikkeisoft/sonar-rules/pulls)PHP

Since Dec 21Pushed 3y ago3 watchersCompare

[ Source](https://github.com/rikkeisoft/sonar-rules)[ Packagist](https://packagist.org/packages/rikkeisoft/sonar-rules)[ RSS](/packages/rikkeisoft-sonar-rules/feed)WikiDiscussions master Synced 2d ago

READMEChangelogDependenciesVersions (4)Used By (0)

rikkeisoft/sonar-rules
======================

[](#rikkeisoftsonar-rules)

[![Build Status](https://camo.githubusercontent.com/08f6b463d56fec6bbe658ef0e99a14a9b74e871676ea2a5d96b95702f57a4250/68747470733a2f2f7472617669732d63692e6f72672f72696b6b6569736f66742f736f6e61722d72756c65732e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/rikkeisoft/sonar-rules)[![Coverage Status](https://camo.githubusercontent.com/384f7f5d4d34a9c89078bf6485b039e5d3466053aa14f8e4613d4fd6aee25009/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f72696b6b6569736f66742f736f6e61722d72756c65732f62616467652e7376673f6272616e63683d6d6173746572)](https://coveralls.io/github/rikkeisoft/sonar-rules?branch=master)[![Code Climate](https://camo.githubusercontent.com/ff6db50f7bb47c1918505a16e8ee0f6c857aae0e73e5a60561c39b00d598a6cf/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f72696b6b6569736f66742f736f6e61722d72756c65732f6261646765732f6770612e737667)](https://codeclimate.com/github/rikkeisoft/sonar-rules)[![Issue Count](https://camo.githubusercontent.com/1305a530c97e000f41409358332171f63e3e72b41c3571aff4a60ea32d084ead/68747470733a2f2f636f6465636c696d6174652e636f6d2f6769746875622f72696b6b6569736f66742f736f6e61722d72756c65732f6261646765732f69737375655f636f756e742e737667)](https://codeclimate.com/github/rikkeisoft/sonar-rules)

Make documents about Sonar rules

Requirements
------------

[](#requirements)

- php >= 7.0

Installation
------------

[](#installation)

```
$ git clone https://github.com/rikkeisoft/sonar-rules
$ composer install
```

Usage
-----

[](#usage)

- You could specify your Sonar's credential in CLI arguments:

```
$ php bin/sonardoc rules:list -u
# Example
$ php bin/sonardoc rules:list -u huynq js
```

- Or you can set your Sonar's username and password in `.env`:

```
$ cp .env{.example,}
# Edit the value of .env to yours
$ php bin/sonardoc rules:list
# Example
$ php bin/sonardoc rules:list js
```

Build assets
------------

[](#build-assets)

- **Note**: [Yarn](https://yarnpkg.com/en/docs/install) have to be installed.

```
$ yarn install
$ yarn run prod
```

Changelog
---------

[](#changelog)

See all change logs in [CHANGELOG.md](https://github.com/rikkeisoft/sonar-rules/blob/master/CHANGELOG.md)

Contributing
------------

[](#contributing)

All code contributions must go through a pull request and approved by a core developer before being merged. This is to ensure proper review of all the code.

Fork the project, create a feature branch, and send a pull request.

To ensure a consistent code base, you should make sure the code follows the [PSR-2](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md).

If you would like to help take a look at the [list of issues](https://github.com/rikkeisoft/sonar-rules/issues).

License
-------

[](#license)

This project is released under the MIT License.
Copyright © 2017 Rikkeisoft Co. Ltd.,

###  Health Score

18

—

LowBetter than 8% of packages

Maintenance0

Infrequent updates — may be unmaintained

Popularity8

Limited adoption so far

Community12

Small or concentrated contributor base

Maturity45

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 55.6% 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.

### Community

Maintainers

![](https://www.gravatar.com/avatar/b32dfbbbf603d0317f2ab7ab33c7c7611e90f6701c5c84f07a8b537aa84e83f7?d=identicon)[oanhnn](/maintainers/oanhnn)

---

Top Contributors

[![oanhnn](https://avatars.githubusercontent.com/u/1757120?v=4)](https://github.com/oanhnn "oanhnn (15 commits)")[![hnq90](https://avatars.githubusercontent.com/u/1875666?v=4)](https://github.com/hnq90 "hnq90 (12 commits)")

---

Tags

documentation-generatorpsrrikkeisoftsonar-rulessonarqubetools

### Embed Badge

![Health badge](/badges/rikkeisoft-sonar-rules/health.svg)

```
[![Health](https://phpackages.com/badges/rikkeisoft-sonar-rules/health.svg)](https://phpackages.com/packages/rikkeisoft-sonar-rules)
```

###  Alternatives

[hirethunk/verbs

An event sourcing package that feels nice.

513162.9k6](/packages/hirethunk-verbs)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)