https://github.com/andrewaguiar/wip.vim
Fast and simple notes based on projects and git branches
https://github.com/andrewaguiar/wip.vim
notes-tool vim vim-plugin
Last synced: 9 months ago
JSON representation
Fast and simple notes based on projects and git branches
- Host: GitHub
- URL: https://github.com/andrewaguiar/wip.vim
- Owner: andrewaguiar
- Created: 2019-02-08T01:44:30.000Z (about 7 years ago)
- Default Branch: master
- Last Pushed: 2023-06-12T14:56:05.000Z (almost 3 years ago)
- Last Synced: 2025-04-05T06:29:06.103Z (about 1 year ago)
- Topics: notes-tool, vim, vim-plugin
- Language: Vim Script
- Size: 4.88 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# WIP (Fast and simple notes based on projects and git branches)
## Motivation
Sometimes working in a task I want to take notes about the code, about the task I am doing
itself and mark some files I am working on. Generally I simply created a WIP file in my
documents and always used that file. But as I started working on other branches and projects
this files usually became a mess. I started then separate this WIP files by projects and branches.
Wip does the same, but in a automated way, it gets your current project plus your current git branch
and creates a markdown file based in `CURRENT_PROJECT--at--CURRENT_BRANCH.md` in `$HOME/.wip` folder, like:
```
$HOME/.wip/project-name--at--branch.md
```
If you change projects or branches you don't need to worry about changing files for yourself, wip automatically
uses another files to it, so the only command you need to run to make your quick notes is `wip` =).
## Installing
```vim
call plug#begin()
Plug 'andrewaguiar/wip.vim'
call plug#end()
```
## Usage
Wip allows you create simple notes (markdown files) based on the project and the current branch
you are working on.
As long as you are inside a git repository you can run:
```shell
:WIP
```
Wip will create a text file (based on the "git current repo @ git current branch" md5) in `$HOME/.wip.vim` and open this file
using `vim`.
This way you can make quick notes, as you change to other projects or even branches wip will open new files,
so you don't need to remember where you stored your notes.
To remove the current WIP file from `$HOME/.wip.vim` use:
```vim
:WIPClean
```
To remove all WIP files from `$HOME/.wip.vim` use:
```vim
:WIPCleanAll
```