gitignorio-cli 0.1.0__py3-none-any.whl

gitignore_cli/data/templates/yii2.gitignore

@@ -0,0 +1,49 @@
+# Created by https://www.toptal.com/developers/gitignore/api/yii2
+# Edit at https://www.toptal.com/developers/gitignore?templates=yii2
+
+### Yii2 ###
+# yii console commands
+/yii
+/yii_test
+/yii_test.bat
+
+# phpstorm project files
+.idea
+
+# netbeans project files
+nbproject
+
+# zend studio for eclipse project files
+.buildpath
+.project
+.settings
+
+# windows thumbnail cache
+Thumbs.db
+
+# composer vendor dir
+/vendor
+
+# composer itself is not needed
+composer.phar
+
+# Mac DS_Store Files
+.DS_Store
+
+# phpunit itself is not needed
+phpunit.phar
+# local phpunit config
+/phpunit.xml
+
+# vagrant runtime
+/.vagrant
+
+# ignore generated files
+/frontend/web/index.php
+/frontend/web/index-test.php
+/frontend/web/robots.txt
+/backend/web/index.php
+/backend/web/index-test.php
+/backend/web/robots.txt
+
+# End of https://www.toptal.com/developers/gitignore/api/yii2

gitignore_cli/data/templates/zendframework.gitignore

@@ -0,0 +1,30 @@
+# Created by https://www.toptal.com/developers/gitignore/api/zendframework
+# Edit at https://www.toptal.com/developers/gitignore?templates=zendframework
+
+### ZendFramework ###
+# Composer files
+composer.phar
+vendor/
+
+# Local configs
+config/autoload/*.local.php
+
+# Binary gettext files
+*.mo
+
+# Data
+data/logs/
+data/cache/
+data/sessions/
+data/tmp/
+temp/
+
+#Doctrine 2
+data/DoctrineORMModule/Proxy/
+data/DoctrineORMModule/cache/
+
+# Legacy ZF1
+demos/
+extras/documentation
+
+# End of https://www.toptal.com/developers/gitignore/api/zendframework

gitignore_cli/data/templates/zephir.gitignore

@@ -0,0 +1,32 @@
+# Created by https://www.toptal.com/developers/gitignore/api/zephir
+# Edit at https://www.toptal.com/developers/gitignore?templates=zephir
+
+### Zephir ###
+# Cache files, generates by Zephir
+.temp/
+.libs/
+
+# Object files, generates by linker
+*.lo
+*.la
+*.o
+*.loT
+
+# Files generated by configure and Zephir,
+# not required for extension compilation.
+ext/build/
+ext/modules/
+ext/Makefile*
+ext/config*
+ext/acinclude.m4
+ext/aclocal.m4
+ext/autom4te*
+ext/install-sh
+ext/ltmain.sh
+ext/missing
+ext/mkinstalldirs
+ext/run-tests.php
+ext/.deps
+ext/libtool
+
+# End of https://www.toptal.com/developers/gitignore/api/zephir

gitignore_cli/data/templates/zig.gitignore

@@ -0,0 +1,13 @@
+# Created by https://www.toptal.com/developers/gitignore/api/zig
+# Edit at https://www.toptal.com/developers/gitignore?templates=zig
+
+### zig ###
+# Zig programming language
+
+zig-cache/
+zig-out/
+build/
+build-*/
+docgen_tmp/
+
+# End of https://www.toptal.com/developers/gitignore/api/zig

gitignore_cli/data/templates/zsh.gitignore

