PHPackages qafoo/quality-analyzer - 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. qafoo/quality-analyzer ActiveLibrary qafoo/quality-analyzer ====================== Helper for code reviews 49315.8k30[10 issues](https://github.com/Qafoo/QualityAnalyzer/issues)[1 PRs](https://github.com/Qafoo/QualityAnalyzer/pulls)JavaScript Since Dec 3Pushed 6y ago23 watchersCompare [ Source](https://github.com/Qafoo/QualityAnalyzer)[ Packagist](https://packagist.org/packages/qafoo/quality-analyzer)[ RSS](/packages/qafoo-quality-analyzer/feed)WikiDiscussions master Synced 1mo ago READMEChangelogDependenciesVersions (137)Used By (0) Qafoo Quality Analyzer ====================== [](#qafoo-quality-analyzer) [![Travis Status](https://camo.githubusercontent.com/3bac186deb0febab94efc0522c7533325bad535f44cdc24651af7bd0bb4d5802/68747470733a2f2f6170692e7472617669732d63692e6f72672f5161666f6f2f5175616c697479416e616c797a65722e7376673f6272616e63683d6d6173746572)](https://travis-ci.org/Qafoo/QualityAnalyzer)This software is a tool to visualize metrics and source code. We use this software for Code Reviews together with our customers. [![Screeenshot](src/images/screen.png)](src/images/screen.png)Running the analyzers requires the respective PHP tools, which are installed using composer and can all be run using a convenience command. You may also run the tools in your common build process, though. To display the metrics a pure JavaScript / CSS stack is used so you could build and serve the results inside continuous integration tools like Jenkins. This might seem strange but it works really well even with software spanning 800,000 lines of PHP code. If you want to improve, enhance the software or just fix some annoying bugs, you are very welcome to do so. The technology stack involved sadly is not that simple, though (PHP, Symfony2, Ant, Babel, D3, Grunt, Jasmine, Karma, SASS, PhantomJs, React, React-Router, Underscore, Webpack). A [Code of Conduct](http://hood.ie/code-of-conduct/)applies for any interaction with this project – if you feel like it is violated get in contact with Kore. Setup ----- [](#setup) To use the software there are very few steps involved. The only requirement is a current version of PHP. Run the following commands to install the software: ``` git clone https://github.com/Qafoo/QualityAnalyzer.git cd QualityAnalyzer composer install ``` In the next step you can already analyze some software using something like this: ``` bin/analyze analyze src/php/ ``` See "Usage" for more details on the command. The results of this command can be found in the `data/` folder. Finally you can start the webserver to view the results: ``` bin/analyze serve ``` Click around and enjoy the data! Usage ----- [](#usage) You start by analyzing a certain project or providing the tool with the paths to existing analyze files, like code coverage reports: ``` bin/analyze analyze /path/to/source ``` With the default command the tool will analyze the source code itself. For tools like PHPMD or PDepend this makes a lot of sense since the tool already knows which options to use for each tool. There are some reports we cannot generate ourselves like code coverage from your tests. You can tell the tool where to find certain files to make sure they are available and ready to be used: ``` bin/analyze \ --coverage=/path/to/clover.xml \ --tests=/path/to/junit.xml \ analyze /path/to/source ``` You can also specify already generated files for all the other tools. But the visualization might behave strangely if some reports are generated in the wrong formats or some options are missing. We do not verify this (yet) properly. To view the report in HTML format, run bin/analyze bundle /path/for/generated/html and then open /path/for/generated/html/index.html with your browser. ### Ignore Sub-Directories [](#ignore-sub-directories) You might also want to tell the tools which directories there are to ignore by the tools. This is *especially important* if you have (large) libraries in your source directory – you do not want to analyze those. For this you may use the `--exclude` option: ``` bin/analyze \ --coverage=/path/to/clover.xml \ --tests=/path/to/junit.xml \ --exclude=libraries,vendor \ analyze /path/to/source ``` After the analyzer has finished use `bin/analyze serve` or similar means to access the `index.html` with your browser and enjoy the results visualization. ### Exclude Analyzers [](#exclude-analyzers) You might also to avoid some analyzers to be run on your code intentionally, e.g. if you don't want your git usage be analysed. For this you may use the `--exclude_analyzers` option: ``` bin/analyze \ --exclude_analyzers=git,gitDetailed \ analyze /path/to/source ``` To get a list of all available analyzers, run: ``` bin/analyze list:analyzers ``` ### Customize Tools [](#customize-tools) If you want to customize tool execution you can always run all the tools yourself and pass the existing result files to the `analyze` command. An example customizable ant build file doing this can be found here: [src/examples/customize.xml](src/examples/customize.xml) or [src/examples/parallel.xml](src/examples/parallel.xml). The parameters to pass you custom results, which wil omit running the tool by the analyzer command itself are: ``` --pdepend=PDEPEND Path to PDepend summary XML file --dependencies=DEPENDENCIES Path to PDepend dependencies XML file --phpmd=PHPMD Path to mess detector (PMD / PHPMD) XML file --checkstyle=CHECKSTYLE Path to checkstyle violations (PHP Code Sniffer) XML file --cpd=CPD Path to C&P violations (PHP Copy Paste Detector) XML file --phploc=PHPLOC Path to PHPLoc result XML file ``` Feel free to provide examples using different build environments by creating a pull request. Building & Developing The Software -------------------------------------- [](#building--developing-the-software) The build system of the Quality Analyzer is based on ant. You must have **ant >= 1.8** installed. To be able to use it you should first initilaize the submodule containing the build commons: ``` git submodule update --init ``` To develop the Quality Analyzer we heavily depend on a JavaScript build stack. For this you must have node and npm installed. All other required tools will be installed by the build tool. To set the project into development mode run: ``` echo env=dev > environment.local ``` As long as you do not remove this line from the `environment.local` file any more or change it to `prod` all development tools and libraries will be installed and used. This also means JavaScript and CSS will be compiled by commands like `ant serve`. ### Running The Tests [](#running-the-tests) You can run the tests by executing `ant`. It will run run tests through Karma & Jasmine for parts of the JavaScript stack and PHPUnit tests for the PHP stack (once we have some). ### Building CSS & JavaScript [](#building-css--javascript) The project uses ECMAScript 6 and transpiles it using Babel. Thus we need to update the bundle.js when working on the client. This is done when the project is prepared but can also be executed continuously using: ``` ant watch ``` This also compiles the SASS from the project and Bootstrap file into a single CSS file. ### Trying Out The Project [](#trying-out-the-project) If you want to try out the project you can serve the root directory with basically any webserver. The webserver should rewrite all requests to unknown resources to the index.html file which does the routing using JavaScript. For your convenience we included a working server setup using PHPs internal webserver. You can start it using: ``` ant serve ``` ### Generating The Bundle Files [](#generating-the-bundle-files) The following task ensures the bundle files are generated, compressed and comitted: ``` ant deploy ``` **Use this command to update the distributed files.** It will run the `package` task first (after running all tests, of course). If there are changes in the `assets/` folder those changes will be comitted and the current development state will then be pushed. ### Health Score 40 — FairBetter than 88% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity42 Moderate usage in the ecosystem Community26 Small or concentrated contributor base Maturity61 Established project with proven stability Bus Factor1 Top contributor holds 89.1% 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/5b4beabbad777c5b6522018525666cc9ce96d3abcd9e702fccacde178951737c?d=identicon)[kore](/maintainers/kore) ![](https://www.gravatar.com/avatar/f318e1926ddf8a68ba7654777cef8c5e164c5ac22c176f9685cc34715b7d4ec0?d=identicon)[tobyS](/maintainers/tobyS) --- Top Contributors [![kore](https://avatars.githubusercontent.com/u/154398?v=4)](https://github.com/kore "kore (386 commits)")[![Basster](https://avatars.githubusercontent.com/u/1265783?v=4)](https://github.com/Basster "Basster (15 commits)")[![greenkeeperio-bot](https://avatars.githubusercontent.com/u/14790466?v=4)](https://github.com/greenkeeperio-bot "greenkeeperio-bot (15 commits)")[![JeroenDeDauw](https://avatars.githubusercontent.com/u/146040?v=4)](https://github.com/JeroenDeDauw "JeroenDeDauw (8 commits)")[![tobyS](https://avatars.githubusercontent.com/u/187140?v=4)](https://github.com/tobyS "tobyS (3 commits)")[![fruitl00p](https://avatars.githubusercontent.com/u/1492861?v=4)](https://github.com/fruitl00p "fruitl00p (2 commits)")[![veelen](https://avatars.githubusercontent.com/u/1203945?v=4)](https://github.com/veelen "veelen (1 commits)")[![darxriggs](https://avatars.githubusercontent.com/u/16874?v=4)](https://github.com/darxriggs "darxriggs (1 commits)")[![Mte90](https://avatars.githubusercontent.com/u/403283?v=4)](https://github.com/Mte90 "Mte90 (1 commits)")[![angyvolin](https://avatars.githubusercontent.com/u/4446315?v=4)](https://github.com/angyvolin "angyvolin (1 commits)") ### Embed Badge ![Health badge](/badges/qafoo-quality-analyzer/health.svg) ``` [![Health](https://phpackages.com/badges/qafoo-quality-analyzer/health.svg)](https://phpackages.com/packages/qafoo-quality-analyzer) ``` PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)