PHPackages m50/simple - 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. m50/simple ActiveLibrary[Utility & Helpers](/categories/utility) m50/simple ========== The documentation verification tool to make sure that nothing is considered easy or simple. 3.0.0(5y ago)117[2 PRs](https://github.com/m50/simple/pulls)MITPHPPHP ^8.0 Since Feb 9Pushed 3y ago1 watchersCompare [ Source](https://github.com/m50/simple)[ Packagist](https://packagist.org/packages/m50/simple)[ Docs](https://github.com/m50/simple)[ RSS](/packages/m50-simple/feed)WikiDiscussions trunk Synced 3w ago READMEChangelog (6)Dependencies (7)Versions (9)Used By (0) (Not so) Simple =============== [](#not-so-simple) [![psalm type coverage](https://camo.githubusercontent.com/d3a554d1caf76b3c27cf9a64e435b32a0d8439fcd551f6f0764089ee1c707518/68747470733a2f2f73686570686572642e6465762f6769746875622f6d35302f73696d706c652f636f7665726167652e737667)](https://camo.githubusercontent.com/d3a554d1caf76b3c27cf9a64e435b32a0d8439fcd551f6f0764089ee1c707518/68747470733a2f2f73686570686572642e6465762f6769746875622f6d35302f73696d706c652f636f7665726167652e737667)[![Code Validation](https://github.com/m50/simple/workflows/Code%20Validation/badge.svg)](https://github.com/m50/simple/workflows/Code%20Validation/badge.svg)[![styleci status](https://camo.githubusercontent.com/aaa5d4e2d29a478e62b69a2799e95d01fd5ebfcb01f8849cb85f4fc8352f5f4e/68747470733a2f2f6769746875622e7374796c6563692e696f2f7265706f732f3233383032323833312f736869656c64)](https://github.styleci.io/repos/238022831)[![Coverage Status](https://camo.githubusercontent.com/5d563ccba7b4e3f7a78f81e043fdc37e0fb50f4ce85c91a011caf0581a1b212a/68747470733a2f2f636f766572616c6c732e696f2f7265706f732f6769746875622f6d35302f73696d706c652f62616467652e7376673f6272616e63683d7472756e6b)](https://coveralls.io/github/m50/simple?branch=trunk) [![Latest Stable Version](https://camo.githubusercontent.com/180340a211ed0ba33d9b06cda27f3142b516e5b46d48649ae772ace857ec17c1/68747470733a2f2f706f7365722e707567782e6f72672f6d35302f73696d706c652f762f737461626c65)](https://packagist.org/packages/m50/simple)[![Total Downloads](https://camo.githubusercontent.com/ad86e20301d88e32cd0ae119f5b58b000b6919695e8455ddeaa5fcb02f86d57a/68747470733a2f2f706f7365722e707567782e6f72672f6d35302f73696d706c652f646f776e6c6f616473)](https://packagist.org/packages/m50/simple)[![License](https://camo.githubusercontent.com/f0b5bc426200daab93ffddfb3d3dea1e474130f80e647a3e016509e0763b328c/68747470733a2f2f706f7365722e707567782e6f72672f6d35302f73696d706c652f6c6963656e7365)](https://packagist.org/packages/m50/simple) The documentation verification tool to make sure that nothing is considered easy or simple. Run *Simple* in your CI process on your documentation to make sure you don't put out any documentation that is condescending or unhelpful to learners. Everywhere that *Simple* finds any of the problematic words, it may be a perfect case to provide more detailed documentation. It's like a unit test for your documentation. Usage ----- [](#usage) To use simple, run it from the command line providing the directory the documentation files reside in. Example: To generate the default configuration file, run init: ``` simple init ``` Then you can just run it: ``` simple ``` [![example image](imgs/example.png)](imgs/example.png) or specify a specific directory: ``` simple -f./docs/ ``` To get a full list of options and flags, run the help command: ``` simple help ``` ### In CI [](#in-ci) In CI, it is recommended to run it like so: ``` simple --no-color --no-progress-bar --report-file=report.junit.xml ``` This will force a junit report to be generated, for use in your CI reporting system. Installation ------------ [](#installation) Simple can either be installed as an executable PHAR, or as a composer dependency. Alternatively, it can be used with docker for CI builds or locally. ### Docker: [](#docker) The [docker image](https://hub.docker.com/r/marisa50/simple) is: `marisa50/simple`. To run simple on your docs: ``` docker run --rm --interactive --tty -v "$(pwd):/app" -w="/app" ghcr.io/m50/simple:latest ``` ### Phar: [](#phar) ``` wget -O simple.phar $(curl -s https://api.github.com/repos/m50/simple/releases/latest | jq -aM .assets[0].browser_download_url | tr -d '"') chmod 755 simple.phar mv simple.phar /usr/local/bin/simple ``` ### Composer [](#composer) ``` composer global require m50/simple ``` ### Health Score 29 — LowBetter than 57% of packages Maintenance20 Infrequent updates — may be unmaintained Popularity11 Limited adoption so far Community7 Small or concentrated contributor base Maturity67 Established project with proven stability Bus Factor1 Top contributor holds 100% 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 ~68 days Recently: every ~86 days Total 6 Last Release 1992d ago Major Versions 1.0.2 → 2.0.02021-01-16 2.0.1 → 3.0.02021-01-18 PHP version history (2 changes)1.0.0PHP ^7.4 3.0.0PHP ^8.0 ### Community Maintainers ![](https://avatars.githubusercontent.com/u/3577147?v=4)[Marisa](/maintainers/m50)[@m50](https://github.com/m50) --- Top Contributors [![m50](https://avatars.githubusercontent.com/u/3577147?v=4)](https://github.com/m50 "m50 (131 commits)") --- Tags cicicddocumentationsimpleverificationdocumentationSimpleverificationcdcicd ### Code Quality TestsPHPUnit Static AnalysisPsalm Type Coverage Yes ### Embed Badge ![Health badge](/badges/m50-simple/health.svg) ``` [![Health](https://phpackages.com/badges/m50-simple/health.svg)](https://phpackages.com/packages/m50-simple) ``` ### Alternatives [friendsoftypo3/content-blocks TYPO3 CMS Content Blocks - Content Types API | Define reusable components via YAML 103519.9k53](/packages/friendsoftypo3-content-blocks)[drupal/core Drupal is an open source content management platform powering millions of websites and applications. 21866.0M1.7k](/packages/drupal-core)[drupal/core-recommended Locked core dependencies; require this project INSTEAD OF drupal/core. 6942.5M421](/packages/drupal-core-recommended)[shopware/core Shopware platform is the core for all Shopware ecommerce products. 585.6M574](/packages/shopware-core)[jolicode/castor A lightweight and modern task runner. Automate everything. In PHP. 54743.1k4](/packages/jolicode-castor)[blackfire/player A powerful web crawler and web scraper with Blackfire support 49617.1k](/packages/blackfire-player) PHPackages © 2026 [Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)