https://github.com/Gankra/cargo-mommy

Mommy's here to support you when running cargo~
https://github.com/Gankra/cargo-mommy

Last synced: 21 days ago
JSON representation

Mommy's here to support you when running cargo~

• Host: GitHub
• URL: https://github.com/Gankra/cargo-mommy
• Owner: Gankra
• License: apache-2.0
• Created: 2022-12-19T06:50:20.000Z (about 2 years ago)
• Default Branch: main
• Last Pushed: 2024-07-31T20:14:35.000Z (5 months ago)
• Last Synced: 2024-11-28T00:05:54.377Z (24 days ago)
• Language: Rust
• Homepage: https://faultlore.com/cargo-mommy/
• Size: 619 KB
• Stars: 766
• Watchers: 8
• Forks: 51
• Open Issues: 25
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE-APACHE
  • Security: SECURITY.md

Awesome Lists containing this project

• starred - Gankra/cargo-mommy - Mommy's here to support you when running cargo~ (Rust)

README

        


# `cargo-mommy`



[![crates.io](https://img.shields.io/crates/v/cargo-mommy.svg)](https://crates.io/crates/cargo-mommy)

[![Rust CI](https://github.com/Gankra/cargo-mommy/workflows/Rust/badge.svg?branch=main)](https://github.com/Gankra/cargo-mommy/actions/workflows/ci.yml)

Mommy's here to support you when running cargo~ ❤️

# Installation

You can `cargo install cargo-mommy`, [see the website for more options](https://faultlore.com/cargo-mommy/)

# Usage

Run whatever cargo command you would normally but add mommy after cargo~

```

cargo mommy check

    Checking bappy-script v0.1.3

error: expected one of `!` or `::`, found `passes`

  --> src\main.rs:20:6

   |

20 | mods passes;

   |      ^^^^^^ expected one of `!` or `::`

error: could not compile `bappy-script` (bin "bappy-script") due to previous error

mommy knows her little girl can do better~ 💞

```

[See the docs for more options](https://faultlore.com/cargo-mommy/book/)

# Configuration

Mommy will read the following environment variables to make her messages better for you~ ❤️

* `CARGO_MOMMYS_LITTLE` - what to call you~ (default: "girl")

* `CARGO_MOMMYS_PRONOUNS` - what pronouns mommy will use for themself~ (default: "her")

* `CARGO_MOMMYS_ROLES` - what role mommy will have~ (default "mommy")

* `CARGO_MOMMYS_EMOTES` - what emotes mommy will have~ (default "❤️/💖/💗/💓/💞")

* `CARGO_MOMMYS_MOODS` - picks the set of possible responses~ (default: "chill", possible values "chill", "ominous")

All of these options can take a `/` separated list. Mommy will randomly select one of them whenever she talks to you~

For example, the phrase "mommy loves her little girl~ 💞" is "CARGO_MOMMYS_ROLE loves CARGO_MOMMYS_PRONOUNS little CARGO_MOMMYS_LITTLE~"

So if you set `CARGO_MOMMYS_ROLES="daddy"`, `CARGO_MOMMYS_PRONOUNS="his/their"`, and `CARGO_MOMMYS_LITTLE="boy/pet/baby"` then you might get any of

* daddy loves their little boy~ ❤️

* daddy loves his little pet~

* daddy loves their little baby~ 💗

And so on~ 💓

# Licensing

mommy likes freedom~ ❤️, and is dual-licensed under [MIT](LICENSE-MIT) and [Apache 2.0](LICENSE-APACHE).

Use either at your choice.