https://github.com/ssx/skrub

A package to remove junk from Composer installations and trim build sizes.
https://github.com/ssx/skrub

build cleaner cleanup composer composer-package composer-plugin disk-space php

Last synced: about 2 months ago
JSON representation

A package to remove junk from Composer installations and trim build sizes.

• Host: GitHub
• URL: https://github.com/ssx/skrub
• Owner: ssx
• License: other
• Created: 2019-09-16T17:51:10.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2022-11-10T19:33:35.000Z (almost 2 years ago)
• Last Synced: 2024-06-21T18:10:08.380Z (3 months ago)
• Topics: build, cleaner, cleanup, composer, composer-package, composer-plugin, disk-space, php
• Language: PHP
• Size: 32.2 KB
• Stars: 85
• Watchers: 3
• Forks: 2
• Open Issues: 4
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-composer - Composer-Skrub - The plugin helps to remove junk from Composer installations and trim build sizes. (Plugins / Support)
• jimsghstars - ssx/skrub - A package to remove junk from Composer installations and trim build sizes. (PHP)

README

        
# Skrub.

Skrub is a composer plugin that will remove useless files and free up some space, 

especially useful when trying to keep Docker images small. A lot of OSS project

owners use .gitattributes to strip junk out but the majority don't.

### Installation

Just run `composer require ssx/skrub` and you're good to go.

### Usage

`composer skrub` will list the files Skrub feels it can safely remove and the 

total disk space that can be regained.

Adding `--perform` to the command will actually delete the files & 

directories from your system.

[![asciicast](https://asciinema.org/a/NHImku9pWOwM2EY34YZTq4RZu.svg)](https://asciinema.org/a/NHImku9pWOwM2EY34YZTq4RZu)

### Warranty, Disclaimer etc.

This is a plugin that will perform a deletion command on your system. The 

author is in no way liable for any data loss arising from its use or if it 

deletes unexpected files. Pay attention to the files Skrub lists.   

### Security Issues

If you discover a security issue with Skrub, please email [email protected] and I'll

response as soon as possible.