DirClean is a script for categorizing directories & files based on file types. This small project aims to extract best practices in coding, in general. This includes machine-agnostic builds with Docker, CI/CD pipelines, documentation, and clean commit messages.
DirClean supports almost all file extensions. All extension categories are defined from the Wikipedia page "List of file formats".
- Bash:
sh-compatible shell full of features & built ins - Docker: Run tasks (such as lint) on a container, working on any machine
- GitHub Actions: Run workflows to lint, build & push docker image
- Pre-Commit: Run a pre-commit configs locally
- ShellCheck: Tool for picking up warnings & shell script suggestions, run in the pipelines & pre-commit
- Conventional Commits: Specification for naming commits
Configurating the new location of a file extension can be done by navigating to config/ext_mapping and looking up the extension.
This project is under the MIT license. All details are attached within the license.