gign 0.0.3 → 0.2.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/README.md +68 -45
- package/dist/index.js +8612 -0
- package/dist/index.js.map +7 -0
- package/package.json +48 -7
- package/.vscode/launch.json +0 -17
- package/.vscode/settings.json +0 -3
- package/index.js +0 -9
- package/manual.json +0 -11
- package/pattern.json +0 -13
- package/src/actions/generateFile.js +0 -52
- package/src/util/download.js +0 -19
- package/src/util/os.js +0 -12
- package/src/util/project.js +0 -55
package/README.md
CHANGED
|
@@ -1,45 +1,68 @@
|
|
|
1
|
-
# GIGN
|
|
2
|
-
|
|
3
|
-
[](https://github.com/juninmd/gign/actions/workflows/ci.yml)
|
|
4
|
+
[](https://codecov.io/gh/juninmd/gign)
|
|
5
|
+
[](https://npmjs.org/package/gign)
|
|
6
|
+
[](https://npmjs.org/package/gign)
|
|
7
|
+
|
|
8
|
+
|
|
9
|
+
|
|
10
|
+
```
|
|
11
|
+
________.__
|
|
12
|
+
/ _____/|__| ____ ____
|
|
13
|
+
/ \ ___| |/ ___\ / \
|
|
14
|
+
\ \_\ \ / /_/ > | \
|
|
15
|
+
\______ /__\___ /|___| /
|
|
16
|
+
\/ /_____/ \/
|
|
17
|
+
```
|
|
18
|
+
|
|
19
|
+
> Gerador automático de arquivos `.gitignore` para seus projetos. Inspirado no [gitignore.io](https://www.toptal.com/developers/gitignore).
|
|
20
|
+
|
|
21
|
+
## 📝 Descrição
|
|
22
|
+
|
|
23
|
+
**GIGN** é uma ferramenta CLI que gera automaticamente arquivos `.gitignore` personalizados para seus projetos. Basta informar o diretório e as tecnologias desejadas.
|
|
24
|
+
|
|
25
|
+
## ✨ Funcionalidades
|
|
26
|
+
|
|
27
|
+
- Geração automática de `.gitignore`, 100% offline (templates embutidos, sem API externa)
|
|
28
|
+
- Remove regras duplicadas entre templates
|
|
29
|
+
- Publicação automática no npm a cada release
|
|
30
|
+
- Suporte a múltiplas linguagens e frameworks
|
|
31
|
+
- Interface CLI simples e rápida
|
|
32
|
+
- CI/CD com GitHub Actions
|
|
33
|
+
- Cobertura de testes com Codecov
|
|
34
|
+
|
|
35
|
+
## 🛠️ Tech Stack
|
|
36
|
+
|
|
37
|
+
- **Runtime:** Node.js
|
|
38
|
+
- **Linguagem:** TypeScript
|
|
39
|
+
- **Testes:** Jest
|
|
40
|
+
- **Linting:** ESLint
|
|
41
|
+
- **CI:** GitHub Actions
|
|
42
|
+
- **Cobertura:** Codecov
|
|
43
|
+
|
|
44
|
+
## 🚀 Instalação
|
|
45
|
+
|
|
46
|
+
```bash
|
|
47
|
+
# Via npm
|
|
48
|
+
npm install -g gign
|
|
49
|
+
|
|
50
|
+
# Via yarn
|
|
51
|
+
yarn global add gign
|
|
52
|
+
```
|
|
53
|
+
|
|
54
|
+
## 📖 Uso
|
|
55
|
+
|
|
56
|
+
```bash
|
|
57
|
+
gign <caminho>
|
|
58
|
+
```
|
|
59
|
+
|
|
60
|
+
O comando irá gerar um arquivo `.gitignore` personalizado no diretório especificado.
|
|
61
|
+
|
|
62
|
+
## ✅ Requisitos
|
|
63
|
+
|
|
64
|
+
- Node.js 8+ (para suporte a Async/Await)
|
|
65
|
+
|
|
66
|
+
## 📜 Licença
|
|
67
|
+
|
|
68
|
+
MIT
|