Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/nikitaberezhnyj/gig
https://github.com/nikitaberezhnyj/gig
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/nikitaberezhnyj/gig
- Owner: NikitaBerezhnyj
- Created: 2024-07-17T14:53:04.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2024-09-09T18:20:17.000Z (2 months ago)
- Last Synced: 2024-09-09T22:42:34.841Z (2 months ago)
- Language: Rust
- Size: 65.4 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# GiG
GiG repository has [Ukrainian :ukraine:](#gig-ukraine) and [English :uk:](#gig-uk) localizations
## GiG :ukraine:
***GiG (.gitignore generator)*** - це утиліта командного рядка для спрощення створення примітивних .gitignore файлів. GiG дозволяє швидко генерувати файли .gitignore з попередньо визначеними правилами для різних мов програмування, фреймворків, інструментів розробки та операційних систем. Це допомагає розробникам легко створювати відповідні файли .gitignore для своїх проектів, не витрачаючи час на ручне написання правил.
### Особливості
- Підтримка широкого спектру мов програмування та технологій
- Автоматична оптимізація правил для уникнення дублювання
- Простий інтерфейс командного рядка
## Використання
```bash
gig [OPTION] [RULES]
```
#### Опції
- `-h`, `--help`: Показати довідку
- `-a`, `--add`: Додати нове правило до існуючого .gitignore файлу.
- `-r`, `--remove`: Видалити правило з існуючого .gitignore файлу.
#### Правила
Вкажіть одне або кілька правил для включення у файл .gitignore. Програма автоматично додасть відповідні записи у ваш .gitignore файл. Ось кілька прикладів використання:
***1. Створення .gitignore з популярними технологіями:***
```bash
gig react node vscode
```
Ця команда створить .gitignore файл з записами для React, Node.js та VS Code.
***2. Додавання нових правил до існуючого .gitignore файлу:***
```bash
gig --a renpy idea
```
або
```bash
gig --add renpy idea
```
Ця команда додасть правила для Ren'Py і IDE до вже існуючого .gitignore файлу.
***3. Видалення конкретних правил з .gitignore файлу:***
```bash
gig --r python django
```
або
```bash
gig --remove python django
```
Ця команда видалить правила для Python і Django з вашого .gitignore файлу.
### Підтримувані правила
GiG підтримує широкий спектр правил, включаючи:
- ***Мови програмування*** (C, C++, C#, Java, Go, Rust, Python, PHP, Ruby, Swift, Kotlin)
- ***Фреймворки*** (React, Angular, Vue, Node, Django, Tauri, Spring, Ruby on Rails, Laravel, Express, Flutter, Svelte, Next.js, Nuxt.js, Flask, ASP.NET, Electron)
- ***Ігрові двигуни*** (Unity, Unreal Engine, Godot, Ren'Py)
- ***Інструменти розробника*** (Docker, npm, pnpm, Yarn, Gradle, Maven, Webpack, Composer, pip)
- ***Системи керування базами даних*** (MySQL, MongoDB, SQLite, Firebase)
- ***Редактори коду та IDE*** (VS Code, IntelliJ IDEA, Visual Studio, Eclipse, Android Studio, Xcode, Sublime Text, Atom, Vim)
- ***Операційні системи*** (Windows, Linux, macOS)
- ***Інше*** (SCSS, Less, Jupyter, Terraform)
### Встановлення
1. Клонуйте репозиторій на свій ПК
```bash
git clone https://github.com/NikitaBerezhnyj/GiG.git
```
2. Перейдіть у теку
```bash
cd GiG
```
3. Запустіть команду на збірку
```bash
make install
```
___
## GiG :uk:
***GiG (.gitignore generator)*** is a command-line utility to simplify the creation of primitive .gitignore files. GiG allows you to quickly generate .gitignore files with predefined rules for different programming languages, frameworks, development tools, and operating systems. This helps developers easily create appropriate .gitignore files for their projects without wasting time manually writing rules.
### Features
- Supports a wide range of programming languages and technologies
- Automatic optimization of rules to avoid duplication
- Simple command line interface
## Usage
```bash
gig [OPTION] [RULES]
```
#### Options
- `-h`, `--help`: Show help
- `-a`, `--add`: Add a new rule to an existing .gitignore file.
- `-r`, `--remove`: Remove a rule from an existing .gitignore file.
#### Rules.
Specify one or more rules to include in the .gitignore file. The program will automatically add the corresponding entries to your .gitignore file. Here are some examples of usage:
***1. Create a .gitignore with popular technologies:***
```bash
gig react node vscode
```
This command will create a .gitignore file with entries for React, Node.js, and VS Code.
***2. Adding new rules to an existing .gitignore file:***
```bash
gig --a renpy idea
```
or
```bash
gig --add renpy idea
```
This command will add rules for Ren'Py and IDE to an existing .gitignore file.
***3. Removing specific rules from a .gitignore file:***
```bash
gig --r python django
```
or
```bash
gig --remove python django
```
This command will remove the rules for Python and Django from your .gitignore file.
### Supported rules
GiG supports a wide range of rules, including:
- ***Programming languages*** (C, C++, C#, Java, Go, Rust, Python, PHP, Ruby, Swift, Kotlin)
- ***Frameworks*** (React, Angular, Vue, Node, Django, Tauri, Spring, Ruby on Rails, Laravel, Express, Flutter, Svelte, Next.js, Nuxt.js, Flask, ASP.NET, Electron)
- ***Game engines*** (Unity, Unreal Engine, Godot, Ren'Py)
- ***Developer tools*** (Docker, npm, pnpm, Yarn, Gradle, Maven, Webpack, Composer, pip)
- ***Database management systems*** (MySQL, MongoDB, SQLite, Firebase)
- ***Code editors and IDEs*** (VS Code, IntelliJ IDEA, Visual Studio, Eclipse, Android Studio, Xcode, Sublime Text, Atom, Vim)
- ***Operating systems*** (Windows, Linux, macOS)
- ***Other*** (SCSS, Less, Jupyter, Terraform)
### Installation
1. Clone the repository to your PC
```bash
git clone https://github.com/NikitaBerezhnyj/GiG.git
```
2. Change to the folder
```bash
cd GiG
```
3. Run the command to build
```bash
make install
```