gign 0.0.3 → 0.3.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Antonio Carlos
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -1,45 +1,175 @@
-# GIGN
-
-[![NPM Version](https://img.shields.io/npm/v/gign.svg)](https://npmjs.org/package/gign)
-[![NPM Downloads](https://img.shields.io/npm/dm/gign.svg)](https://npmjs.org/package/gign)
-[![GitHub issues](https://img.shields.io/github/issues/juninmd/gign.svg)](https://github.com/juninmd/gign/issues)
-[![GitHub forks](https://img.shields.io/github/forks/juninmd/gign.svg)](https://github.com/juninmd/gign/network)
-
-```
-  ________.__               
- /  _____/|__| ____   ____  
-/   \  ___|  |/ ___\ /    \ 
-\    \_\  \  / /_/  >   |  \
- \______  /__\___  /|___|  /
-        \/  /_____/      \/ 
-
-```
-- `gign` generate a automatic `.gitignore` file for your project.
-
-## Requisites
-- Node 8 `for(Await/Async)`
-
-## How to Install?
-```bash
-$ yarn global add gign
-```
- 
-## How to use?
- 
-```bash
-$ gign <path>
-```
-
-## Thanks
-We use the gitignore.io api  
-http://gitignore.io/
-
-## Beta Suport
-* Windows, Linux and Mac
-* Node JS
-* Typescript
-
-## Help Gign
-You can help to improve the tool!  
-Include one new pattern on `pattern.json` or `manual.json`  
-I will wait for your P.R. ;D
+<div align="center">
+
+```
+  ________.__
+ /  _____/|__| ____   ____
+/   \  ___|  |/ ___\ /    \
+\    \_\  \  / /_/  >   |  \
+ \______  /__\___  /|___|  /
+        \/  /_____/      \/
+```
+
+# gign
+
+### ⚡ Gerador inteligente, offline e automático de `.gitignore` para qualquer projeto
+
+[![npm version](https://img.shields.io/npm/v/gign.svg?style=flat-square&color=cb3837&logo=npm)](https://www.npmjs.com/package/gign)
+[![npm downloads](https://img.shields.io/npm/dm/gign.svg?style=flat-square&color=blue)](https://www.npmjs.com/package/gign)
+[![GitHub release](https://img.shields.io/github/v/release/juninmd/gign?style=flat-square&color=success)](https://github.com/juninmd/gign/releases)
+[![Node.js](https://img.shields.io/badge/node-%3E%3D20-brightgreen.svg?style=flat-square&logo=node.js)](https://nodejs.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg?style=flat-square)](LICENSE)
+[![codecov](https://img.shields.io/codecov/c/github/juninmd/gign/master?style=flat-square&logo=codecov)](https://codecov.io/gh/juninmd/gign)
+
+<p>
+  <a href="#-recursos">Recursos</a> •
+  <a href="#-instalação">Instalação</a> •
+  <a href="#-uso">Uso</a> •
+  <a href="#-como-funciona">Como funciona</a> •
+  <a href="#-stacks-suportadas">Stacks</a> •
+  <a href="#-automação--deploy">Deploy</a> •
+  <a href="#-desenvolvimento">Desenvolvimento</a> •
+  <a href="#-licença">Licença</a>
+</p>
+
+</div>
+
+---
+
+## 💡 O que é o gign?
+
+O **gign** inspeciona a estrutura do seu projeto, detecta o sistema operacional e todas as linguagens, frameworks e ferramentas em uso (Node.js, TypeScript, Python, Docker, Rust, Go, VS Code, JetBrains, e muito mais) e gera um `.gitignore` sob medida, **deduplicado** e **100% offline**, sem chamadas a APIs externas.
+
+Inspirado pelo clássico [gitignore.io](https://www.toptal.com/developers/gitignore), mas totalmente autocontido.
+
+---
+
+## ✨ Recursos
+
+|     | Recurso                         | Descrição                                                                                                                   |
+| --- | ------------------------------- | --------------------------------------------------------------------------------------------------------------------------- |
+| 🚀  | **Offline e instantâneo**       | Templates oficiais de [`github/gitignore`](https://github.com/github/gitignore) embutidos no pacote. Zero chamadas de rede. |
+| 🔍  | **Detecção automática**         | Mapeia arquivos de configuração, lockfiles e diretórios para identificar tecnologias.                                       |
+| 🖥️  | **Sensível ao sistema**         | Inclui automaticamente as regras do SO atual (`.DS_Store`, `Thumbs.db`, etc.).                                              |
+| 🧹  | **Deduplicação inteligente**    | Mescla múltiplos templates sem repetir regras.                                                                              |
+| 📦  | **Sem dependências em runtime** | Distribuído como um único bundle minificado via `esbuild`.                                                                  |
+| 🔐  | **Proveniência npm**            | Publicação com assinatura criptográfica via OIDC no GitHub Actions.                                                         |
+
+---
+
+## 🚀 Instalação
+
+### Execução direta (sem instalar)
+
+```bash
+npx gign .
+```
+
+### Instalação global
+
+```bash
+npm install -g gign     # npm
+pnpm add -g gign        # pnpm
+yarn global add gign    # yarn
+bun add -g gign         # bun
+```
+
+---
+
+## 📖 Uso
+
+```bash
+# No diretório atual
+gign .
+
+# Em um diretório específico
+gign ./meu-projeto
+```
+
+Exemplo de saída:
+
+```text
+[gign] generated at /workspace/meu-projeto/.gitignore
+[gign] tags: macos,node,react,typescript,visualstudiocode
+[gign] manual tags: jest,prettier,typescript,vite
+```
+
+O arquivo gerado já vem organizado por seções, pronto para ser versionado. ✅
+
+---
+
+## 🧠 Como funciona
+
+```mermaid
+flowchart LR
+    A["📁 Projeto"] --> B["🔎 Scanner de padrões"]
+    B --> C["🧩 Tags & SO"]
+    C --> D["⚡ Deduplicação + regras"]
+    D --> E["📄 .gitignore"]
+```
+
+1. **Varredura:** analisa arquivos-chave como `package.json`, `Cargo.toml`, `go.mod` e `requirements.txt`.
+2. **Resolução de tags:** identifica o SO host e cruza arquivos e extensões com `pattern.json` e `manual.json`.
+3. **Composição:** carrega os templates de `src/data/templates.json`, adiciona as regras manuais e remove duplicatas linha a linha.
+4. **Gravação:** salva o `.gitignore` final no diretório alvo.
+
+---
+
+## 🛠️ Stacks suportadas
+
+Mais de **250 ecossistemas** são suportados nativamente.
+
+<details>
+<summary><b>Ver as principais tecnologias detectadas</b></summary>
+
+<br>
+
+- **Linguagens:** TypeScript, JavaScript, Python, Go, Rust, Java, Kotlin, C/C++, C#, Ruby, PHP, Swift, Dart, Elixir, Scala, Lua, Zig
+- **Frontend & meta-frameworks:** React, Next.js, Vue, Nuxt, Svelte, SvelteKit, Astro, Remix, Angular, Vite, Gatsby
+- **Backend & runtimes:** Node.js, Bun, Deno, NestJS, Express, Fastify, Django, Flask, FastAPI, Laravel, Spring Boot
+- **Infraestrutura & DevOps:** Docker, Kubernetes, Terraform, Helm, Serverless, AWS CDK, Pulumi, Cloudflare Workers
+- **IDEs & editores:** Visual Studio Code, JetBrains (IntelliJ, WebStorm, PyCharm, CLion, Rider, GoLand), Xcode, Sublime Text, Vim
+- **Testes & qualidade:** Jest, Vitest, Playwright, Cypress, ESLint, Prettier, Biome, Ruff, Coverage
+
+</details>
+
+---
+
+## 🔄 Automação & deploy
+
+Entregas totalmente automatizadas:
+
+- **Conventional Commits:** `feat:`, `fix:`, `perf:` e `BREAKING CHANGE` definem o bump de versão (minor, patch ou major).
+- **semantic-release:** analisa os commits, calcula a próxima versão e gera tags e notas de release, sem aprovação manual.
+- **Publicação no npm:** a cada push em `master`, o GitHub Actions valida testes e lint, compila o bundle e publica no [npm](https://www.npmjs.com/package/gign) com **proveniência**.
+
+---
+
+## 💻 Desenvolvimento
+
+```bash
+git clone https://github.com/juninmd/gign.git
+cd gign
+npm ci
+
+npm test                  # suíte de testes (Jest)
+npm run test:coverage     # testes com cobertura
+npm run lint              # ESLint
+npm run format            # Prettier (escrita)
+npm run format:check      # Prettier (checagem)
+npm run build             # bundle de produção em dist/
+npm run sync:templates    # atualiza templates a partir de github/gitignore
+```
+
+Veja [CONTRIBUTING.md](CONTRIBUTING.md) para as diretrizes de contribuição.
+
+---
+
+## 📄 Licença
+
+Distribuído sob a licença [MIT](LICENSE).
+
+<div align="center">
+
+Feito com ☕ por [Antonio Carlos](https://github.com/juninmd)
+
+</div>