https://github.com/y-syo/pogit

🌸 a git wrapper for cute commits.
https://github.com/y-syo/pogit

cute flake fortnitenewseason git git-commit-messages git-wrapper nix nix-flake nix-flakes python python3

Last synced: 13 days ago
JSON representation

🌸 a git wrapper for cute commits.

• Host: GitHub
• URL: https://github.com/y-syo/pogit
• Owner: y-syo
• License: wtfpl
• Created: 2024-02-07T00:23:37.000Z (11 months ago)
• Default Branch: master
• Last Pushed: 2024-12-01T19:28:07.000Z (about 1 month ago)
• Last Synced: 2024-12-01T20:25:45.753Z (about 1 month ago)
• Topics: cute, flake, fortnitenewseason, git, git-commit-messages, git-wrapper, nix, nix-flake, nix-flakes, python, python3
• Language: Python
• Homepage:
• Size: 32.2 KB
• Stars: 4
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE.md

Awesome Lists containing this project

README

        
# pogit

> 🌸 a git wrapper for cute commits  

> *by [y-syo](https://y-syo.me)/[mmoussou](https://profile.intra.42.fr/users/mmoussou)*

## what is this all about ?

``pogit`` is a git wrapper that aims for prettier and more easily readable commit messages.

it also helps you working with multiples remotes at once.

## features

  - cool emojis and prefix to show what's the commit about:

    feature:  「✨」 feat(\_): added a very cool feature !

    clean:    「🗑️」 clean(\_): cleaned project.

    init:     「🎉」 init(\_): hello world !

    norm:     「✏️」 norm(\_): normed project.

    test:     「🚧」 test(\_): testing things, might broke.

    wip:      「🏗️」 wip(\_): work in progress, not done yet.

    fix:      「🔨」 fix(\_): fixed some things.

    doc:      「📝」 doc(\_): added documentation.

  - push to multiple remotes easily !

  - an optional config file to change the formatting and tweak (documentation about this config file is coming soon)

upcomming features:

  - some future options like a norm check, 

  - a 42norm checking that puts a warning flag when you commit not-normed code

  - remote managing

## install

### via pip

```

pip install git+https://github.com/y-syo/pogit

```

### nix 

#### nix profile

```bash

nix profile install github:y-syo/pogit#default

```

#### system packages

flake.nix

```nix

{

  inputs = {

    nixpkgs.url = "github:nixos/nixpkgs/release24.05";

    pogit = {

      url = "github:y-syo/pogit";

      inputs.nixpkgs.follows = "nixpkgs" # to use your nixpkgs instance instead of the provided one

    };

    ...

  };

}

```

configuration.nix

```nix

{ pkgs, inputs, ...}:

{

  environment.systemPackages = [

    inputs.pogit.packages.${pkgs.system}.default

  ];

}

```

#### with home-manager module

```nix

{ inputs, ... }:

{

  imports = [

    # importing the module to have access to options.

    inputs.pogit.homeManagerModules.default

  ];

  programs.pogit = {

    enable = true;

    #package = inputs.pogit.packages.${pkgs.system}.pogit; # default package can be changed here.

    config = {

      format = "TODO"; # to format the text

      custom-commit-name = {

        icon = "🐶";

        default_msg = "a default message.";

      };

    };

  };

}

```

## commit guideline

pogit has a [commit guideline](https://github.com/y-syo/pogit/wiki/Commit-guideline) that you can use for all your project :tada:

## license

This project is published under the Do What The F\*ck You Want Public License.

So have fun doing whatever the f\*ck you want ! :D