Skip to content
This repository has been archived by the owner on Oct 29, 2024. It is now read-only.
/ temp-cleaner Public archive

An app to automatically clean up temporary files and ignored items from git repositories in your system by analyzing .gitignore files.

License

Notifications You must be signed in to change notification settings

JustWhit3/temp-cleaner

Repository files navigation

v0.0.1 license C++20
code size repo size total lines


Table of contents

Introduction

temp-cleaner is a an application which allows you to automatically clean up temporary files and ignored items from git repositories in your system by analyzing .gitignore files.

For an overview of the functions and classes please look at the Doxygen page.

Architecture support

Operating systems

  • Linux
    • Ubuntu (tested)
    • WSL (tested)
  • Windows
    • Windows 10 or higher (not tested)
  • MacOS (not tested)

Compilers

  • gcc: v. 9/10/11/12/13
  • clang: v. 11/12/13/14/15/16/17
  • MSVC: (not directly tested, but should work)

Install and use

Install

1) Download one of the releases of the repository.

2) Unzip and enter the downloaded repository directory.

3) Install and compile the app and its dependencies:

cmake -B build
sudo cmake --build build --target install

⚠️ sudo is not required on Windows.

Mandatory prerequisites:

  • C++20 standard
  • g++ compiler (library developed on Ubuntu v22.04.1 with g++ v11.4.0)
  • CMake (at least v3.15)

Debug mode and tests

Debug mode is used from developers to test the app. To build the app in debug mode:

cmake -B build -DCMAKE_BUILD_TYPE=Debug
sudo cmake --build build

This will automatically compile the source code with debug tools.

Prerequisites for debug mode:

To install on ubuntu: sudo apt install cppcheck

To run IWYU checks:

./test/IWYU.sh

How to use

Once the application is installed you can easily run it from your terminal in this way:

temp-cleaner [path/to/analyze] [config_file]

Where [path/to/analyze] represents the path through which the app will search for .gitignore files through repositories, while [config_file] can be a configuration file containing a list of paths to ignore. Both these arguments are optional and if left empty the search will proceed through the user home directory.

Credits


Gianluca Bianco

Stargazers over time

Stargazers over time

About

An app to automatically clean up temporary files and ignored items from git repositories in your system by analyzing .gitignore files.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published