@@ -0,0 +1,40 @@
+# Created by https://www.toptal.com/developers/gitignore/api/zsh
+# Edit at https://www.toptal.com/developers/gitignore?templates=zsh
+
+### Zsh ###
+# Zsh compiled script + zrecompile backup
+*.zwc
+*.zwc.old
+
+# Zsh completion-optimization dumpfile
+*zcompdump*
+
+# Zsh history
+.zsh_history
+
+# Zsh sessions
+.zsh_sessions
+
+# Zsh zcalc history
+.zcalc_history
+
+# A popular plugin manager's files
+._zinit
+.zinit_lstupd
+
+# zdharma/zshelldoc tool's files
+zsdoc/data
+
+# robbyrussell/oh-my-zsh/plugins/per-directory-history plugin's files
+# (when set-up to store the history in the local directory)
+.directory_history
+
+# MichaelAquilina/zsh-autoswitch-virtualenv plugin's files
+# (for Zsh plugins using Python)
+.venv
+
+# Zunit tests' output
+/tests/_output/*
+!/tests/_output/.gitkeep
+
+# End of https://www.toptal.com/developers/gitignore/api/zsh

gitignore_cli/data/templates/zukencr8000.gitignore

@@ -0,0 +1,82 @@
+# Created by https://www.toptal.com/developers/gitignore/api/zukencr8000
+# Edit at https://www.toptal.com/developers/gitignore?templates=zukencr8000
+
+### ZukenCR8000 ###
+## Zuken Global
+
+# log files
+*.log
+
+
+## Schematic
+
+# Schematic lock / edit in progress files
+*.s_t
+
+# Schematic Sheet backups
+*.shtb
+*.shtq
+
+# Schematic Design backups
+*undo.dsgn_
+
+# Schematic ERC/DRC results
+**/*template.cir/drc*
+
+# Schematic Frame
+**/*template.cir/frame*
+
+# Schematic log
+**/*template.cir/log*
+
+# Schematic exported netlist readme
+**/*template.cir/ext/readme.txt
+
+
+## Schematic <-> Layout communication
+
+# forward annotation files:
+*.coh
+*.loh
+*.coe
+
+
+## Layout
+
+# Layout Backups
+*.dsgn.bk
+
+# Layout Lockfiles
+*.dsgn.lk
+
+# Layout .crdb folder
+**/.crdb/
+
+# Layout .df_cache folder
+**/.df_cache/
+
+# Layout Automatic backup folders
+**/*dsgn.autobk/
+
+# Layout DRC result folder
+**/*.chk/
+
+# Layout Parameter file folders
+**/*.dsgn.prm/
+
+# Layout Signal Integrity result folders
+**/*.si/
+
+# Layout Power Integrity / EMI result folders
+**/*.emc/
+
+
+## DFM
+
+# DFM backups
+*.mdgn.bk
+
+# DFM lockfiles
+*.mdgn.lk
+
+# End of https://www.toptal.com/developers/gitignore/api/zukencr8000

gitignore_cli/deps.py

@@ -0,0 +1,106 @@
+from __future__ import annotations
+
+import os
+import shutil
+import subprocess
+import sys
+from pathlib import Path
+
+
+def extended_env() -> dict[str, str]:
+    env = os.environ.copy()
+    extra_paths: list[str] = []
+    home = Path.home()
+    for candidate in (
+        home / ".rbenv" / "shims",
+        home / ".local" / "bin",
+        home / ".gem" / "bin",
+        Path("/opt/homebrew/bin"),
+        Path("/usr/local/bin"),
+    ):
+        if candidate.is_dir():
+            extra_paths.append(str(candidate))
+    if extra_paths:
+        env["PATH"] = os.pathsep.join(extra_paths + [env.get("PATH", "")])
+    return env
+
+
+def _run(cmd: list[str], *, timeout: int = 300) -> None:
+    print(f"Running: {' '.join(cmd)}")
+    subprocess.run(cmd, check=True, env=extended_env(), timeout=timeout)
+
+
+def _linguist_commands(args: list[str]) -> list[list[str]]:
+    commands = [
+        ["github-linguist", *args],
+        ["bash", "-lc", f"github-linguist {' '.join(args)}"],
+    ]
+    if shutil.which("rbenv"):
+        commands.insert(0, ["bash", "-lc", f"RBENV_VERSION=3.4.5 github-linguist {' '.join(args)}"])
+    return commands
+
+
+def _linguist_available() -> bool:
+    for cmd in _linguist_commands(["--version"]):
+        result = subprocess.run(
+            cmd,
+            capture_output=True,
+            text=True,
+            env=extended_env(),
+            timeout=30,
+        )
+        if result.returncode == 0:
+            return True
+    return False
+
+
+def ensure_github_linguist() -> None:
+    if _linguist_available():
+        return
+
+    if not shutil.which("gem"):
+        raise RuntimeError(
+            "github-linguist is not installed and Ruby gem is unavailable. "
+            "Install Ruby, then run: gem install github-linguist"
+        )
+
+    _run(["gem", "install", "github-linguist"], timeout=600)
+    if not _linguist_available():
+        raise RuntimeError(
+            "Installed github-linguist, but it is still unavailable in PATH. "
+            "Ensure your Ruby shims are on PATH, then retry."
+        )
+
+
+def ensure_pipx() -> None:
+    if shutil.which("pipx"):
+        return
+
+    if sys.platform == "darwin" and shutil.which("brew"):
+        _run(["brew", "install", "pipx"])
+        _run(["pipx", "ensurepath"])
+        return
+
+    python = shutil.which("python3") or shutil.which("python")
+    if not python:
+        raise RuntimeError(
+            "pipx is not installed. Install pipx first, for example:\n"
+            "  brew install pipx && pipx ensurepath   # macOS\n"
+            "  python3 -m pip install --user pipx && python3 -m pipx ensurepath"
+        )
+
+    _run([python, "-m", "pip", "install", "--user", "pipx"])
+    _run([python, "-m", "pipx", "ensurepath"])
+
+
+def ensure_magika() -> None:
+    if shutil.which("magika"):
+        return
+
+    ensure_pipx()
+    _run(["pipx", "install", "magika"], timeout=600)
+
+
+def ensure_detection_tools() -> None:
+    ensure_github_linguist()
+    ensure_magika()

gitignore_cli/detect.py

@@ -0,0 +1,247 @@
+from __future__ import annotations
+
+import json
+import re
+import subprocess
+from pathlib import Path
+
+from gitignore_cli.deps import _linguist_commands, extended_env
+from gitignore_cli.ignored_dirs import dir_name_is_ignored, path_is_ignored
+from gitignore_cli.mapping import SKIP_MAGIKA_LABELS, resolve_template
+from gitignore_cli.templates import TemplateStore
+
+EXTENSION_MAP: dict[str, str] = {
+    ".c": "c",
+    ".cc": "c++",
+    ".cpp": "c++",
+    ".cs": "csharp",
+    ".dart": "dart",
+    ".el": "emacs",
+    ".ex": "elixir",
+    ".exs": "elixir",
+    ".go": "go",
+    ".gradle": "gradle",
+    ".hs": "haskell",
+    ".java": "java",
+    ".jl": "julia",
+    ".js": "node",
+    ".jsx": "react",
+    ".kt": "kotlin",
+    ".less": "less",
+    ".lua": "lua",
+    ".m": "objective-c",
+    ".mm": "objective-c",
+    ".php": "composer",
+    ".pl": "perl",
+    ".py": "python",
+    ".r": "r",
+    ".rb": "ruby",
+    ".rs": "rust",
+    ".sass": "sass",
+    ".scala": "scala",
+    ".scss": "sass",
+    ".sql": "database",
+    ".svelte": "svelte",
+    ".swift": "swift",
+    ".ts": "node",
+    ".tsx": "react",
+    ".vue": "vue",
+    ".zig": "zig",
+}
+
+SPECIAL_FILES: dict[str, str] = {
+    "Cargo.toml": "rust",
+    "Gemfile": "ruby",
+    "go.mod": "go",
+    "package.json": "node",
+    "Pipfile": "python",
+    "pyproject.toml": "python",
+    "requirements.txt": "python",
+}
+
+_MAGIKA_BATCH_SIZE = 500
+
+
+def _walk_repo_files(repo_path: Path) -> list[Path]:
+    files: list[Path] = []
+
+    def walk(directory: Path) -> None:
+        try:
+            entries = list(directory.iterdir())
+        except OSError:
+            return
+        for entry in entries:
+            if dir_name_is_ignored(entry.name):
+                continue
+            if entry.is_file():
+                files.append(entry)
+            elif entry.is_dir():
+                walk(entry)
+
+    walk(repo_path)
+    return files
+
+
+def detect_os_template() -> str:
+    import sys
+
+    if sys.platform == "darwin":
+        return "macos"
+    if sys.platform.startswith("linux"):
+        return "linux"
+    if sys.platform in {"win32", "cygwin"}:
+        return "windows"
+    return "linux"
+
+
+def _parse_linguist_breakdown(output: str, store: TemplateStore) -> set[str]:
+    templates: set[str] = set()
+    for line in output.splitlines():
+        match = re.match(r"^\s*[\d.]+%\s+\d+\s+(.+?)\s*$", line)
+        if not match:
+            continue
+        language = match.group(1).strip()
+        if language.lower() in {"markdown", "text", "json", "yaml", "xml", "csv"}:
+            continue
+        resolved = resolve_template(language, store.available)
+        if resolved:
+            templates.add(resolved)
+    return templates
+
+
+def _parse_magika_json(output: str, store: TemplateStore) -> set[str]:
+    templates: set[str] = set()
+    try:
+        entries = json.loads(output)
+    except json.JSONDecodeError:
+        return templates
+
+    if not isinstance(entries, list):
+        return templates
+
+    for entry in entries:
+        path = entry.get("path", "")
+        if path_is_ignored(path):
+            continue
+
+        result = entry.get("result", {})
+        if result.get("status") != "ok":
+            continue
+
+        label = result.get("value", {}).get("output", {}).get("label", "")
+        if not label or label in SKIP_MAGIKA_LABELS:
+            continue
+
+        resolved = resolve_template(label, store.available)
+        if not resolved:
+            resolved = resolve_template(label.replace("_", " "), store.available)
+        if resolved:
+            templates.add(resolved)
+
+    return templates
+
+
+def _detect_from_extensions(repo_path: Path, store: TemplateStore) -> set[str]:
+    templates: set[str] = set()
+    for path in _walk_repo_files(repo_path):
+
+        special = SPECIAL_FILES.get(path.name)
+        if special:
+            resolved = resolve_template(special, store.available)
+            if resolved:
+                templates.add(resolved)
+
+        suffix = path.suffix.lower()
+        mapped = EXTENSION_MAP.get(suffix)
+        if not mapped:
+            continue
+        resolved = resolve_template(mapped, store.available)
+        if resolved:
+            templates.add(resolved)
+    return templates
+
+
+def _has_extension(repo_path: Path, suffix: str) -> bool:
+    suffix = suffix.lower()
+    return any(path.suffix.lower() == suffix for path in _walk_repo_files(repo_path))
+
+
+def _refine_detected(repo_path: Path, detected: set[str]) -> set[str]:
+    refined = set(detected)
+    if "python" in refined and "lua" in refined and not _has_extension(repo_path, ".lua"):
+        refined.discard("lua")
+    return refined
+
+
+def _run_magika(repo_path: Path) -> str | None:
+    files = _walk_repo_files(repo_path)
+    if not files:
+        return "[]"
+
+    combined: list[dict] = []
+    for start in range(0, len(files), _MAGIKA_BATCH_SIZE):
+        batch = files[start : start + _MAGIKA_BATCH_SIZE]
+        result = subprocess.run(
+            ["magika", "--json", *[str(path) for path in batch]],
+            capture_output=True,
+            text=True,
+            check=False,
+            env=extended_env(),
+            timeout=300,
+        )
+        if result.returncode != 0:
+            return None
+        try:
+            entries = json.loads(result.stdout)
+        except json.JSONDecodeError:
+            return None
+        if isinstance(entries, list):
+            combined.extend(entries)
+
+    return json.dumps(combined)
+
+
+def _run_linguist(repo_path: Path) -> subprocess.CompletedProcess[str]:
+    last_result: subprocess.CompletedProcess[str] | None = None
+    for cmd in _linguist_commands(["--breakdown"]):
+        result = subprocess.run(
+            cmd,
+            cwd=repo_path,
+            capture_output=True,
+            text=True,
+            check=False,
+            env=extended_env(),
+            timeout=120,
+        )
+        last_result = result
+        if result.returncode == 0:
+            return result
+    assert last_result is not None
+    return last_result
+
+
+def detect_languages(repo_path: Path, store: TemplateStore) -> set[str]:
+    repo_path = repo_path.resolve()
+    detected = _detect_from_extensions(repo_path, store)
+
+    linguist = _run_linguist(repo_path)
+    if linguist.returncode == 0:
+        detected |= _parse_linguist_breakdown(linguist.stdout, store)
+
+    magika_output = _run_magika(repo_path)
+    if magika_output is not None:
+        detected |= _parse_magika_json(magika_output, store)
+
+    detected = _refine_detected(repo_path, detected)
+    detected.discard(detect_os_template())
+    return detected
+
+
+def normalize_user_template(name: str, store: TemplateStore) -> str:
+    resolved = resolve_template(name, store.available)
+    if not resolved:
+        raise ValueError(
+            f"Unknown gitignore template '{name}'. "
+            "Run `gi list` or see https://www.toptal.com/developers/gitignore/api/list"
+        )
+    return resolved