@fatsolutions/ganchos 1.0.5 → 1.1.2

package/README.md

@@ -0,0 +1,85 @@
+# @fatsolutions/ganchos
+
+Git Hook Manager for Polyglot Monorepos.
+
+## Installation
+
+```bash
+pnpm add -D @fatsolutions/ganchos
+```
+
+## Quick Setup
+
+Add your desired languages to `package.json`:
+
+```json
+{
+  "ganchos": {
+    "languages": ["typescript", "python", "cairo"]
+  }
+}
+```
+
+The hooks will be automatically installed on `pnpm install` via the postinstall bootstrap.
+
+## Manual Setup
+
+If you prefer manual control, skip the `ganchos` field in `package.json` and use the CLI:
+
+```bash
+# Enable languages
+pnpm ganchos enable typescript python cairo
+
+# Install the hooks
+pnpm ganchos install
+```
+
+## CLI Commands
+
+| Command | Description |
+|---------|-------------|
+| `ganchos install` | Install git hooks based on configuration |
+| `ganchos generate` | Generate hook content to stdout (for inspection) |
+| `ganchos list` | List configured and available languages |
+| `ganchos enable <languages...>` | Enable one or more languages |
+| `ganchos disable <languages...>` | Disable one or more languages |
+
+## Supported Languages
+
+- **javascript** - ESLint, Prettier
+- **typescript** - TypeScript compiler, ESLint, Prettier
+- **python** - Black, isort, flake8, mypy *(work in progress)*
+- **cairo** - scarb fmt, scarb lint
+
+## How It Works
+
+1. Configuration is stored in `.ganchos.json` (auto-generated, added to `.git/info/exclude`)
+2. Language-specific hook scripts are located in `hooks/pre-commit/`
+3. On commit, the pre-commit hook runs checks for all enabled languages on staged files
+4. Auto-fixable issues (formatting) are fixed automatically; you'll be prompted to review and commit again
+
+## Language-Specific Requirements
+
+### JavaScript/TypeScript
+- `eslint` and `prettier` available via `npx`
+
+### Python
+- Optional: `black`, `isort`, `flake8`, `mypy` installed in your environment
+
+### Cairo (Starknet)
+- `scarb` installed ([installation guide](https://docs.swmansion.com/scarb/))
+- `Scarb.toml` present in project root or package directories
+
+## Monorepo Support
+
+Ganchos detects `packages/` subdirectories and runs language tools from the appropriate project roots:
+- Looks for `package.json`, `tsconfig.json`, `pyproject.toml`, `Scarb.toml` in package directories
+- Falls back to root-level configuration when appropriate
+
+## Contributing
+
+Contributions are welcome! Feel free to open issues or submit pull requests.
+
+## License
+
+GPL-2.0

package/configs/cairo/Scarb.fmt.toml

@@ -0,0 +1,11 @@
+[package]
+name = "fmt_hook"
+version = "0.1.0"
+
+[tool.fmt]
+sort-module-level-items = true
+max-line-length = 100
+tab-size = 4
+breaking-behaviour = { tuple = "LineByLine", fixed_array = "SingleBreakPoint", macro_call = "SingleBreakPoint" }
+merge-use-items = true
+allow-duplicate-uses = false

package/configs/cairo/install.js

@@ -0,0 +1,7 @@
+export const dependencies = {};
+export const configFiles = [
+    "Scarb.fmt.toml",
+];
+export function getInstallCommand(_deps, _projectRoot) {
+    return "echo \"Installed cairo deps\"";
+}

package/configs/cairo/install.ts

@@ -0,0 +1,10 @@
+export const dependencies: Record<string, string> = {
+};
+
+export const configFiles: string[] = [
+  "Scarb.fmt.toml",
+];
+
+export function getInstallCommand(_deps: Record<string, string>, _projectRoot: string): string {
+  return "echo \"Installed cairo deps\""
+}

package/dist/types/index.d.ts

@@ -11,7 +11,7 @@ interface FatHooksConfig {
     version: string;
     languages: LanguageConfig[];
 }
-declare const SUPPORTED_LANGUAGES: readonly ["javascript", "typescript", "python"];
+declare const SUPPORTED_LANGUAGES: readonly ["javascript", "typescript", "python", "cairo"];
 type SupportedLanguage = (typeof SUPPORTED_LANGUAGES)[number];
 declare const DEFAULT_CONFIG: FatHooksConfig;
 

package/dist/types/index.js

@@ -1,10 +1,11 @@
-const SUPPORTED_LANGUAGES = ["javascript", "typescript", "python"];
+const SUPPORTED_LANGUAGES = ["javascript", "typescript", "python", "cairo"];
 const DEFAULT_CONFIG = {
   version: "1.0.0",
   languages: [
     { name: "javascript", enabled: false },
     { name: "typescript", enabled: false },
-    { name: "python", enabled: false }
+    { name: "python", enabled: false },
+    { name: "cairo", enabled: false }
   ]
 };
 export {

package/hooks/pre-commit/cairo.sh

@@ -0,0 +1,71 @@
+# Cairo pre-commit hook
+echo "Running Cairo checks..."
+
+SCARB_FMT_MANIFEST="Scarb.fmt.toml"
+
+# Check if scarb is installed
+if ! command -v scarb >/dev/null 2>&1; then
+    echo "Error: scarb is not installed. Please install it from https://docs.swmansion.com/scarb/"
+    exit 1
+fi
+
+# Check if there are any Cairo files to check
+CAIRO_FILES=$(git diff --cached --name-only --diff-filter=ACM | grep -E '\.cairo$' || true)
+if [ -n "$CAIRO_FILES" ]; then
+    echo "Checking Cairo files: $CAIRO_FILES"
+
+    # Get unique package directories from modified files
+    PACKAGES=$(echo "$CAIRO_FILES" | grep '^packages/' | cut -d'/' -f1-2 | sort -u || true)
+
+    # Check if we have root-level Cairo files
+    ROOT_CAIRO_FILES=$(echo "$CAIRO_FILES" | grep -v '^packages/' || true)
+
+    # Run scarb fmt per package directory (if they have Scarb.toml)
+    for package_dir in $PACKAGES; do
+        PACKAGE_CAIRO_FILES=$(echo "$CAIRO_FILES" | grep "^$package_dir/" || true)
+        if [ -n "$PACKAGE_CAIRO_FILES" ]; then
+            if [ -f "$package_dir/Scarb.toml" ]; then
+                # Get relative paths for files in this package
+                RELATIVE_FILES=$(echo "$PACKAGE_CAIRO_FILES" | sed "s|^$package_dir/||")
+
+                echo "  Running scarb fmt in $package_dir..."
+                (cd "$package_dir" && echo "$RELATIVE_FILES" | xargs scarb --manifest-path "$SCARB_FMT_MANIFEST" fmt) || {
+                    echo "scarb fmt failed in $package_dir. Please fix the issues before committing."
+                    exit 1
+                }
+
+                echo "  Running scarb lint in $package_dir..."
+                (cd "$package_dir" && scarb lint) || {
+                    echo "scarb lint failed in $package_dir. Run 'cd $package_dir && scarb lint --fix' to fix lint issues."
+                    exit 1
+                }
+            fi
+        fi
+    done
+
+    # Run scarb fmt and lint from root for root-level Cairo files (if Scarb.toml exists at root)
+    if [ -n "$ROOT_CAIRO_FILES" ] && [ -f "Scarb.toml" ]; then
+        echo "  Running scarb fmt in root..."
+        echo "$ROOT_CAIRO_FILES" | xargs scarb --manifest-path "$SCARB_FMT_MANIFEST" fmt || {
+            echo "scarb fmt failed. Please fix the issues before committing."
+            exit 1
+        }
+
+        echo "  Running scarb lint in root..."
+        scarb lint || {
+            echo "scarb lint failed. Run 'scarb lint --fix' to fix lint issues."
+            exit 1
+        }
+    fi
+
+    # Check if files were modified by auto-fix
+    MODIFIED=$(echo "$CAIRO_FILES" | xargs git diff --name-only)
+    if [ -n "$MODIFIED" ]; then
+        echo ""
+        echo "The following files were auto-fixed:"
+        echo "$MODIFIED" | sed 's/^/  /'
+        echo ""
+        echo "Please review the changes and commit again."
+        exit 1
+    fi
+fi

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@fatsolutions/ganchos",
-  "version": "1.0.5",
+  "version": "1.1.2",
   "description": "Git Hook Manager for Polyglot Monorepos, developed in house by FatSolutions",
   "type": "module",
   "main": "./dist/index.js",