3 releases
0.0.8 | Jun 6, 2024 |
---|---|
0.0.7 | Mar 11, 2024 |
0.0.6 | Jan 6, 2024 |
#666 in Command line utilities
18KB
366 lines
markdown-prune
Utility for deleting all markdown files in a folder recursively. Intended to be used as part of a CI/CD pipeline to reduce container size.
Installation
cargo install markdown-prune
Usage
Basic usage
Providing a path to a folder is required.
# Current path
markdown-prune .
# Absolute path
markdown-prune /path/to/folder
# Relative path
markdown-prune ./node_modules
Explicit arguments
Path
--path
is used to pass an explicit path.
markdown-prune --path ./node_modules
# Deleted 2185 files totaling 12.03mb
Dry running
If you want to dry run first before deleting the files, either pass --dry
or --check
as an argument. Dry running only works with an explicit path argument.
markdown-prune --path ./node_modules --check
# Found 2185 files totaling 12.03mb
Custom filenames & extensions
If you wish to remove files you can use the following commands --file
, --file-name
or --ext
.
markdown-prune --path ./node_modules --file .DS_Store --file .d.ts
# Found 25216 files totaling 114.10MB
Result unit size
The argument --unit
can be used to change the default result byte size.
It accepts the following b
, kb
, mb
, gb
, tb
markdown-prune --path ./node_modules --check --unit b
# Found 2185 files totaling 12030000b
markdown-prune --path ./node_modules --check --unit kb
# Found 2185 files totaling 12030kb
markdown-prune --path ./node_modules --check --unit mb
# Found 2185 files totaling 12.03mb
markdown-prune --path ./node_modules --check --unit gb
# Found 2185 files totaling 0.01gb
markdown-prune --path ./node_modules --check --unit tb
# Found 2185 files totaling 0tb
Disclaimer
Use at your own risk.