gign 0.1.0

Gitignore generator
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84

<h1 align="center">Gign</h1>

<p align="center">
    <img width="200" src="assets/logo.png">
</p>

<h3 align="center">
    A Gitignore Generator
</h3>

## Table of Contents

- [Examples](#examples)
- [Install](#install)
- [Custom templates](#custom-templates)
- [Help](#help)

## Examples

```bash
gign default:Rust global:Linux > .gitignore

# make it less verbose
gign --auto c++ windows > .gitignore

# ignore all javascript related templates
gign $(ignore list javascript) default:Node > .gitignore

# search for template with fzf and use it
gign $(ignore list | fzf) > .gitignore
``` 

> see `gign list` to show all available templates

## Install

Using [Cargo](https://doc.rust-lang.org/cargo/getting-started/installation.html)

```
cargo install --git https://github.com/metafates/gign
```

## Custom templates

By default, templates are taken from [this repository](https://github.com/github/gitignore)

To add custom template just create `[name].gitignore`
file inside `gign where` directory.

Files inside folders will be prefixed with the parent folder name (except for the root templates).

For example, if you have `custom.gitignore` file inside `extras/` folder,
you can use it like this:

```
gign extras:custom
```

| Location                       | Name            |
|--------------------------------|-----------------|
| `custom.gitignore`             | `custom`        |
| `extras/custom.gitignore`      | `extras:custom` |
| `extras/misc/custom.gitignore` | `misc:custom`   |

## Help

```
USAGE:
    gign [OPTIONS] [template]... [SUBCOMMAND]

ARGS:
    <template>...    The templates to ignore

OPTIONS:
    -a, --auto       Automatically resolve unknown templates
    -h, --help       Print help information
    -V, --version    Print version information

SUBCOMMANDS:
    help      Print this message or the help of the given subcommand(s)
    list      List all available templates
    update    Update the default templates database
    where     Print the templates path
```