projclean 0.7.0

Project dependecies & build artifacts 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

# 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 dependecies & build artifacts cleaner.

![screenshot](https://github.com/sigoden/projclean/assets/4012553/a875c5f2-e87e-4b74-a48e-3636024d31eb)

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

Arguments:
  [RULES]...  Search rules, e.g. node_modules target@Cargo.toml

Options:
  -C, --cwd <DIR>         Start searching from <DIR> [default: .]
  -x, --exclude <DIR>     Exclude directories from search, e.g. ignore1,ignore2
  -t, --time <[+|-]DAY>   Path was last modified less than, more than or exactly <DAY> days
  -s, --size <[+|-]SIZE>  Path uses less than, more than or exactly <SIZE> units (K|M|G|T) of space
  -D, --delete-all        Automatically delete all found targets
  -P, --print             Print the found targets
  -h, --help              Print help
  -V, --version           Print version
```

Clean up node_modules.

```sh
projclean node_modules
```

Clean up various types of projects.

```sh
projclean node_modules target@Cargo.toml
```

Start searching from a specific directory with `-C` or `--cwd`

```sh
projclean -C $HOME node_modules # equal to `cd $HOME && projclean node_modules`
```

Find node_modules with the latest updates over 30 days and occupy more than 1G disk space.
```sh
projclean node_modules --time +30 --size +1G
```

## Search Rule

Projclean find targets according search rule.

Rule consist of two parts:

```
<target[,target...]>[@flag]
```

| project   | rule                                                                       |
| :-------- | :------------------------------------------------------------------------- |
| node      | `node_modules`                                                             |
| cargo     | `target@Cargo.toml`                                                        |
| maven     | `target@pom.xml`                                                           |
| gradle    | `.gradle,build@build.gradle`                                               |
| python    | `__pycache__,.mypy_cache,.pytest_cache,.ruff_cache,.tox@*.py`              |
| composer  | `vendor@composer.json`                                                     |
| swift     | `.build,.swiftpm@Package.swift`                                            |
| dart      | `.dart_tool,build@pubspec.yaml`                                            |
| cocoapods | `Pods@Podfile`                                                             |
| sbt       | `target,project/target@build.sbt`                                          |
| zig       | `zig-cache,zig-out@build.zig`                                              |
| stack     | `.stack-work@stack.yaml`                                                   |
| jupyter   | `.ipynb_checkpoints@*.ipynb`                                               |
| ocaml     | `_build@dune-project`                                                      |
| elixir    | `_build@mix.exs`                                                           |
| erlang    | `_build@rebar.config`                                                      |
| vs        | `.vs,Debug,Release@*.sln`                                                  |
| vc        | `Debug,Release@*.vcxproj`                                                  |
| c#        | `bin,obj@*.csproj`                                                         |
| f#        | `bin,obj@*.fsproj`                                                         |
| unity     | `Library,Temp,Obj,Logs,MemoryCaptures,Build,Builds@Assembly-CSharp.csproj` |
| unreal    | `Binaries,Build,Saved,DerivedDataCache,Intermediate@*.uproject`            |
| godot     | `.godot@project.godot`                                                     |

## License

Copyright (c) 2022-2023 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.