{"id":15525430,"url":"https://github.com/robertbasic/bugreport","last_synced_at":"2025-02-22T19:41:11.901Z","repository":{"id":62536467,"uuid":"91687623","full_name":"robertbasic/bugreport","owner":"robertbasic","description":"Get a bug report on a project's dependencies.","archived":false,"fork":false,"pushed_at":"2017-06-01T09:26:33.000Z","size":186,"stargazers_count":1,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-02-18T10:12:59.411Z","etag":null,"topics":[],"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/robertbasic.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE.md","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2017-05-18T11:54:56.000Z","updated_at":"2017-05-22T04:54:49.000Z","dependencies_parsed_at":"2022-11-02T15:15:25.202Z","dependency_job_id":null,"html_url":"https://github.com/robertbasic/bugreport","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertbasic%2Fbugreport","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertbasic%2Fbugreport/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertbasic%2Fbugreport/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/robertbasic%2Fbugreport/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/robertbasic","download_url":"https://codeload.github.com/robertbasic/bugreport/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240229882,"owners_count":19768584,"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":[],"created_at":"2024-10-02T10:57:31.055Z","updated_at":"2025-02-22T19:41:11.867Z","avatar_url":"https://github.com/robertbasic.png","language":"PHP","readme":"# bugreport\n\n[![Build Status](https://travis-ci.org/robertbasic/bugreport.png?branch=master)](https://travis-ci.org/robertbasic/bugreport)\n[![Coverage Status](https://coveralls.io/repos/github/robertbasic/bugreport/badge.svg?branch=master)](https://coveralls.io/github/robertbasic/bugreport?branch=master)\n[![Latest Stable Version](https://poser.pugx.org/robertbasic/bugreport/v/stable)](https://packagist.org/packages/robertbasic/bugreport)\n[![License](https://poser.pugx.org/robertbasic/bugreport/license)](https://packagist.org/packages/robertbasic/bugreport)\n\nGet a bug report on a project's dependencies.\n\nLooks at a GitHub repository and reports on:\n\n - number of open issues,\n - average age of open issues,\n - age of oldest open issue,\n - age of newest open issue,\n - number of open pull requests,\n - average age of open pull requests.\n\nCurrent version is: 0.1.0\n\nThis is a PHP 7+ project.\n\n## installation\n\nInstall it with composer as a `--dev` dependency:\n\n```\ncomposer require --dev robertbasic/bugreport:0.1.0\n```\n\n## usage\n\nRunning:\n\n```\n./bin/bugreport\n```\n\nwill search for a `composer.lock` file in the current directory and go through\nall the dependencies of the project.\n\nYou can also pass a path to the `composer.lock` file you want to check:\n\n```\n./bin/bugreport /path/to/composer.lock\n```\n\nTo check for a single dependency, provide a `user/repository` combination:\n\n```\n./bin/bugreport user/repository\n```\n\nPassing in `--html` as a command line option, will tell `bugreport` to create\nan HTML report, instead of a text one.\n\n## configuration\n\nBy default `bugreport` will generate a `bugreport.txt` file in the current\nworking directory with the entire report. You can configure that by:\n\n - copy `bugreport.json.dist` to `bugreport.json`\n - add `bugreport.json` to `.gitignore`\n - edit `bugreport.json`, change the value of `bugreport_filename` to the path\n and filename where you want the report to be saved.\n\n## github api rate limit\n\nIf you run `bugreport` too much, or against a project with lots of dependencies,\nthe github api rate limit might kick in. In that case, you need to create a\n[GitHub personal access token](https://github.com/blog/1509-personal-api-tokens).\n\nThe **ONLY** scope `bugreport` requires is `public_repo`, nothing else.\n\nOnce you have the token do the following:\n\n - copy `bugreport.json.dist` to `bugreport.json`\n - add `bugreport.json` to `.gitignore`\n - edit `bugreport.json`, change the value of`github_personal_access_token` to\n your token.\n\n## html report\n\nThe HTML report looks something like this:\n\n![HTML bugreport](html.png)\n\n## contributing\n\nPlease read [CONTRIBUTING.md](CONTRIBUTING.md)\nfor details on our code of conduct, and the process for submitting pull requests\nto us.\n\n## versioning\n\nWe use [SemVer](http://semver.org/) for versioning. For the versions available,\nsee the [tags on this repository](https://github.com/robertbasic/bugreport/tags).\n\n## changelog\n\nPlease read the [changelog](CHANGELOG.md).\n\n## todo\n\n - [ ] interactive configuration\n - [x] write report as html\n - [ ] phar for distribution\n - [ ] is the project deprecated?\n - [ ] did the project move?\n - [ ] number of contributors (regular vs. occasional)\n - [ ] age of last release\n - [ ] activity in the last 30 days (opened vs. closed issues/PRs)\n - [ ] get project name from composer.json\n - [ ] level of dependency to check (1st, 2nd, other)\n\n## authors\n\n* **Robert Basic** - [robertbasic](https://github.com/robertbasic)\n\nSee also the list of [contributors](https://github.com/robertbasic/bugreport/contributors)\nwho participated in this project.\n\n## license\n\nThis project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md)\nfile for details.\n","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertbasic%2Fbugreport","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Frobertbasic%2Fbugreport","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Frobertbasic%2Fbugreport/lists"}