1
Fork 0

Compare commits

..

2 Commits

Author SHA1 Message Date
Bauke 50a2102d98
Add examples for every command. 2024-01-16 12:18:11 +01:00
Bauke 8d419d4799
Move the global lints to Cargo.toml. 2024-01-16 12:06:18 +01:00
3 changed files with 51 additions and 3 deletions

View File

@ -20,3 +20,10 @@ regex = "1.10.2"
[dependencies.clap] [dependencies.clap]
features = ["derive"] features = ["derive"]
version = "4.4.7" version = "4.4.7"
[lints.clippy]
missing_docs_in_private_items = "warn"
[lints.rust]
missing_docs = "warn"
unsafe_code = "forbid"

View File

@ -14,14 +14,58 @@ bautils arguments count -- $fruits
### Date ### Date
```sh
# Outputs the current date with the ISO 8601 format.
bautils date now
# Set a custom format using `-f` or `--format`.
bautils date now -f '%F %T'
```
### Directory ### Directory
```sh
# Checks whether a directory exists, returning an exit code of 1
# when it doesn't. This specifically checks for a directory so if
# a path exists but it isn't a directory this will also return 1.
bautils directory exists 'source'
```
### File ### File
```sh
# Checks whether a file exists, with the same logic as the
# `directory exists` command.
bautils file exists 'Cargo.toml'
# Returns metadata of a file, for example `--modified` returning
# when the file was last modified.
bautils file metadata 'Cargo.toml' --modified
# Returns parts of a file name.
bautils file parts 'source/main.rs' --directory # Outputs: source
bautils file parts 'source/main.rs' --basename # Outputs: main
bautils file parts 'source/main.rs' --extension # Outputs: rs
```
### Log ### Log
```sh
# Logs data to a file, creating the file if it doesn't exist.
bautils log -- 'The data to log!'
# The log file can be specified with `-f` or `--file`.
bautils log -f 'logfile.txt' -- 'More data!'
```
### Match ### Match
```sh
# Matches a regular expression, returning an exit code of 1 if it
# is succesful.
bautils match regex --pattern '\d' '123'
```
## License ## License
Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Bauke/bautils/src/branch/main/LICENSE) for more information. Distributed under the [AGPL-3.0-or-later](https://spdx.org/licenses/AGPL-3.0-or-later.html) license, see [LICENSE](https://git.bauke.xyz/Bauke/bautils/src/branch/main/LICENSE) for more information.

View File

@ -2,9 +2,6 @@
//! //!
//! > **Bauke's Ad-hoc Utilities.** //! > **Bauke's Ad-hoc Utilities.**
#![forbid(unsafe_code)]
#![warn(missing_docs, clippy::missing_docs_in_private_items)]
mod cli; mod cli;
mod logging; mod logging;