Lost Doctype

bench get-app https://github.com/rareMaxim/lost_doctype

[![Listed on Frappe Gems](https://frappegems.com/api/method/frappe_gems.seo.badge?app=rareMaxim%2Flost_doctype)](https://frappegems.com/gems/apps/rareMaxim/lost_doctype)

# Lost Doctype A [Frappe](https://frappeframework.com) app that maps your site structure and finds DocTypes that are **not accessible through the UI**. ## The Problem As a Frappe site grows with multiple installed apps, it becomes difficult to track which DocTypes are actually reachable through the interface. Many DocTypes exist in the database but are never exposed in any Workspace or Sidebar — making them effectively invisible to users. **Lost Doctype** answers the question: *"Which DocTypes can't I reach by clicking through the UI?"* ## Features - **Visual site map** — all installed apps → modules → DocTypes in one page - **Accessibility check** — marks each DocType as accessible or "lost" - **Path tracing** — for accessible DocTypes, shows exactly which Workspace, Shortcut, or Sidebar links to it - **Direct access** — click any DocType chip (accessible or lost) to open it directly - **Filters** — view all / lost only / accessible only - **Search** — find a specific DocType across all apps - **Translation-ready** — uses `.pot`/`.po`/`.mo` format, Ukrainian translation included ## What Is a "Lost" DocType? A DocType is considered **lost** if it does not appear as a link in any of the following: | Source | Description | |---|---| | `Workspace Link` | Left sidebar navigation in standard Frappe Workspaces | | `Workspace Shortcut` | Shortcut icons in Workspace content area | | `Workspace Sidebar Item` | Custom sidebar items (e.g. orange_inventory style) | Single DocTypes, Virtual DocTypes, and Custom DocTypes are all included in the analysis. ## Installation ```bash bench get-app https://github.com/rareMaxim/lost_doctype bench --site install-app lost_doctype bench --site migrate ``` ## Usage Navigate to `/app/ld-site-map` or search for **"Site Structure Map"** in the Frappe search bar. Click **Refresh** to load the current structure. The page shows: ``` ┌─ Summary ─────────────────────────────────────────────────────────┐ │ Site │ Apps │ With Icon │ Total DTs │ Accessible │ Lost │ └───────────────────────────────────────────────────────────────────┘ ┌─ frappe ─────────────────── 🖥 has icon ⚠ 87 lost 178 DTs ──┐ │ CORE 5 accessible / 7 lost │ │ [User ✓] [Role ✓] [DocType ✗] [Module ✗] │ └─────────────────────────────────────────────────────────────────┘ ``` - **Green chip** — DocType is accessible; click to see which Workspace links to it - **Red chip** — DocType is lost; click to open it directly anyway ### JSON Export The **LD Site Structure** Single DocType (`/app/ld-site-structure`) lets you generate and save the full structure as a JSON snapshot — useful for auditing or diffing over time. ## Compatibility | Frappe Version | Status | |---|---| | v17 | ✅ Tested | ## Translations Translation files are located in `lost_doctype/locale/`: ``` locale/ ├── main.pot # Template — extract strings with Babel ├── uk.po # Ukrainian translation └── uk.mo # Compiled binary (generate with msgfmt) ``` ## Contributing This app uses `pre-commit` for code formatting and linting. Please [install pre-commit](https://pre-commit.com/#installation) and enable it for this repository: ```bash cd apps/lost_doctype pre-commit install ``` Pre-commit is configured to use the following tools for checking and formatting your code: - ruff - eslint - prettier - pyupgrade ## License MIT