git2megaignore 0.4.0

Convert a .gitignore file to a .megaignore file
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
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142

# Gitignore to Megaignore converter

<p align="center">
  <a href="https://crates.io/crates/git2megaignore">
    <img src="https://img.shields.io/crates/v/git2megaignore" alt="crates.io version">
  </a>
  <a href="https://crates.io/crates/git2megaignore">
    <img src="https://img.shields.io/crates/d/git2megaignore" alt="crates.io downloads">
  <a href="https://github.com/Farfi55/git2megaignore/releases">
    <img src="https://img.shields.io/github/v/release/Farfi55/git2megaignore" alt="github release">
  </a>
  </a>
  <a href="https://github.com/Farfi55/git2megaignore/blob/main/LICENSE">
    <img src="https://img.shields.io/github/license/Farfi55/git2megaignore" alt="github license">
  </a>
  <a href="https://github.com/Farfi55/git2megaignore/stargazers">
    <img src="https://img.shields.io/github/stars/Farfi55/git2megaignore?style=flat" alt="github stars">
  </a>
</p>

This is a simple tool to convert a `.gitignore` file to a `.megaignore` file. The `.megaignore` file is used by the [Mega](https://mega.nz) cloud storage service to exclude files from being uploaded to the cloud much like the `.gitignore` file is used to exclude files from being tracked by git.

You can read more about the `.megaignore` file format [here](https://help.mega.io/installs-apps/desktop/megaignore).

The **changelog** is available [here](CHANGELOG.md).

## Installation

### Cargo

Make sure you have [Rust](https://www.rust-lang.org/tools/install) installed.

You can then install git2megaignore using cargo:

```sh
cargo install git2megaignore
```

### Precompiled binaries

If you don't have Rust installed, you can download precompiled binaries from the [releases page](https://github.com/Farfi55/git2megaignore/releases).

## Usage example

```sh<!--  -->
# go to a directory with a .gitignore file
$ cd example

# or create a new .gitignore file
$ echo "*.txt
foo/
/[Bb]uild/
src/**/index.js
\!src/index.js" > .gitignore

# convert the .gitignore file to a .megaignore file
$ git2megaignore -em
```

**resulting `.megaignore` file:**

```txt filename="example/.megaignore"
+sync:.megaignore
-nG:*.txt
-dnG:foo
-dpR:^[Bb]uild$
-pR:^src/(.*/)?index\.js$
+pG:src/index.js
```

- `sync:.megaignore` is a special rule that tells Mega to sync the `.megaignore` file itself, this was added with the `-m` option
- `+` prefix means that the rule is an **include rule**
- `-` prefix means that the rule is an **exclude rule**
- `n` option means that the rule should be applied to the **file name**, not the whole path
- `p` option means that the rule should be applied to the **path** of the file, not the file name
- `d` option means that the rule targets **directories only**, otherwise it targets everything
- `G` option means that the rule is a case-sensitive **glob** pattern
- `R` option means that the rule is a case-sensitive **regex** pattern
- for more information about the rule format, see the [Mega help page](https://help.mega.io/installs-apps/desktop/megaignore)

### Other usage examples

```sh
# take input from stdin and write to stdout
# -e, --no-extras  do not add extra header and footer lines
# -p, --print      print to stdout
# -v, --verbose <VERBOSE> set verbosity level (0-4)
$ echo "foo/**/bar" | git2megaignore -ep -v=0
-pR:^foo/(.*/)?bar$

# copy .gitignore lines when converting to .megaignore
# -c --copy copy .gitignore lines to the .megaignore file
$ echo "/[Ll]ibrary/" | git2megaignore -c -ep -v=0
# from /[Ll]ibrary/
-dpR:^[Ll]ibrary$

# run from other directory
# this will read the .gitignore file from the specified directory 
# and write the .megaignore file to the same directory
git2megaignore ~/path/to/repo

# specify input and output files explicitly
git2megaignore -i ../.gitignore -o /tmp/.megaignore
```

## Options

```txt
Convert a .gitignore file to a .megaignore file

Usage: git2megaignore [OPTIONS] [DIRECTORY]

Arguments:
  [DIRECTORY]  directory to start searching for .gitignore files [default: ]

Options:
  -m, --sync-megaignore    sync the .megaignore file with the +sync:.megaignore rule
  -c, --copy               If `true`, every .gitignore line will be copied to the .megaignore file as **a comment**
  -e, --no-extras          the header and footer will not be added to the .megaignore file
  -x, --force-regexp       Force the use of the Regex <STRATEGY> for all rules, even if the glob pattern does not require it
  -I, --ignore-case        .megaignore rules will be case insensitive
  -i, --input <FILE>       Input file to read .gitignore rules from, defaults to .gitignore in the current directory
  -o, --output <FILE>      Output file to write .megaignore rules to, defaults to .megaignore in the current directory
  -p, --print              print the generated .megaignore file to STDOUT
  -v, --verbose <VERBOSE>  Set the level of verbosity from 0 (off) to 4 (debug) [default: 2]
  -h, --help               Print help
  -V, --version            Print version
```

## Mass conversion

you can run the following bash script to convert all `.gitignore` files in the subdirectories of the current directory to `.megaignore` files:

```sh
find . -name .gitignore -execdir git2megaignore \;
```

for windows, you can use the following powershell script:

```powershell
Get-ChildItem -Recurse -Filter .gitignore | ForEach-Object { git2megaignore $_.DirectoryName }
```