README

`$ git-unsaved`

Scan your projects directory for dirty git repositories.

Features

:rocket: Very fast–gives feedback while scanning the directories.
:zap: Clean output
:tokyo_tower: Checks if the local commits/branches are pushed to the remote
:eyes: Detects uncommited changes (new files, modified, deleted etc)
:dizzy: Lovely output

:cloud: Installation

You can install the package globally and use it as command line tool:

# Using npm
npm install --global git-unsaved

# Using yarn
yarn global add git-unsaved

Then, run git-unsaved --help and see what the CLI tool can do.

$ git-unsaved --help
Usage: git-unsaved [options]

Scan your projects directory for dirty git repositories.

Options:
  -r, --relative-paths  Display the relative paths.
  -p, --path <path>     A custom folder path (default: the current working
                        directory).
  -h, --help            Displays this help.
  -v, --version         Displays version information.

Examples:
  $ git-unsaved # Scans the current directory
  $ git-unsaved -p ~/projects # Scans the projects directory
  $ git-unsaved | less -r # Pipe the output to `less`

Documentation can be found at https://github.com/IonicaBizau/git-unsaved#readme.

:clipboard: Example

Here is an example how to use this package as library. To install it locally, as library, you can use npm install git-unsaved (or yarn add git-unsaved):

const gitUnsaved = require("git-unsaved");

gitUnsaved(`${__dirname}/..`, (err, data) => {

    if (err) {
        // Something went really wrong
        return;
    }

    console.log(data);
    // { result: { branch: 'master', ahead: 4, dirty: 3, untracked: 0, stashes: 0 },
    //   messages:
    //    [ 'You have \u001b[1m4\u001b[22m \u001b[1munpushed commits\u001b[22m.',
    //      'You have \u001b[1m3\u001b[22m \u001b[1mfiles you have to commit\u001b[22m.' ],
    //   path: '/home/.../git-unsaved' }

    data.messages.forEach(c => {
        console.log(`  ${c}`);
    });

    // =>
    // You have 4 unpushed commits.
    // You have 3 files you have to commit.
    console.log();
}).on("directory", path => {
    console.log(`Scanning ${path}`)
    // Scanning /home/.../git-unsaved/...
}).on("end", () => {
    console.log("Done")
});

:question: Get Help

There are few ways to get help:

Please post questions on Stack Overflow. You can open issues with questions, as long you add a link to your Stack Overflow question.
For bug reports and feature requests, open issues. :bug:
For direct and quick help, you can use Codementor. :rocket:

:memo: Documentation

For full API reference, see the DOCUMENTATION.md file.

:yum: How to contribute

Have an idea? Found a bug? See how to contribute.

:sparkling_heart: Support my projects

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can integrate and use these projects in your applications for free! You can even change the source code and redistribute (even resell it).

However, if you get some profit from this or just want to encourage me to continue creating stuff, there are few ways you can do it:

Starring and sharing the projects you like :rocket:
—I love books! I will remember you after years if you buy me one. :grin: :book:
—You can make one-time donations via PayPal. I'll probably buy a ~~coffee~~ tea. :tea:
—Set up a recurring monthly donation and you will get interesting news about what I'm doing (things that I don't share with everyone).
Bitcoin—You can send me bitcoins at this address (or scanning the code below): 1P9BRsmazNQcuyTxEqveUsnf5CERdq35V6

Thanks! :heart:

git-unsaved

Usage no npm install needed!