projclean 0.4.0

Projects dependencies & builds cleaner
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121

# ProjClean

[![CI](https://github.com/sigoden/projclean/actions/workflows/ci.yaml/badge.svg)](https://github.com/sigoden/projclean/actions/workflows/ci.yaml)
[![Crates](https://img.shields.io/crates/v/projclean.svg)](https://crates.io/crates/projclean)

Find and clean dependencies & builds from software projects to saving space or making backup easier.

![screenshot](https://user-images.githubusercontent.com/4012553/176798015-89314719-5baa-4cce-b04a-52b0060a334e.gif)

## Why

- **Save space**: Cleans unnecessary directories and files.
- **Very fast**: Written in rust, optimized for concurrency.
- **Easy to use**: A tui listing all found targets and pressing `<space>` to get rid of them.
- **Minified**: single executable file, no dependencies, no installation.

## Install

### With cargo

```
cargo install projclean
```

### Binaries on macOS, Linux, Windows

Download from [Github Releases](https://github.com/sigoden/projclean/releases), unzip and add projclean to your $PATH.

## CLI

```
USAGE:
    projclean [OPTIONS] [RULES]...

ARGS:
    <RULES>...    Search rules

OPTIONS:
    -C, --directory <DIR>    Start searching from DIR [default: .]
    -h, --help               Print help information
    -t, --targets            Print found targets, do not enter tui
    -V, --version            Print version information
```

Find and clearn node_modules folders.

```
projclean node_modules
```

Common search rules for common projects:

| name    | search rule                                    |
| :------ | :--------------------------------------------- |
| js      | `node_modules`                                 |
| rs      | `target@Cargo.toml`                            |
| vs      | `'^(Debug\|Release)$@\.sln$'`                  |
| ios     | `'^(build\|xcuserdata\|DerivedData)$@Podfile'` |
| android | `build@build.gradle`                           |
| java    | `target@pom.xml`                               |
| php     | `vendor@composer.json`                         |

Find and clean dependencies & builds from kinds of projects.

```
projclean node_modules target@Cargo.toml target@pom.xml
```

Start searching from specific directory, other than currenct work directory.

```
projclean -C $HOME node_modules target@pom.xml
```

## Rule

Projclean find targets according search rule.

Rule consist of two parts:

```
<target-folder>[@flag-file]
```

> Both target folder and flag file can be plain text or regex.

Flag file is used to filter out folders that match only names but not projects.
 
E.g. The directory has the following contents:

```
.
├── misc-proj
│   └── target
└── rust-proj
    ├── Cargo.toml
    └── target
```

Rule `target` found all `target` folders 

```
$ projclean -t target
/tmp/demo/rust-proj/target
/tmp/demo/misc-proj/target
```

Rule `target@Cargo.toml` found `target` folders belongs the rust project.

```
$ projclean -t target@Cargo.toml
/tmp/demo/rust-proj/target
```

## License

Copyright (c) 2022 projclean-developers.

argc is made available under the terms of either the MIT License or the Apache License 2.0, at your option.

See the LICENSE-APACHE and LICENSE-MIT files for license details.