sendok 0.1.0__tar.gz
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.
- sendok-0.1.0/PKG-INFO +109 -0
- sendok-0.1.0/README.md +94 -0
- sendok-0.1.0/README_es.md +94 -0
- sendok-0.1.0/README_id.md +94 -0
- sendok-0.1.0/README_ja.md +94 -0
- sendok-0.1.0/README_zh.md +94 -0
- sendok-0.1.0/docs/angular.md +70 -0
- sendok-0.1.0/docs/git.md +112 -0
- sendok-0.1.0/docs/node.md +75 -0
- sendok-0.1.0/docs/nvm.md +45 -0
- sendok-0.1.0/docs/ssh.md +57 -0
- sendok-0.1.0/git_gui.py +804 -0
- sendok-0.1.0/pyproject.toml +41 -0
- sendok-0.1.0/src/sendok/__init__.py +2 -0
- sendok-0.1.0/src/sendok/__main__.py +4 -0
- sendok-0.1.0/src/sendok/git_gui.py +955 -0
- sendok-0.1.0/src/sendok/main.py +632 -0
- sendok-0.1.0/src/sendok/templates/en/angular.md +70 -0
- sendok-0.1.0/src/sendok/templates/en/gh.md +91 -0
- sendok-0.1.0/src/sendok/templates/en/git.md +112 -0
- sendok-0.1.0/src/sendok/templates/en/node.md +75 -0
- sendok-0.1.0/src/sendok/templates/en/nvm.md +45 -0
- sendok-0.1.0/src/sendok/templates/en/ssh.md +57 -0
- sendok-0.1.0/src/sendok/templates/es/angular.md +7 -0
- sendok-0.1.0/src/sendok/templates/es/gh.md +7 -0
- sendok-0.1.0/src/sendok/templates/es/git.md +13 -0
- sendok-0.1.0/src/sendok/templates/es/node.md +8 -0
- sendok-0.1.0/src/sendok/templates/es/nvm.md +7 -0
- sendok-0.1.0/src/sendok/templates/es/ssh.md +17 -0
- sendok-0.1.0/src/sendok/templates/id/angular.md +70 -0
- sendok-0.1.0/src/sendok/templates/id/gh.md +91 -0
- sendok-0.1.0/src/sendok/templates/id/git.md +112 -0
- sendok-0.1.0/src/sendok/templates/id/node.md +75 -0
- sendok-0.1.0/src/sendok/templates/id/nvm.md +45 -0
- sendok-0.1.0/src/sendok/templates/id/ssh.md +57 -0
- sendok-0.1.0/src/sendok/templates/ja/angular.md +7 -0
- sendok-0.1.0/src/sendok/templates/ja/gh.md +7 -0
- sendok-0.1.0/src/sendok/templates/ja/git.md +13 -0
- sendok-0.1.0/src/sendok/templates/ja/node.md +8 -0
- sendok-0.1.0/src/sendok/templates/ja/nvm.md +7 -0
- sendok-0.1.0/src/sendok/templates/ja/ssh.md +17 -0
- sendok-0.1.0/src/sendok/templates/zh/angular.md +7 -0
- sendok-0.1.0/src/sendok/templates/zh/gh.md +7 -0
- sendok-0.1.0/src/sendok/templates/zh/git.md +13 -0
- sendok-0.1.0/src/sendok/templates/zh/node.md +8 -0
- sendok-0.1.0/src/sendok/templates/zh/nvm.md +7 -0
- sendok-0.1.0/src/sendok/templates/zh/ssh.md +17 -0
sendok-0.1.0/PKG-INFO
ADDED
|
@@ -0,0 +1,109 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: sendok
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: Scaffolding Engine for Nimble Documentation Organizer Kit: Generator folder dokumentasi proyek yang simpel dan cepat.
|
|
5
|
+
Author-email: Hasan Askari <marhaendev@gmail.com>
|
|
6
|
+
Classifier: License :: OSI Approved :: MIT License
|
|
7
|
+
Classifier: Operating System :: OS Independent
|
|
8
|
+
Classifier: Programming Language :: Python :: 3
|
|
9
|
+
Requires-Python: >=3.7
|
|
10
|
+
Requires-Dist: click
|
|
11
|
+
Requires-Dist: prompt-toolkit
|
|
12
|
+
Requires-Dist: questionary
|
|
13
|
+
Requires-Dist: rich
|
|
14
|
+
Description-Content-Type: text/markdown
|
|
15
|
+
|
|
16
|
+
# sendok 🥄
|
|
17
|
+
|
|
18
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) is a simple and fast development tool to manage project documentation and speed up your terminal workflow.
|
|
19
|
+
|
|
20
|
+
[🇮🇩 Bahasa Indonesia](README_id.md) | [🇪🇸 Español](README_es.md) | [🇯🇵 日本語](README_ja.md) | [🇨🇳 中文](README_zh.md)
|
|
21
|
+
|
|
22
|
+
---
|
|
23
|
+
|
|
24
|
+
## ✨ Key Features
|
|
25
|
+
|
|
26
|
+
- **🚀 Instant Documentation**: Initialize `docs/` folder with standard templates (SSH, Git, Node, NVM, Angular, GitHub CLI).
|
|
27
|
+
- **🌐 Multi-language Support**: Templates available in 5 languages (EN, ID, ES, JA, ZH).
|
|
28
|
+
- **🍴 Git Helper (gg)**: Manage Git interactively! Supports auto-init, staging (unstage/discard), and automatic fix for *dubious ownership* errors.
|
|
29
|
+
- **🛡️ Backup Manager (bum)**: Smartly backup your project. Ignores heavy folders (`node_modules`) while keeping sensitive files (`.env`).
|
|
30
|
+
- **⚡ Global Shorthands**: One-letter commands for common tasks (Reload, Clear screen, IP Info, etc).
|
|
31
|
+
- **🎨 Interactive Interface**: User-friendly menu powered by `questionary`.
|
|
32
|
+
|
|
33
|
+
---
|
|
34
|
+
|
|
35
|
+
## 🛠️ Installation
|
|
36
|
+
|
|
37
|
+
### From Source (Recommended for Global Shorthands)
|
|
38
|
+
1. Clone this repository.
|
|
39
|
+
2. Enter the project folder.
|
|
40
|
+
3. Run the following command:
|
|
41
|
+
```bash
|
|
42
|
+
pip install -e .
|
|
43
|
+
```
|
|
44
|
+
|
|
45
|
+
---
|
|
46
|
+
|
|
47
|
+
## 🚀 Usage Guide
|
|
48
|
+
|
|
49
|
+
### 1. Interactive Menu
|
|
50
|
+
Run the tool with your preferred language to open the navigation menu:
|
|
51
|
+
- **`sendok en`** : Menu in English (Default).
|
|
52
|
+
- **`sendok id`** : Menu in Indonesian.
|
|
53
|
+
- **`sendok es`** : Menu in Spanish.
|
|
54
|
+
- **`sendok ja`** : Menu in Japanese.
|
|
55
|
+
- **`sendok zh`** : Menu in Chinese.
|
|
56
|
+
|
|
57
|
+
### 2. Global Shorthands (Direct in Terminal)
|
|
58
|
+
After installation, you can use these commands directly from your terminal:
|
|
59
|
+
|
|
60
|
+
| Command | Function |
|
|
61
|
+
| :--- | :--- |
|
|
62
|
+
| **`r`** | Refresh terminal & VS Code UI |
|
|
63
|
+
| **`gg`** | Run Git GUI Helper (Interactive) |
|
|
64
|
+
| **`c`** | Clear terminal screen (`cls` or `clear`) |
|
|
65
|
+
| **`p`** | Show IP information (`ipconfig` or `ifconfig`) |
|
|
66
|
+
| **`bum`** | Run Backup Manager for the current folder |
|
|
67
|
+
| **`lll`** | Run `npm run build` |
|
|
68
|
+
| **`bum`** | Run Backup Manager for the current folder |
|
|
69
|
+
|
|
70
|
+
### 3. Git Helper (`gg`) Features
|
|
71
|
+
Use the **`gg`** command for easier Git management without memorizing terminal commands:
|
|
72
|
+
|
|
73
|
+
| Menu Action | Git Command Equivalent | Description |
|
|
74
|
+
| :--- | :--- | :--- |
|
|
75
|
+
| **Auto-Init** | `git init` | Automatically creates a repo if not found. |
|
|
76
|
+
| **Staging** | `git add` | Add files to the commit queue. |
|
|
77
|
+
| **Unstage** | `git reset` | Remove files from the queue (safe). |
|
|
78
|
+
| **Discard** | `git restore` | Discard edits & reset file (be careful!). |
|
|
79
|
+
| **Commit** | `git commit` | Record changes permanently. |
|
|
80
|
+
| **Push/Pull** | `git push/pull` | Sync with server (GitLab/GitHub). |
|
|
81
|
+
| **Branch** | `git branch` | Manage coding branches. |
|
|
82
|
+
| **Remove Git** | `rd /s /q .git` | Restore folder to normal (delete Git). |
|
|
83
|
+
| **Auto-Fix** | `git config ...` | Automatically fix *dubious ownership* errors. |
|
|
84
|
+
|
|
85
|
+
### 4. Standard Subcommands
|
|
86
|
+
- **`sendok init [id|en|es|ja|zh]`**: Create documentation folder.
|
|
87
|
+
- **`sendok reload`**: Refresh terminal and VS Code UI.
|
|
88
|
+
- **`sendok list`**: View available documentation templates.
|
|
89
|
+
- **`sendok clean`**: Delete `docs/` folder.
|
|
90
|
+
- **`sendok about`**: Show application developer information.
|
|
91
|
+
|
|
92
|
+
---
|
|
93
|
+
|
|
94
|
+
## 🛡️ Backup Manager (bum)
|
|
95
|
+
|
|
96
|
+
The `bum` feature creates a timestamped backup folder at `.bum/[project_folder]-[date]-[time]`.
|
|
97
|
+
This process automatically ignores:
|
|
98
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
99
|
+
- `dist`, `build`, `__pycache__`
|
|
100
|
+
- The `.bum` folder itself (to avoid recursion)
|
|
101
|
+
|
|
102
|
+
---
|
|
103
|
+
|
|
104
|
+
## 👤 Author
|
|
105
|
+
- **Hasan Askari** (marhaendev)
|
|
106
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
107
|
+
- **Email**: marhaendev@gmail.com
|
|
108
|
+
|
|
109
|
+
🥄 *Simple. Fast. Spooning documents like a pro!*
|
sendok-0.1.0/README.md
ADDED
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# sendok 🥄
|
|
2
|
+
|
|
3
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) is a simple and fast development tool to manage project documentation and speed up your terminal workflow.
|
|
4
|
+
|
|
5
|
+
[🇮🇩 Bahasa Indonesia](README_id.md) | [🇪🇸 Español](README_es.md) | [🇯🇵 日本語](README_ja.md) | [🇨🇳 中文](README_zh.md)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ Key Features
|
|
10
|
+
|
|
11
|
+
- **🚀 Instant Documentation**: Initialize `docs/` folder with standard templates (SSH, Git, Node, NVM, Angular, GitHub CLI).
|
|
12
|
+
- **🌐 Multi-language Support**: Templates available in 5 languages (EN, ID, ES, JA, ZH).
|
|
13
|
+
- **🍴 Git Helper (gg)**: Manage Git interactively! Supports auto-init, staging (unstage/discard), and automatic fix for *dubious ownership* errors.
|
|
14
|
+
- **🛡️ Backup Manager (bum)**: Smartly backup your project. Ignores heavy folders (`node_modules`) while keeping sensitive files (`.env`).
|
|
15
|
+
- **⚡ Global Shorthands**: One-letter commands for common tasks (Reload, Clear screen, IP Info, etc).
|
|
16
|
+
- **🎨 Interactive Interface**: User-friendly menu powered by `questionary`.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ Installation
|
|
21
|
+
|
|
22
|
+
### From Source (Recommended for Global Shorthands)
|
|
23
|
+
1. Clone this repository.
|
|
24
|
+
2. Enter the project folder.
|
|
25
|
+
3. Run the following command:
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🚀 Usage Guide
|
|
33
|
+
|
|
34
|
+
### 1. Interactive Menu
|
|
35
|
+
Run the tool with your preferred language to open the navigation menu:
|
|
36
|
+
- **`sendok en`** : Menu in English (Default).
|
|
37
|
+
- **`sendok id`** : Menu in Indonesian.
|
|
38
|
+
- **`sendok es`** : Menu in Spanish.
|
|
39
|
+
- **`sendok ja`** : Menu in Japanese.
|
|
40
|
+
- **`sendok zh`** : Menu in Chinese.
|
|
41
|
+
|
|
42
|
+
### 2. Global Shorthands (Direct in Terminal)
|
|
43
|
+
After installation, you can use these commands directly from your terminal:
|
|
44
|
+
|
|
45
|
+
| Command | Function |
|
|
46
|
+
| :--- | :--- |
|
|
47
|
+
| **`r`** | Refresh terminal & VS Code UI |
|
|
48
|
+
| **`gg`** | Run Git GUI Helper (Interactive) |
|
|
49
|
+
| **`c`** | Clear terminal screen (`cls` or `clear`) |
|
|
50
|
+
| **`p`** | Show IP information (`ipconfig` or `ifconfig`) |
|
|
51
|
+
| **`bum`** | Run Backup Manager for the current folder |
|
|
52
|
+
| **`lll`** | Run `npm run build` |
|
|
53
|
+
| **`bum`** | Run Backup Manager for the current folder |
|
|
54
|
+
|
|
55
|
+
### 3. Git Helper (`gg`) Features
|
|
56
|
+
Use the **`gg`** command for easier Git management without memorizing terminal commands:
|
|
57
|
+
|
|
58
|
+
| Menu Action | Git Command Equivalent | Description |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **Auto-Init** | `git init` | Automatically creates a repo if not found. |
|
|
61
|
+
| **Staging** | `git add` | Add files to the commit queue. |
|
|
62
|
+
| **Unstage** | `git reset` | Remove files from the queue (safe). |
|
|
63
|
+
| **Discard** | `git restore` | Discard edits & reset file (be careful!). |
|
|
64
|
+
| **Commit** | `git commit` | Record changes permanently. |
|
|
65
|
+
| **Push/Pull** | `git push/pull` | Sync with server (GitLab/GitHub). |
|
|
66
|
+
| **Branch** | `git branch` | Manage coding branches. |
|
|
67
|
+
| **Remove Git** | `rd /s /q .git` | Restore folder to normal (delete Git). |
|
|
68
|
+
| **Auto-Fix** | `git config ...` | Automatically fix *dubious ownership* errors. |
|
|
69
|
+
|
|
70
|
+
### 4. Standard Subcommands
|
|
71
|
+
- **`sendok init [id|en|es|ja|zh]`**: Create documentation folder.
|
|
72
|
+
- **`sendok reload`**: Refresh terminal and VS Code UI.
|
|
73
|
+
- **`sendok list`**: View available documentation templates.
|
|
74
|
+
- **`sendok clean`**: Delete `docs/` folder.
|
|
75
|
+
- **`sendok about`**: Show application developer information.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ Backup Manager (bum)
|
|
80
|
+
|
|
81
|
+
The `bum` feature creates a timestamped backup folder at `.bum/[project_folder]-[date]-[time]`.
|
|
82
|
+
This process automatically ignores:
|
|
83
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
84
|
+
- `dist`, `build`, `__pycache__`
|
|
85
|
+
- The `.bum` folder itself (to avoid recursion)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 👤 Author
|
|
90
|
+
- **Hasan Askari** (marhaendev)
|
|
91
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
92
|
+
- **Email**: marhaendev@gmail.com
|
|
93
|
+
|
|
94
|
+
🥄 *Simple. Fast. Spooning documents like a pro!*
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# sendok 🥄
|
|
2
|
+
|
|
3
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) es una herramienta de desarrollo simple y rápida para gestionar la documentación de proyectos y acelerar tu flujo de trabajo en la terminal.
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇮🇩 Bahasa Indonesia](README_id.md) | [🇯🇵 日本語](README_ja.md) | [🇨🇳 中文](README_zh.md)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ Características Principales
|
|
10
|
+
|
|
11
|
+
- **🚀 Documentación Instantánea**: Inicializa la carpeta `docs/` con plantillas estándar (SSH, Git, Node, NVM, Angular, GitHub CLI).
|
|
12
|
+
- **🌐 Soporte Multi-idioma**: Plantillas en 5 idiomas (EN, ID, ES, JA, ZH).
|
|
13
|
+
- **🍴 Git Helper (gg)**: ¡Gestiona Git de forma interactiva! Soporta auto-init, staging (unstage/discard) y reparación automática de errores de *dubious ownership*.
|
|
14
|
+
- **🛡️ Administrador de Respaldos (bum)**: Respalda tu proyecto de manera inteligente. Ignora carpetas pesadas (`node_modules`) manteniendo archivos sensibles (`.env`).
|
|
15
|
+
- **⚡ Atajos Globales (Shorthands)**: Comandos de una sola letra para tareas comunes (Reload, Limpiar pantalla, Info de IP, etc.).
|
|
16
|
+
- **🎨 Interfaz Interactiva**: Menú fácil de usar impulsado por `questionary`.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ Instalación
|
|
21
|
+
|
|
22
|
+
### Desde el Código Fuente (Recomendado para Atajos Globales)
|
|
23
|
+
1. Clona este repositorio.
|
|
24
|
+
2. Ingresa a la carpeta del proyecto.
|
|
25
|
+
3. Ejecuta el siguiente comando:
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🚀 Guía de Uso
|
|
33
|
+
|
|
34
|
+
### 1. Menú Interactivo
|
|
35
|
+
Ejecuta la herramienta con tu idioma preferido para abrir el menú de navegación:
|
|
36
|
+
- **`sendok es`** : Menú en Español.
|
|
37
|
+
- **`sendok en`** : Menú en Inglés.
|
|
38
|
+
- **`sendok id`** : Menú en Indonesio.
|
|
39
|
+
- **`sendok ja`** : Menú en Japonés.
|
|
40
|
+
- **`sendok zh`** : Menú en Chino.
|
|
41
|
+
|
|
42
|
+
### 2. Atajos Globales (Directo en la Terminal)
|
|
43
|
+
Después de la instalación, puedes usar estos comandos directamente desde tu terminal:
|
|
44
|
+
|
|
45
|
+
| Comando | Función |
|
|
46
|
+
| :--- | :--- |
|
|
47
|
+
| **`r`** | Refrescar terminal y VS Code |
|
|
48
|
+
| **`gg`** | Ejecutar Git GUI Helper (Interactivo) |
|
|
49
|
+
| **`c`** | Limpiar la pantalla de la terminal (`cls` o `clear`) |
|
|
50
|
+
| **`p`** | Mostrar información de IP (`ipconfig` o `ifconfig`) |
|
|
51
|
+
| **`bum`** | Ejecutar el Administrador de Respaldos para la carpeta actual |
|
|
52
|
+
| **`lll`** | Ejecutar `npm run build` |
|
|
53
|
+
| **`bum`** | Ejecutar el Administrador de Respaldos para la carpeta actual |
|
|
54
|
+
|
|
55
|
+
### 3. Características de Git Helper (`gg`)
|
|
56
|
+
Usa el comando **`gg`** para una gestión de Git más sencilla sin memorizar comandos de la terminal:
|
|
57
|
+
|
|
58
|
+
| Acción del Menú | Equivalente de Comando Git | Descripción |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **Auto-Init** | `git init` | Crea automáticamente un repo si no se encuentra. |
|
|
61
|
+
| **Staging** | `git add` | Añadir archivos a la cola de commit. |
|
|
62
|
+
| **Unstage** | `git reset` | Quitar archivos de la cola (seguro). |
|
|
63
|
+
| **Discard** | `git restore` | Descartar ediciones y resetear archivo (¡cuidado!). |
|
|
64
|
+
| **Commit** | `git commit` | Registrar cambios de forma permanente. |
|
|
65
|
+
| **Push/Pull** | `git push/pull` | Sincronizar con el servidor (GitLab/GitHub). |
|
|
66
|
+
| **Branch** | `git branch` | Gestionar ramas de código. |
|
|
67
|
+
| **Remove Git** | `rd /s /q .git` | Restaurar carpeta a la normalidad (borrar Git). |
|
|
68
|
+
| **Auto-Fix** | `git config ...` | Corregir automáticamente errores de *dubious ownership*. |
|
|
69
|
+
|
|
70
|
+
### 4. Subcomandos Estándar
|
|
71
|
+
- **`sendok init [id|en|es|ja|zh]`**: Crear la carpeta de documentación.
|
|
72
|
+
- **`sendok reload`**: Refrescar terminal y la interfaz de VS Code.
|
|
73
|
+
- **`sendok list`**: Ver la lista de plantillas disponibles.
|
|
74
|
+
- **`sendok clean`**: Eliminar la carpeta `docs/`.
|
|
75
|
+
- **`sendok about`**: Mostrar información del desarrollador de la aplicación.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ Administrador de Respaldos (bum)
|
|
80
|
+
|
|
81
|
+
La función `bum` crea una carpeta de respaldo con marca de tiempo en `.bum/[carpeta_del_proyecto]-[fecha]-[hora]`.
|
|
82
|
+
Este proceso ignora automáticamente:
|
|
83
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
84
|
+
- `dist`, `build`, `__pycache__`
|
|
85
|
+
- La carpeta `.bum` en sí misma (para evitar recursividad)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 👤 Autor
|
|
90
|
+
- **Hasan Askari** (marhaendev)
|
|
91
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
92
|
+
- **Correo electrónico**: marhaendev@gmail.com
|
|
93
|
+
|
|
94
|
+
🥄 *¡Simple. Rápido. Documentando como un profesional!*
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# sendok 🥄
|
|
2
|
+
|
|
3
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) adalah alat bantu pengembangan yang simpel dan cepat untuk mengelola dokumentasi proyek serta mempercepat alur kerja terminal Anda.
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇪🇸 Español](README_es.md) | [🇯🇵 日本語](README_ja.md) | [🇨🇳 中文](README_zh.md)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ Fitur Utama
|
|
10
|
+
|
|
11
|
+
- **🚀 Dokumentasi Instan**: Inisialisasi folder `docs/` dengan template standar (SSH, Git, Node, NVM, Angular, GitHub CLI).
|
|
12
|
+
- **🌐 Dukungan Multi-bahasa**: Template tersedia dalam 5 bahasa (EN, ID, ES, JA, ZH).
|
|
13
|
+
- **🍴 Git Helper (gg)**: Kelola Git secara interaktif! Mendukung auto-init, staging (unstage/discard), dan perbaikan otomatis error *dubious ownership*.
|
|
14
|
+
- **🛡️ Backup Manager (bum)**: Cadangkan proyek Anda secara cerdas. Mengabaikan folder berat (`node_modules`) namun tetap menyertakan file penting (`.env`).
|
|
15
|
+
- **⚡ Pintasan Global (Shorthands)**: Perintah satu huruf untuk tugas umum (Reload, Clear screen, IP Info, dll).
|
|
16
|
+
- **🎨 Antarmuka Interaktif**: Menu yang ramah pengguna menggunakan `questionary`.
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ Instalasi
|
|
21
|
+
|
|
22
|
+
### Dari Source (Rekomendasi untuk Pintasan Global)
|
|
23
|
+
1. Clone repositori ini.
|
|
24
|
+
2. Masuk ke folder proyek.
|
|
25
|
+
3. Jalankan perintah:
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🚀 Panduan Penggunaan
|
|
33
|
+
|
|
34
|
+
### 1. Menu Interaktif
|
|
35
|
+
Jalankan alat dengan bahasa pilihan Anda untuk membuka menu navigasi:
|
|
36
|
+
- **`sendok id`** : Menu dalam Bahasa Indonesia.
|
|
37
|
+
- **`sendok en`** : Menu dalam Bahasa Inggris.
|
|
38
|
+
- **`sendok es`** : Menu dalam Bahasa Spanyol.
|
|
39
|
+
- **`sendok ja`** : Menu dalam Bahasa Jepang.
|
|
40
|
+
- **`sendok zh`** : Menu dalam Bahasa Mandarin.
|
|
41
|
+
|
|
42
|
+
### 2. Pintasan Global (Langsung di Terminal)
|
|
43
|
+
Setelah instalasi, Anda dapat menggunakan perintah berikut dari mana saja tanpa prefix:
|
|
44
|
+
|
|
45
|
+
| Perintah | Fungsi |
|
|
46
|
+
| :--- | :--- |
|
|
47
|
+
| **`r`** | Menyegarkan terminal & tampilan VS Code |
|
|
48
|
+
| **`gg`** | Menjalankan Git GUI Helper (Interaktif) |
|
|
49
|
+
| **`c`** | Membersihkan layar terminal (`cls` atau `clear`) |
|
|
50
|
+
| **`p`** | Menampilkan informasi IP (`ipconfig` atau `ifconfig`) |
|
|
51
|
+
| **`bum`** | Menjalankan Backup Manager untuk folder saat ini |
|
|
52
|
+
| **`lll`** | Menjalankan `npm run build` |
|
|
53
|
+
| **`bum`** | Menjalankan Backup Manager untuk folder saat ini |
|
|
54
|
+
|
|
55
|
+
### 3. Fitur Git Helper (`gg`)
|
|
56
|
+
Gunakan perintah **`gg`** untuk manajemen Git yang lebih mudah tanpa perlu hafal perintah terminal:
|
|
57
|
+
|
|
58
|
+
| Aksi di Menu | Padanan Perintah Git | Deskripsi |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **Auto-Init** | `git init` | Otomatis membuat repo jika belum ada. |
|
|
61
|
+
| **Staging** | `git add` | Memasukkan file ke antrean commit. |
|
|
62
|
+
| **Unstage** | `git reset` | Mengeluarkan file dari antrean (aman). |
|
|
63
|
+
| **Discard** | `git restore` | Membuang editan & reset file (hati-hati!). |
|
|
64
|
+
| **Commit** | `git commit` | Mencatat perubahan secara permanen. |
|
|
65
|
+
| **Push/Pull** | `git push/pull` | Sinkronisasi dengan server (GitLab/GitHub). |
|
|
66
|
+
| **Branch** | `git branch` | Kelola cabang kodingan. |
|
|
67
|
+
| **Remove Git** | `rd /s /q .git` | Balikin folder jadi normal (hapus Git). |
|
|
68
|
+
| **Auto-Fix** | `git config ...` | Otomatis benerin error *dubious ownership*. |
|
|
69
|
+
|
|
70
|
+
### 4. Perintah Standar (Subcommands)
|
|
71
|
+
- **`sendok init [id|en|es|ja|zh]`**: Membuat folder dokumentasi.
|
|
72
|
+
- **`sendok reload`**: Menyegarkan terminal dan tampilan VS Code.
|
|
73
|
+
- **`sendok list`**: Melihat daftar template yang tersedia.
|
|
74
|
+
- **`sendok clean`**: Menghapus folder `docs/`.
|
|
75
|
+
- **`sendok about`**: Informasi pembuat aplikasi.
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ Backup Manager (bum)
|
|
80
|
+
|
|
81
|
+
Fitur `bum` akan membuat folder di `.bum/[folder_proyek]-[tanggal]-[jam]`.
|
|
82
|
+
Proses ini secara otomatis mengabaikan:
|
|
83
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
84
|
+
- `dist`, `build`, `__pycache__`
|
|
85
|
+
- Folder `.bum` itu sendiri (menghindari rekursif)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 👤 Pembuat
|
|
90
|
+
- **Hasan Askari** (marhaendev)
|
|
91
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
92
|
+
- **Email**: marhaendev@gmail.com
|
|
93
|
+
|
|
94
|
+
🥄 *Simpel. Cepat. Menyendok dokumen dengan mahir!*
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# sendok 🥄
|
|
2
|
+
|
|
3
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) は、プロジェクトのドキュメント作成を管理し、ターミナルのワークフローを高速化するための、シンプルで高速な開発ツールです。
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇮🇩 Bahasa Indonesia](README_id.md) | [🇪🇸 Español](README_es.md) | [🇨🇳 中文](README_zh.md)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ 主な機能
|
|
10
|
+
|
|
11
|
+
- **🚀 インスタントドキュメント**: 標準テンプレート(SSH、Git、Node、NVM、Angular、GitHub CLI)を使用して `docs/` フォルダを初期化します。
|
|
12
|
+
- **🌐 多言語サポート**: 5つの言語(EN、ID、ES、JA、ZH)のテンプレートが利用可能です。
|
|
13
|
+
- **🍴 Git Helper (gg)**: Git を対話的に管理!Auto-init、Staging (Unstage/Discard)、*dubious ownership* エラーの自動修復をサポートします。
|
|
14
|
+
- **🛡️ バックアップマネージャー (bum)**: プロジェクトをスマートにバックアップします。重いフォルダ (`node_modules`) を無視し、重要なファイル (`.env`) は保持します。
|
|
15
|
+
- **⚡ グローバルショートハンド**: 一般的なタスク用の1文字コマンド(Reload、画面クリア、IP情報など)。
|
|
16
|
+
- **🎨 インタラクティブインターフェース**: `questionary` を使用した使いやすいメニュー。
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ インストール
|
|
21
|
+
|
|
22
|
+
### ソースから(グローバルショートハンドに推奨)
|
|
23
|
+
1. このリポジトリをクローンします。
|
|
24
|
+
2. プロジェクトフォルダに入ります。
|
|
25
|
+
3. 次のコマンドを実行します:
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🚀 使用方法
|
|
33
|
+
|
|
34
|
+
### 1. インタラクティブメニュー
|
|
35
|
+
お好みの言語でツールを実行して、ナビゲーションメニューを開きます:
|
|
36
|
+
- **`sendok ja`** : 日本語メニュー。
|
|
37
|
+
- **`sendok en`** : 英語メニュー。
|
|
38
|
+
- **`sendok id`** : インドネシア語メニュー。
|
|
39
|
+
- **`sendok es`** : スペイン語メニュー。
|
|
40
|
+
- **`sendok zh`** : 中国語メニュー。
|
|
41
|
+
|
|
42
|
+
### 2. グローバルショートハンド(ターミナルで直接)
|
|
43
|
+
インストール後、ターミナルから直接これらのコマンドを使用できます:
|
|
44
|
+
|
|
45
|
+
| コマンド | 機能 |
|
|
46
|
+
| :--- | :--- |
|
|
47
|
+
| **`r`** | ターミナルと VS Code を更新 |
|
|
48
|
+
| **`gg`** | Git GUI ヘルパーを実行する (対話型) |
|
|
49
|
+
| **`c`** | ターミナル画面をクリア (`cls` または `clear`) |
|
|
50
|
+
| **`p`** | IP情報を表示 (`ipconfig` または `ifconfig`) |
|
|
51
|
+
| **`bum`** | 現在のフォルダに対してバックアップマネージャーを実行 |
|
|
52
|
+
| **`lll`** | `npm run build` を実行 |
|
|
53
|
+
| **`bum`** | 現在のフォルダに対してバックアップマネージャーを実行 |
|
|
54
|
+
|
|
55
|
+
### 3. Git Helper (`gg`) の機能
|
|
56
|
+
ターミナルコマンドを覚えなくても、**`gg`** コマンドで簡単に Git を管理できます:
|
|
57
|
+
|
|
58
|
+
| メニューアクション | 対応する Git コマンド | 説明 |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **Auto-Init** | `git init` | レポジトリがない場合に自動で作成します。 |
|
|
61
|
+
| **Staging** | `git add` | ファイルをコミット待ち状態に追加します。 |
|
|
62
|
+
| **Unstage** | `git reset` | ファイルを待ち状態から除外します(安全)。 |
|
|
63
|
+
| **Discard** | `git restore` | 編集を破棄してファイルをリセットします(注意!)。 |
|
|
64
|
+
| **Commit** | `git commit` | 変更を永続的に記録します。 |
|
|
65
|
+
| **Push/Pull** | `git push/pull` | サーバー(GitLab/GitHub)と同期します。 |
|
|
66
|
+
| **Branch** | `git branch` | コーディングのブランチを管理します。 |
|
|
67
|
+
| **Remove Git** | `rd /s /q .git` | フォルダを通常の状態に戻します(Gitを削除)。 |
|
|
68
|
+
| **Auto-Fix** | `git config ...` | *dubious ownership* エラーを自動で修復します。 |
|
|
69
|
+
|
|
70
|
+
### 4. 標準サブコマンド
|
|
71
|
+
- **`sendok init [id|en|es|ja|zh]`**: ドキュメントフォルダを作成。
|
|
72
|
+
- **`sendok reload`**: ターミナルと VS Code の UI を更新。
|
|
73
|
+
- **`sendok list`**: 利用可能なドキュメントテンプレートを表示。
|
|
74
|
+
- **`sendok clean`**: `docs/` フォルダを削除。
|
|
75
|
+
- **`sendok about`**: アプリ開発者の情報を表示。
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ バックアップマネージャー (bum)
|
|
80
|
+
|
|
81
|
+
`bum` 機能は、`.bum/[プロジェクトフォルダ]-[日付]-[時刻]` にタイムスタンプ付きのバックアップフォルダを作成します。
|
|
82
|
+
このプロセスは以下を自動的に無視します:
|
|
83
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
84
|
+
- `dist`, `build`, `__pycache__`
|
|
85
|
+
- `.bum` フォルダ自体(再帰を避けるため)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 👤 著者
|
|
90
|
+
- **Hasan Askari** (marhaendev)
|
|
91
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
92
|
+
- **メール**: marhaendev@gmail.com
|
|
93
|
+
|
|
94
|
+
🥄 *シンプル。スピーディ。プロのようにドキュメントを作成!*
|
|
@@ -0,0 +1,94 @@
|
|
|
1
|
+
# sendok 🥄
|
|
2
|
+
|
|
3
|
+
**sendok** (Scaffolding Engine for Nimble Documentation Organizer Kit) 是一个简单快捷的开发工具,用于管理项目文档并加快终端工作流。
|
|
4
|
+
|
|
5
|
+
[🇺🇸 English](README.md) | [🇮🇩 Bahasa Indonesia](README_id.md) | [🇪🇸 Español](README_es.md) | [🇯🇵 日本語](README_ja.md)
|
|
6
|
+
|
|
7
|
+
---
|
|
8
|
+
|
|
9
|
+
## ✨ 主要功能
|
|
10
|
+
|
|
11
|
+
- **🚀 即时文档**: 使用标准模板(SSH、Git、Node、NVM、Angular、GitHub CLI)初始化 `docs/` 文件夹。
|
|
12
|
+
- **🌐 多语言支持**: 支持 5 种语言(EN、ID、ES、JA、ZH)。
|
|
13
|
+
- **🍴 Git Helper (gg)**: 交互式管理 Git!支持 auto-init、staging (unstage/discard) 以及自动修复 *dubious ownership* 错误。
|
|
14
|
+
- **🛡️ 备份管理器 (bum)**: 一键智能备份项目。自动忽略庞大文件夹 (`node_modules`),同时保留敏感文件 (`.env`)。
|
|
15
|
+
- **⚡ 全局快捷命令 (Shorthands)**: 常用任务的单字母命令(Reload、清屏、IP 信息等)。
|
|
16
|
+
- **🎨 交互式界面**: 基于 `questionary` 的用户友好菜单。
|
|
17
|
+
|
|
18
|
+
---
|
|
19
|
+
|
|
20
|
+
## 🛠️ 安装
|
|
21
|
+
|
|
22
|
+
### 从源码安装(推荐用于全局快捷命令)
|
|
23
|
+
1. 克隆此仓库。
|
|
24
|
+
2. 进入项目文件夹。
|
|
25
|
+
3. 运行以下命令:
|
|
26
|
+
```bash
|
|
27
|
+
pip install -e .
|
|
28
|
+
```
|
|
29
|
+
|
|
30
|
+
---
|
|
31
|
+
|
|
32
|
+
## 🚀 使用指南
|
|
33
|
+
|
|
34
|
+
### 1. 交互式菜单
|
|
35
|
+
使用你偏好的语言运行工具以打开导航菜单:
|
|
36
|
+
- **`sendok zh`** : 中文菜单。
|
|
37
|
+
- **`sendok en`** : 英文菜单。
|
|
38
|
+
- **`sendok id`** : 印尼语菜单。
|
|
39
|
+
- **`sendok es`** : 西班牙语菜单。
|
|
40
|
+
- **`sendok ja`** : 日语菜单。
|
|
41
|
+
|
|
42
|
+
### 2. 全局快捷命令(直接在终端运行)
|
|
43
|
+
安装后,你可以直接从终端使用这些命令:
|
|
44
|
+
|
|
45
|
+
| 命令 | 功能 |
|
|
46
|
+
| :--- | :--- |
|
|
47
|
+
| **`r`** | 刷新终端和 VS Code |
|
|
48
|
+
| **`gg`** | 运行 Git GUI 助手 (交互式) |
|
|
49
|
+
| **`c`** | 清除终端屏幕 (`cls` 或 `clear`) |
|
|
50
|
+
| **`p`** | 显示 IP 信息 (`ipconfig` 或 `ifconfig`) |
|
|
51
|
+
| **`bum`** | 对当前文件夹运行备份管理器 |
|
|
52
|
+
| **`lll`** | 运行 `npm run build` |
|
|
53
|
+
| **`bum`** | 对当前文件夹运行备份管理器 |
|
|
54
|
+
|
|
55
|
+
### 3. Git Helper (`gg`) 功能详解
|
|
56
|
+
无需记忆终端命令,使用 **`gg`** 命令即可轻松管理 Git:
|
|
57
|
+
|
|
58
|
+
| 菜单操作 | 对应 Git 命令 | 描述 |
|
|
59
|
+
| :--- | :--- | :--- |
|
|
60
|
+
| **自动初始化** | `git init` | 如果未发现仓库,则自动创建。 |
|
|
61
|
+
| **暂存 (Staging)** | `git add` | 将文件添加到提交队列。 |
|
|
62
|
+
| **取消暂存** | `git reset` | 从队列中移除文件(安全)。 |
|
|
63
|
+
| **丢弃更改** | `git restore` | 丢弃所有修改并重置文件(小心使用!)。 |
|
|
64
|
+
| **提交 (Commit)** | `git commit` | 永久记录更改。 |
|
|
65
|
+
| **推送/拉取** | `git push/pull` | 与服务器(GitLab/GitHub)同步。 |
|
|
66
|
+
| **分支管理** | `git branch` | 管理代码分支。 |
|
|
67
|
+
| **移除 Git** | `rd /s /q .git` | 将文件夹复原(删除 Git 配置)。 |
|
|
68
|
+
| **自动修复** | `git config ...` | 自动修复 *dubious ownership* 安全错误。 |
|
|
69
|
+
|
|
70
|
+
### 4. 标准子命令
|
|
71
|
+
- **`sendok init [id|en|es|ja|zh]`**: 创建文档文件夹。
|
|
72
|
+
- **`sendok reload`**: 刷新终端和 VS Code 界面。
|
|
73
|
+
- **`sendok list`**: 查看可用文档模板列表。
|
|
74
|
+
- **`sendok clean`**: 删除 `docs/` 文件夹。
|
|
75
|
+
- **`sendok about`**: 显示应用开发人员信息。
|
|
76
|
+
|
|
77
|
+
---
|
|
78
|
+
|
|
79
|
+
## 🛡️ 备份管理器 (bum)
|
|
80
|
+
|
|
81
|
+
`bum` 功能会在 `.bum/[项目文件夹]-[日期]-[时间]` 创建一个带有时间戳的备份文件夹。
|
|
82
|
+
此过程会自动忽略:
|
|
83
|
+
- `node_modules`, `.git`, `venv`, `.venv`
|
|
84
|
+
- `dist`, `build`, `__pycache__`
|
|
85
|
+
- `.bum` 文件夹本身(避免递归)
|
|
86
|
+
|
|
87
|
+
---
|
|
88
|
+
|
|
89
|
+
## 👤 作者
|
|
90
|
+
- **Hasan Askari** (marhaendev)
|
|
91
|
+
- **Website**: [hasanaskari.com](https://hasanaskari.com)
|
|
92
|
+
- **电子邮件**: marhaendev@gmail.com
|
|
93
|
+
|
|
94
|
+
🥄 *简单。快速。像专业人士一样编写文档!*
|
|
@@ -0,0 +1,70 @@
|
|
|
1
|
+
# Panduan Angular CLI
|
|
2
|
+
|
|
3
|
+
Angular CLI (Command Line Interface) adalah alat untuk membuat, mengembangkan, dan memelihara aplikasi Angular langsung dari terminal.
|
|
4
|
+
|
|
5
|
+
---
|
|
6
|
+
|
|
7
|
+
## 1. Instalasi Angular CLI
|
|
8
|
+
Instal secara global agar perintah `ng` bisa digunakan di mana saja:
|
|
9
|
+
```powershell
|
|
10
|
+
npm install -g @angular/cli
|
|
11
|
+
```
|
|
12
|
+
Cek versi:
|
|
13
|
+
```powershell
|
|
14
|
+
ng version
|
|
15
|
+
```
|
|
16
|
+
|
|
17
|
+
## 2. Membuat Proyek Baru
|
|
18
|
+
```powershell
|
|
19
|
+
ng new nama-proyek-anda
|
|
20
|
+
```
|
|
21
|
+
*Tips: Pilih opsi CSS/SCSS dan Routing sesuai kebutuhan proyek.*
|
|
22
|
+
|
|
23
|
+
## 3. Menjalankan Aplikasi (Development)
|
|
24
|
+
```powershell
|
|
25
|
+
# Menjalankan server lokal (biasanya di localhost:4200)
|
|
26
|
+
ng serve
|
|
27
|
+
|
|
28
|
+
# Menjalankan dan otomatis membuka browser
|
|
29
|
+
ng serve -o
|
|
30
|
+
|
|
31
|
+
# Menjalankan di port berbeda
|
|
32
|
+
ng serve --port 5000
|
|
33
|
+
```
|
|
34
|
+
|
|
35
|
+
## 4. Generate (Membuat Komponen Baru)
|
|
36
|
+
Angular CLI sangat membantu dalam membuat struktur file yang rapi dan standar.
|
|
37
|
+
|
|
38
|
+
| Perintah | Singkatan | Deskripsi |
|
|
39
|
+
| :--- | :--- | :--- |
|
|
40
|
+
| `ng generate component` | `ng g c` | Membuat komponen baru (html, css, ts, spec). |
|
|
41
|
+
| `ng generate service` | `ng g s` | Membuat service untuk logika data. |
|
|
42
|
+
| `ng generate module` | `ng g m` | Membuat modul baru. |
|
|
43
|
+
| `ng generate interface` | `ng g i` | Membuat tipe data/interface. |
|
|
44
|
+
|
|
45
|
+
Contoh: `ng g c components/header`
|
|
46
|
+
|
|
47
|
+
## 5. Build untuk Produksi
|
|
48
|
+
Jika aplikasi sudah siap dideploy ke server:
|
|
49
|
+
```powershell
|
|
50
|
+
ng build --configuration production
|
|
51
|
+
```
|
|
52
|
+
Hasil build akan muncul di folder `/dist`.
|
|
53
|
+
|
|
54
|
+
## 6. Testing & Linting
|
|
55
|
+
```powershell
|
|
56
|
+
# Menjalankan unit test (Karma/Jasmine)
|
|
57
|
+
ng test
|
|
58
|
+
|
|
59
|
+
# Mengecek kualitas kode (linting)
|
|
60
|
+
ng lint
|
|
61
|
+
```
|
|
62
|
+
|
|
63
|
+
## 7. Tips Angular CLI
|
|
64
|
+
- **Dry Run**: Ingin tahu file apa saja yang akan dibuat tanpa benar-benar membuatnya? Gunakan flag `--dry-run`.
|
|
65
|
+
Contoh: `ng g c test-komponen --dry-run`
|
|
66
|
+
- **Inline Style/Template**: Jika komponen sangat sederhana, gunakan:
|
|
67
|
+
`ng g c simpel --inline-style --inline-template`
|
|
68
|
+
|
|
69
|
+
---
|
|
70
|
+
*Angular CLI memastikan standarisasi kode yang rapi untuk proyek skala besar.*
|