{"id":25842986,"url":"https://github.com/m50/simple","last_synced_at":"2025-03-01T06:35:24.625Z","repository":{"id":37531466,"uuid":"238022831","full_name":"m50/simple","owner":"m50","description":"The documentation verification tool to make sure that nothing is considered easy or simple.","archived":false,"fork":false,"pushed_at":"2023-04-19T20:08:39.000Z","size":289,"stargazers_count":11,"open_issues_count":2,"forks_count":0,"subscribers_count":2,"default_branch":"trunk","last_synced_at":"2025-02-24T07:43:55.669Z","etag":null,"topics":["ci","cicd","documentation","simple","verification"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/m50.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2020-02-03T17:34:43.000Z","updated_at":"2021-01-18T18:09:04.000Z","dependencies_parsed_at":"2022-08-19T06:40:49.863Z","dependency_job_id":null,"html_url":"https://github.com/m50/simple","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m50%2Fsimple","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m50%2Fsimple/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m50%2Fsimple/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/m50%2Fsimple/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/m50","download_url":"https://codeload.github.com/m50/simple/tar.gz/refs/heads/trunk","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241329400,"owners_count":19944982,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["ci","cicd","documentation","simple","verification"],"created_at":"2025-03-01T06:35:21.340Z","updated_at":"2025-03-01T06:35:24.620Z","avatar_url":"https://github.com/m50.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"# (Not so) ~~Simple~~\n![psalm type coverage](https://shepherd.dev/github/m50/simple/coverage.svg)\n![Code Validation](https://github.com/m50/simple/workflows/Code%20Validation/badge.svg)\n[![styleci status](https://github.styleci.io/repos/238022831/shield)](https://github.styleci.io/repos/238022831)\n[![Coverage Status](https://coveralls.io/repos/github/m50/simple/badge.svg?branch=trunk)](https://coveralls.io/github/m50/simple?branch=trunk)\n\n[![Latest Stable Version](https://poser.pugx.org/m50/simple/v/stable)](https://packagist.org/packages/m50/simple)\n[![Total Downloads](https://poser.pugx.org/m50/simple/downloads)](https://packagist.org/packages/m50/simple)\n[![License](https://poser.pugx.org/m50/simple/license)](https://packagist.org/packages/m50/simple)\n\nThe documentation verification tool to make sure that nothing is considered easy or simple.\n\nRun *Simple* in your CI process on your documentation to make sure you don't put\nout any documentation that is condescending or unhelpful to learners. Everywhere\nthat *Simple* finds any of the problematic words, it may be a perfect case to\nprovide more detailed documentation.\n\nIt's like a unit test for your documentation.\n\n## Usage\n\nTo use simple, run it from the command line providing the directory the documentation files reside in. Example:\n\nTo generate the default configuration file, run init:\n\n```sh\nsimple init\n```\n\nThen you can just run it:\n\n```sh\nsimple\n```\n\n![example image](imgs/example.png)\n\nor specify a specific directory:\n\n```sh\nsimple -f./docs/\n```\n\nTo get a full list of options and flags, run the help command:\n\n```sh\nsimple help\n```\n\n### In CI\n\nIn CI, it is recommended to run it like so:\n\n```sh\nsimple --no-color --no-progress-bar --report-file=report.junit.xml\n```\n\nThis will force a junit report to be generated, for use in your CI reporting system.\n\n## Installation\n\nSimple can either be installed as an executable PHAR, or as a composer dependency.\n\nAlternatively, it can be used with docker for CI builds or locally.\n\n### Docker:\n\nThe [docker image](https://hub.docker.com/r/marisa50/simple) is: `marisa50/simple`.\n\nTo run simple on your docs:\n\n```sh\ndocker run --rm --interactive --tty -v \"$(pwd):/app\" -w=\"/app\" ghcr.io/m50/simple:latest\n```\n\n### Phar:\n\n```sh\nwget -O simple.phar $(curl -s https://api.github.com/repos/m50/simple/releases/latest | jq -aM .assets[0].browser_download_url | tr -d '\"')\nchmod 755 simple.phar\nmv simple.phar /usr/local/bin/simple\n```\n\n### Composer\n\n```sh\ncomposer global require m50/simple\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm50%2Fsimple","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fm50%2Fsimple","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fm50%2Fsimple/lists"}