[ci]: https://github.com/kevinmatthes/aeruginous-rs/workflows/ci/badge.svg
[ci-url]: https://github.com/kevinmatthes/aeruginous-rs/workflows/ci
[crates-io]: https://img.shields.io/crates/v/aeruginous
[crates-io-url]: https://crates.io/crates/aeruginous
[docs-rs]: https://docs.rs/aeruginous/badge.svg
[docs-rs-url]: https://docs.rs/aeruginous
[downloads]: https://img.shields.io/crates/d/aeruginous
[gpl3]: https://github.com/kevinmatthes/aeruginous-rs/blob/main/LICENSE
[lcns]: https://img.shields.io/github/license/kevinmatthes/aeruginous-rs
[lcnss]: https://github.com/kevinmatthes/aeruginous-rs/tree/main/LICENSEs
[lst]: https://img.shields.io/github/last-commit/kevinmatthes/aeruginous-rs
[repository]: https://github.com/kevinmatthes/aeruginous-rs
# `aeruginous`
## Summary
[![][ci]][ci-url]
[![][crates-io]][crates-io-url]
[![][docs-rs]][docs-rs-url]
[![][downloads]][crates-io-url]
[![][lst]][repository]
[![][lcns]][repository]
The Aeruginous Open Source Development Toolbox.
1. [License](#license)
1. [Introduction](#introduction)
1. [Installation](#installation)
1. [Supported Subcommands](#supported-subcommands)
1. [`cffreference`](#cffreference)
1. [`comment-changes`](#comment-changes)
1. [`rs2md`](#rs2md)
1. [`uncrlf`](#uncrlf)
The current code coverage is **<!-- cov -->62.82%<!-- cov -->**.
## License
This project's license is **GPL-3.0**. The whole license text can be found
in [`LICENSE`][gpl3] in the repository root. The brief version is as
follows:
> Copyright (C) 2022─2023 Kevin Matthes
>
> This program is free software: you can redistribute it and/or modify
> it under the terms of the GNU General Public License as published by
> the Free Software Foundation, either version 3 of the License, or
> (at your option) any later version.
>
> This program is distributed in the hope that it will be useful,
> but WITHOUT ANY WARRANTY; without even the implied warranty of
> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
> GNU General Public License for more details.
>
> You should have received a copy of the GNU General Public License
> along with this program. If not, see <https://www.gnu.org/licenses/>.
License information about the dependencies this software requires to work
can be found in [`LICENSEs`][lcnss].
## Introduction
`aeruginous` is a Rust application providing several development utilities.
When searching a name for this project, one main requirement was to reflect
both the originally intended main purpose of tracking time as well as the
coding language this CLI is written in, Rust. The adjective *aeruginous*
fulfills both criteria as it means that the described noun has patina, a
special form of rust which appears after a certain period of time has
passed.
Originally, it was planned to be a time tracking CLI but during the
development of the first stable version, certain common tasks needed to be
fulfilled repeatedly. Since the application already had a somehow stable
calling interface, the solutions to these tasks were added as subcommands
to `aeruginous` in order to provide a convenient and time efficient
automation. One major advantage of doing so is the reduced maintenance
effort and overall setup overhead because there is only one project to
maintain instead multiple ones.
This is how the idea arose to design `aeruginous` to be a toolbox instead
of only a time tracker.
## Installation
To download the latest stable version from [`crates.io`][crates-io-url], run
the following command.
```bash
cargo install aeruginous
```
To install the latest nightly version from sources, Cargo also supports the
installation from the current repository state.
```bash
cargo install --git https://github.com/kevinmatthes/aeruginous-rs
```
## Supported Subcommands
### `cffreference`
> To be called with:
>
> - `cffref`
> - `cffreference`
> - `cff-reference`
CFF makes software citable. Projects exposing a `CITATION.cff` can be cited
with APA plain text citations, BibTeX database entries, and also in another
`CITATION.cff`'s list of references.
This subcommand grabs the citation information of the named source CFF file
and pastes it at the end of the given output file.
If the input file is omitted, the input information are attemted to be read
from [`std::io::Stdin`]. Likewise, omitting the output file will cause
`cffreference` to write to [`std::io::Stdout`].
### `comment-changes`
> To be called with:
>
> - `changelog`
> - `comment-changes`
It is a good practice to document changes to the code base in a CHANGELOG.
This mode will read the recent commit messages and try to create a fragment
for the CHANGELOG.
This mode requires the specification of a delimiter separating the CHANGELOG
category from an entry for that category. The application will browse the
Git history for commits which contain that delimiter in their first
paragraphs, often referred to as the commit's summary, and split the
summaries at the first occurence of that delimiter. Users are free to
search either the entire commit history or just a specific number of
commits. Each commit which does not contain that delimiter in its summary
will be skipped. The resulting changelog fragment will be stored either in
the current working directory or in the given alternative, already existing
directory. The file name will consist of a time stamp, the configured Git
username, and some information on the current branch. The file format will
be reStructured Text (RST).
As an example, a repository might contain these four commits:
1. ```Added ::= source file `a.rs`_```
2. ```Added ::= source file `b.rs`_```
3. `Update c.rs`
4. ```Fixed ::= known bug in `d.rs`_```
To extract the changes from only these four commits, the application would
need to be called with the following command.
```bash
aeruginous comment-changes \
-d ::= \
-n 4 \
-o directory/ \
-l a.rs -t src/a.rs -l b.rs -t src/b.rs -l d.rs -t src/d.rs
```
If this command is invoked by a user named Emma Xample on 1st January 1970
at 01.23 am with the branch `e-xample/test` being checked out, the resulting
fragment will be stored as `directory/19700101_012345_Emma_Xample_test.rst`.
The file contents will be the following:
```rst
.. _a.rs: src/a.rs
.. _b.rs: src/b.rs
.. _d.rs: src/d.rs
Added
.....
- source file `a.rs`_
- source file `b.rs`_
Fixed
.....
- known bug in `d.rs`_
```
### `rs2md`
> To be called with:
>
> - `rs2md`
Source code should always be documented. Rust's documentation system
supports Markdown syntax in documentation comments. Thus, it is a
convenient decision to create a Rust project's README file from the crate
root's documentation. This command is also helpful to check the
documentation comments for typos.
When called, the subcommand accepts a list of input files to read from. If
no input file is given, `rs2md` will read from [`std::io::Stdin`]. At
option, an output file can be specified where the results will be written
to. If omitted, the results will be written to [`std::io::Stdout`].
Users are free to choose whether they would like to extract Rust comments
starting with `//!` (outer comments) or comments starting with `///` (inner
comments). If neither option is given, nothing will be extracted.
### `uncrlf`
> To be called with:
>
> - `uncrlf`
Source code should have a uniform appearance. Some text editors terminate
lines by Carriage Return Line Feeds (CRLFs, `\r\n`). This subcommand will
remove those from the given file.