Giter Club home page Giter Club logo

wip's Introduction

npm npm npm

WIP, WIP, & NAENAE

wip and naenae are command line utilities to better manage your WIP (Work In Progress) with Git.

wip saves your progress by committing the current state of your Git repo with a commit message of "WIP" (a common convention). naenae squashes all your "WIP" commits together and lets you give the commit a better title. By periodically saving your progress, you're free to write, rewrite, and ship faster.

Demo of the wip and naenae command line utilities

Install

wip and naenae run in Node.js, so you'll need to have that installed, type this in the terminal:

$ npm install -g wip

If you don't have it already, you'll need to install Git, too.

Usage

When you want to save your work, type this in the terminal:

$ wip

When you've finished a big chunk of work and you're ready to ship it, type this:

$ naenae

Naenae will archive your work for safe keeping (using wip archive), and then sqash all your WIPs into a single git commit.

HELPMEIT'SALLBROKEN

No worries! Thanks to wip, you've been meticulously tracking your work with Git, so everything is gonna' be ok.

When things break, you can see everything you've changed since the last commit with something like:

$ git diff HEAD^ HEAD

Or you could just download the GitHub Desktop app like the rest of us. SourceTree is also a great option, especially if you're looking for more control.

FAQs

Here's some answers to questions humans might ask if they ever read this.

How do I turn the sound effects off?

You read that right – wip and naenae have some sweet sound effects. They're on by default (so everyone around you can share in your progress), but you can turn them off by typing:

$ wip silently

Someone turned my sound effects off, how do I get them back?

That's terrible! But all is not lost – just:

$ wip loudly

💩, why can't I see the emoji?

Unfortunately, some shells don't support emoji. If you're on Windows, you may need to upgrade to something like Cygwin. If you want to avoid seeing the "unrecognized character" boxes (or if you just hate fun) you can:

$ wip without emoji

And when you're ready to rejoin civilization:

$ wip with emoji

All the hipsters use commitizen.

And you can too! Turn it on:

$ wip with commitizen

You can also turn it back off:

$ wip without commitizen

Have you tried putting it in a watch task and commiting on save?

npm install -g watch
wip silently
watch wip --ignoreDotFiles

You won't be disappointed.

License

MIT


xkcd commic about git

Naming inspired by Silentó - Watch Me (Whip/Nae Nae):

Silentó - Watch Me (Whip/Nae Nae) (Official)

wip's People

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar  avatar  avatar

Forkers

stalinkay

wip's Issues

wip quietly

Might be nice to provide quieter sound effects so they're easier to leave on.

WIP with Options

@bitjson Hi, thanks for this cool tool. I think you take it a step further by making it possible to use it with flags.

I currently use this in a bump-version script:
git commit -m "chore: Bump Version to 1.0.0"

Would be cool if I could use:

naenae -m "chore: Bump Version to 1.0.0"

You could also add flags for things like wip silently with commitizen etc. for use everytime you run the command without changing your global configuration. I think this will add value to your already cool CLI.

Alternative smilies

My shell doesn't support the images used by wip.

image

Would be great to have the option to use some ascii-art or similar instead, that works on all shells.

Allow naenae functionality to be reachable through `wip` entrypoint

So, us programmers (read I) am fairly bad at remembering obscure application names (or just names in general). wip is easy, first of all because I've used it for years, and second of all cause I use it all the time, however I keep having to find this repo to lookup what naenae is called which is somewhat counterproductive. I suggest allowing naenae to be invoked by a command-line switch (or similar) to wip. My best suggestion currently is something akin to wip done or maybe going with what is known to gitters wip commit is forwarded to naenae automatically.

sync-exec Insecure

According to nodesecurity.io there is a medium rated vulnerability in sync-exec that isn't patched. According to the advisory you should update the lowest version of node supported to 0.12.0 and use the native functionality instead of sync-exec.

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.