Unbloat is a powerful tool designed to help developers manage and clean up their Git repositories by identifying and handling files that were once tracked but no longer present in the latest commits. It's particularly useful for removing API keys, passwords or other sensitive data, or large files that were accidentally committed, while keeping commit and commit message history intact.
npm run unbloat
Unbloat works by scanning the entire Git repository, including all branches and reflog entries, to compile a comprehensive list of files that have ever been tracked. It then compares this list against the files currently present in the latest commits across active branches. This comparison allows the script to accurately identify files that are no longer needed, providing the developer with the option to either view these files or remove them permanently from the repository's history. Once the obsolete files are identified Unbloat offers a cleanup option that not only removes these files but also purges stashes, tags, original refs, the Git reflog and unreachable objects, maximizing the security posture of the repository and ensuring that it is as lean and performant as possible. Given the powerful nature of Unbloat it is highly recommended that developers experiment with it in a controlled environment before applying changes to the main repository. This can be achieved by running it from a local copy of the repository, carefully reviewing the list of identified files, extensive regression testing, etc. When confident in the repository's unbloated state, ensure collaborators are aware before forcing updates to the remote origin.
With npm do
$ npm install unbloat
(MIT)
Copyright (c) 2024 David H. <email6@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
FAQs
Unbloat maximizes the security posture of your repository and purges unnecessary file weight without compromising commit and commit message history.
The npm package unbloat receives a total of 13 weekly downloads. As such, unbloat popularity was classified as not popular.
We found that unbloat demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.