projclean 0.2.0

Project cache finder and cleaner
Documentation 
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

# 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)

Project cache finder and cleaner.

![screenshot](https://user-images.githubusercontent.com/4012553/172361654-5fa36424-10da-4c52-b84a-f44c27cb1a17.gif)

## 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

```
SAGE:
    projclean [OPTIONS] [--] [PATH]

ARGS:
    <PATH>    Start searching from

OPTIONS:
    -h, --help              Print help information
    -r, --rule <RULE>...    Add a search rule
    -t, --list-targets      List found targets and exit
    -V, --version           Print version information
```

Find node_modules folders.

```
projclean -r node_modules
```

Find node_modules folders then print.

```
projclean -r node_modules -t
```

Find node_modules folders starting from $HOME.

```
projclean -r node_modules $HOME
```

## Rule

Projclean detect project and target folder according to rule.

Rule consist of two parts:

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

> Both target folder and flag file can be regex.

If flag file is provided, Only folders with flag files will be selected.

For example. The current directory structure is as follows:

```
.
├── projA
│   ├── Cargo.toml
│   └── target
└── projB
    └── target
```

Run `projclean -r target` will find both `projA/target` and `projB/target`.

Run `projclean -r target@Cargo.toml` will find  `projA/target` only.

## Project

Below is a collection of rule of common porjects:

- js: `node_modules`
- rs: `target@Cargo.toml`
- vs: `^(Debug|Release)$@\.sln$`
- ios: `^(build|xcuserdata|DerivedData)$@Podfile`
- android: `build@build.gradle`

## 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.