20 releases (6 stable)
1.3.0 | Sep 9, 2024 |
---|---|
1.2.1 | Jul 1, 2023 |
1.1.0 | Mar 31, 2022 |
0.9.1 | Mar 28, 2022 |
#568 in Development tools
51 downloads per month
76KB
1.5K
SLoC
makeclean
Removes generated and downloaded files from code projects to free up space.
Features:
- List, cleans and archives projects depending on how long you haven't touched them.
- Respects
.gitignore
files even outside Git repositories. Build tools often create a.gitignore
file when initializing a new project, so this makes sure that the dependencies are not traversed even in case you have not initialized the Git repository yet. - Supports
.ignore
files, which have the same semantics as.gitignore
files and are supported by search tools such as ripgrep and The Silver Searcher. - Ignores hidden directories.
Currently supports the following build tools:
- Cargo
- Elm
- Flutter
- Gradle (Assumes
$buildDir
is set to the default value$projectDir/build
! Seegradle.rs
) - Mix
- NPM
Table of contents:
Installation
Install using Cargo:
cargo install makeclean
Current release: 1.3.0
Usage
Run makeclean --help
to see all available options.
List projects
List all projects that are "stale", that is, have not been changed recently, under a given path, using --list
/-l
:
makeclean --list ~/projects
By default, a project is considered stale if there weren't any changed for at least a month. You can change this by using --min-stale
/-m
; for example, to consider all projects that have not been modified within the last 2 weeks:
makeclean --list --min-stale=2w ~/projects
Set --min-stale
to zero to disable the check:
makeclean --list --min-stale=0 ~/projects
You can also filter by build tool using --type
/-t
:
makeclean --list --type npm ~/projects
Clean projects
By default, makeclean
looks for any projects that haven't been touched for a month, and offers to clean them:
makeclean ~/projects
Use --dry-run
/-n
to see what would happen, without actually deleting anything:
makeclean --dry-run ~/projects
If you run makeclean
in a script and don't want the prompt, you can pass --yes
to proceed automatically:
makeclean --yes ~/projects
You can also specify multiple directories at once. For example, to regularly clean up some scratch directories, you could add something like this to crontab or a startup script:
makeclean --min-stale=1w --yes \
~/code/rust-playground \
~/code/elm-playground \
~/code/flutter-playground
Clean + archive projects
If you also want to archive the projects after cleaning them up, pass --archive
. For example, the following command would replace the contents of ~/projects/foo
with ~/projects/foo.tar.xz
, after cleaning it:
makeclean --archive ~/projects/foo
Note that while
--archive
also considers cleaned projects, it still respects--min-stale
. If makeclean doesn't find your project but you think it should, try again with the environment variableRUST_LOG
set totrace
, e.g.,RUST_LOG=trace makeclean --archive ~/projects/foo
. You should see a hint as to why the project was not considered. If the logs don't tell you what's going on, please consider creating a GitHub issue.
To restore the project, use tar
(which is probably already installed on your system):
cd ~/projects/foo
tar -xaf foo.tar.xz && rm foo.tar.xz
Hack it
PRs welcome! Check out the documentation on crates.io to get started. Feel free to create a GitHub issue if you have any questions.
Checklist for adding a new build tool
- Add applicable project types to the
BuildToolKind
enum insrc/build_tools.rs
. - Add the new module to
src/build_tools.rs
, creating a file belowsrc/build_tools/
. - Add
register
call toBuildToolManager::default
insrc/build_tool_manager.rs
. - Add module and init function to
tests/util/
and to thetools
array attests/tests/build_tools.rs
.
License
MIT. Any contributions are assumed MIT-licensed as well.
Dependencies
~25–37MB
~680K SLoC