https://github.com/visavi/cleanup

Cleaning composer vendor directory
https://github.com/visavi/cleanup

clean cleaner cleanup composer php

Last synced: about 2 months ago
JSON representation

Cleaning composer vendor directory

• Host: GitHub
• URL: https://github.com/visavi/cleanup
• Owner: visavi
• Created: 2017-01-11T09:14:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2019-12-08T17:00:08.000Z (almost 5 years ago)
• Last Synced: 2024-07-20T08:08:31.461Z (2 months ago)
• Topics: clean, cleaner, cleanup, composer, php
• Language: PHP
• Homepage: http://visavi.net
• Size: 7.81 KB
• Stars: 23
• Watchers: 2
• Forks: 2
• Open Issues: 0
• Metadata Files:
  • Readme: readme.md

Awesome Lists containing this project

README

        
Cleanup

=========

[![Latest Stable Version](https://poser.pugx.org/visavi/cleanup/v/stable)](https://packagist.org/packages/visavi/cleanup)

[![Total Downloads](https://poser.pugx.org/visavi/cleanup/downloads)](https://packagist.org/packages/visavi/cleanup)

[![Latest Unstable Version](https://poser.pugx.org/visavi/cleanup/v/unstable)](https://packagist.org/packages/visavi/cleanup)

[![License](https://poser.pugx.org/visavi/cleanup/license)](https://packagist.org/packages/visavi/cleanup)

## Cleaning composer vendor directory

It cleans up any tests, descriptions, documentation, examples, etc.

* .git

* .github

* test

* tests

* travis

* demo

* example

* examples

* doc

* docs

* license

* changelog*

* changes*

* faq*

* contributing*

* history*

* upgrading*

* upgrade*

* readme*

* {,.}*.yml

* *.md

* *.xml

* *.txt

* *.dist

* *.neon

* .php_cs*

* .scrutinizer

* .gitignore

* .gitattributes

* .editorconfig

* .phpstorm.meta.php

* dockerfile

* composer.lock

## Installing

```

composer require visavi/cleanup

```

   

## Run

```

./vendor/bin/cleanup

```

## Option

--help (-h) - Display help message

--include (-i) - include new rules pattern

--exclude (-e) - excludes from the pattern rule

--verbose (-v) - Increase the verbosity of messages

--path (-p) - Find on specific path

--dry (-d) - Run without actual remove

*the list of arguments must be passed by a comma*

## Example

```

./vendor/bin/cleanup -v --path symfony --include *.zip,*.rar --exclude doc,docs,test

```

## License

The class is open-sourced software licensed under the [MIT license](http://opensource.org/licenses/MIT)