{"id":18653716,"url":"https://github.com/solidworx/burial","last_synced_at":"2025-04-11T16:32:46.590Z","repository":{"id":57055275,"uuid":"197608450","full_name":"SolidWorx/Burial","owner":"SolidWorx","description":"Bury your dead code","archived":false,"fork":false,"pushed_at":"2019-07-21T11:53:30.000Z","size":10,"stargazers_count":12,"open_issues_count":0,"forks_count":0,"subscribers_count":4,"default_branch":"master","last_synced_at":"2024-03-23T11:24:20.164Z","etag":null,"topics":["dead-code","dead-code-elimination","dead-code-removal","php","tombs"],"latest_commit_sha":null,"homepage":null,"language":"PHP","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/SolidWorx.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-07-18T15:01:58.000Z","updated_at":"2024-03-23T11:24:20.165Z","dependencies_parsed_at":"2022-08-24T14:00:23.874Z","dependency_job_id":null,"html_url":"https://github.com/SolidWorx/Burial","commit_stats":null,"previous_names":[],"tags_count":1,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidWorx%2FBurial","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidWorx%2FBurial/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidWorx%2FBurial/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/SolidWorx%2FBurial/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/SolidWorx","download_url":"https://codeload.github.com/SolidWorx/Burial/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223472754,"owners_count":17150745,"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":["dead-code","dead-code-elimination","dead-code-removal","php","tombs"],"created_at":"2024-11-07T07:12:56.839Z","updated_at":"2024-11-07T07:12:57.519Z","avatar_url":"https://github.com/SolidWorx.png","language":"PHP","funding_links":[],"categories":[],"sub_categories":[],"readme":"Burial\n======\n\nBury dead code in a project using [Tombs](https://github.com/krakjoe/tombs)\n\n## Installation:\n\n\n### Phar\n\nDownload the latest Phar from [https://github.com/SolidWorx/Burial/releases](https://github.com/SolidWorx/Burial/releases)\n\n### Composer\n\nInstall into a project (or globally) using Composer\n\n```bash\n$ composer require solidworx/burial\n\n# or\n\n$ composer global require solidworx/burial\n```\n\n## Usage\n\nYou should already have [Tombs](https://github.com/krakjoe/tombs) running on an environment and communicating through a socket.\n\n**NOTE:** You should let Tombs run for at lease a couple of days/weeks, to ensure as much production code is hit as possible.\n\nRun Burial against your code base, providing the Tombs socket as first argument\n\n```bash\n$ bin/bury http://127.0.0.1:8015\n\n# or\n\n$ php bury.phar http://127.0.0.1:8015\n```\n\nThis will then remove all the dead code from your project (defaults to the directory where Burial is executed from).\n\n### Options\n\nBurial takes the following parameters\n\n| Name               | Default                   | Description                                                                                              | Example                                                                      |\n|:-------------------|:--------------------------|:---------------------------------------------------------------------------------------------------------|:-----------------------------------------------------------------------------|\n| --production-path  | Current Working Directory | Set the path of the code on production. This is used to map the production code against your local code. | `$ bin/bury http://127.0.0.1:8015 --production-path=/var/www/html/myapp`     |\n| --ignore-dir       | NULL                      | Add multiple directories to ignore (`vendor` is always ignored by default)                               | `$ bin/bury http://127.0.0.1:8015 --ignore-dir=var/cache  --ignore-dir=app`  |\n\n## Important\n\n**DO NOT** run this directly in your production environment. It will remove code that might still be used.\nYou should only run this on your local machine or a test environment, where you can carefully verify the changes, run unit tests and do proper testing to ensure that nothing is broken.\n\n## TODO\n\n- Ensure a method is not required from a trait/parent class's interface, extended class etc\n- Handle calls without a scope (E.G closures)\n- Remove dead functions (only method calls are currently supported)\n- Add tests\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidworx%2Fburial","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsolidworx%2Fburial","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsolidworx%2Fburial/lists"}