fastapi-voyager 0.15.0__tar.gz → 0.15.1__tar.gz

fastapi_voyager-0.15.1/.githooks/README.md

@@ -0,0 +1,48 @@
+# Git Hooks Setup
+
+This repository uses Git hooks to automatically format code with Prettier before each commit.
+
+## One-time Setup
+
+After cloning the repository, run this command to enable the hooks:
+
+```bash
+git config core.hooksPath .githooks
+```
+
+That's it! The hooks will now run automatically before each commit.
+
+## What it does
+
+The `pre-commit` hook will:
+- Automatically run `npx prettier --write .` before each commit
+- Format all supported files (JS, CSS, HTML, JSON, Markdown)
+- Stage the formatted files automatically
+- Continue with the commit
+
+## Skip the hook (if needed)
+
+If you need to skip the formatting for a particular commit:
+
+```bash
+git commit --no-verify -m "your message"
+```
+
+## Troubleshooting
+
+### Hook not running?
+
+Check if the hooks path is set correctly:
+
+```bash
+git config core.hooksPath
+# Should output: .githooks
+```
+
+### npx not found?
+
+Make sure Node.js and npm are installed:
+```bash
+node --version
+npm --version
+```

fastapi_voyager-0.15.1/.githooks/pre-commit

@@ -0,0 +1,29 @@
+#!/bin/sh
+# Git pre-commit hook to run Prettier on staged files
+
+# Get the project root directory using Git command (works in all shells)
+PROJECT_ROOT="$(git rev-parse --show-toplevel)"
+cd "$PROJECT_ROOT" || exit 1
+
+# Check if npx is available
+if ! command -v npx >/dev/null 2>&1; then
+  echo "Warning: npx not found. Skipping Prettier formatting."
+  echo "Please install Node.js and npm to use pre-commit formatting."
+  exit 0
+fi
+
+echo "Running Prettier on staged files..."
+
+# Check if .prettierignore exists and run prettier
+if [ -f "$PROJECT_ROOT/.prettierignore" ]; then
+  echo "Found .prettierignore, applying rules..."
+  npx prettier --write . --log-level=warn --ignore-path="$PROJECT_ROOT/.prettierignore"
+else
+  echo "No .prettierignore found, formatting all files..."
+  npx prettier --write . --log-level=warn
+fi
+
+# Add any newly formatted files to the staging area
+git add .
+
+echo "Prettier formatting complete."

fastapi_voyager-0.15.1/.prettierignore

@@ -0,0 +1,33 @@
+# Dependencies
+node_modules/
+.venv/
+__pycache__/
+*.pyc
+
+# Build outputs
+dist/
+build/
+*.egg-info/
+
+# Static assets
+*.min.js
+*.min.css
+
+# Generated files
+package-lock.json
+yarn.lock
+pnpm-lock.yaml
+
+# Cache
+.ruff_cache/
+.pytest_cache/
+.vscode/
+
+# Git
+.git/
+.github/
+
+# Misc
+*.md
+.env
+.env.*

fastapi_voyager-0.15.1/.prettierrc

@@ -0,0 +1,11 @@
+{
+  "semi": false,
+  "singleQuote": false,
+  "tabWidth": 2,
+  "useTabs": false,
+  "trailingComma": "es5",
+  "printWidth": 100,
+  "arrowParens": "always",
+  "endOfLine": "lf",
+  "htmlWhitespaceSensitivity": "css"
+}

{fastapi_voyager-0.15.0 → fastapi_voyager-0.15.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fastapi-voyager
-Version: 0.15.0
+Version: 0.15.1
 Summary: Visualize FastAPI application's routing tree and dependencies
 Project-URL: Homepage, https://github.com/allmonday/fastapi-voyager
 Project-URL: Source, https://github.com/allmonday/fastapi-voyager
@@ -232,13 +232,25 @@ uv pip install ".[dev]"
 uvicorn tests.programatic:app  --reload
 ```
 
+### Setup Git Hooks (Optional)
+
+Enable automatic code formatting before commits:
+
+```shell
+./setup-hooks.sh
+# or manually:
+git config core.hooksPath .githooks
+```
+
+This will run Prettier automatically before each commit. See [`.githooks/README.md`](./.githooks/README.md) for details.
+
 open `localhost:8000/voyager`
 
 
-frontend: 
-- `src/web/vue-main.js`: main js
+frontend:
+- `src/fastapi_voyager/web/vue-main.js`: main js
 
-backend: 
+backend:
 - `voyager.py`: main entry
 - `render.py`: generate dot file
 - `server.py`: serve mode

{fastapi_voyager-0.15.0 → fastapi_voyager-0.15.1}/README.md

@@ -203,13 +203,25 @@ uv pip install ".[dev]"
 uvicorn tests.programatic:app  --reload
 ```
 
+### Setup Git Hooks (Optional)
+
+Enable automatic code formatting before commits:
+
+```shell
+./setup-hooks.sh
+# or manually:
+git config core.hooksPath .githooks
+```
+
+This will run Prettier automatically before each commit. See [`.githooks/README.md`](./.githooks/README.md) for details.
+
 open `localhost:8000/voyager`
 
 
-frontend: 
-- `src/web/vue-main.js`: main js
+frontend:
+- `src/fastapi_voyager/web/vue-main.js`: main js
 
-backend: 
+backend:
 - `voyager.py`: main entry
 - `render.py`: generate dot file
 - `server.py`: serve mode

{fastapi_voyager-0.15.0 → fastapi_voyager-0.15.1}/docs/changelog.md

@@ -156,6 +156,11 @@
 - 0.15.0
     - [x] refactor render.py
 - 0.15.1
+    - [x] add prettier (npx prettier --write .) and pre-commit hooks
+    - [x] add localstorage for toggle items
+    - [x] refactor er diagram renderer
+    - [x] fix error in search function
+- 0.15.2
     - [ ] add tests
     - [ ] left panel can be toggled.
     - [ ] refactor vue-main.js, move methods to store