* feat: base content card component * fix: tooltips + colors * feat: fix orgs * feat: base content tab internals rewrite * feat: fix invalidmodal * feat: add ContentModpackCard * fix: extract types * draft: layout * feat: unlink modal * feat: impl content tab * fix: lint * fix: toggling * temp: disable updating stuff * feat: selection v-model * feat: bulk selection * feat: mods tab rough draft * feat: use fuse.js * feat: add project combobox * clean up project combobox * feat: start install to play modal * fix: events * feat: use v-on * feat: bulk actions + fix floating action bar width * feat: figma alignments * feat: migrate toggle to tailwind * fix: row borders * feat: disabled state * feat: virtual list impl for card table based on window scroll * fix: lint * feat: virtualization + smaller contentcard items * feat: use ContentCardTable + ContentCardItems * feat: fix gap + border issues on last elm * feat: cleanup + use proper searching * fix: use TeleportOverflowMenu * fix: fallback to svg if src is invalid on avatar component * fix: storybook * feat: start on updater modal * feat: finish content updater modal * feat: i18n pass * feat: impl modal * feat(app): backend changes for content tab refactor (#5237) * feat: include_changelog=false for updater modal * fix: hash overrides * feat: update checking for modpack * feat: qa * feat: modpack content modal * fix: padding in table to match modals + tightness * fix: lint * feat: delete modal * feat: fix toggle bugs * fix: prepr * fix: duplicate messages * qa: full width search * qa: use bg-surface-1.5 * qa: animation for filter pills * qa: standardize hover colors * fix: border-[1px] is border * qa: mass de-select actually mass selecting * qa: match figma designs for floating action bar * qa: modal fixes * q: modal fixes x2 * fix: table border * qa: confirm modals * qa: modal alignment * qa: re-add stuck heading + dedupe logic * qa: dedupe virtual scrolling + remove dead components * qa: responsiveness for content table + link fixes * qa: version column link, tooltips + lint fixes * qa: instance busy protections * fix: installation freeze bug * chore: remove old mods page * refactor: deduplicate layout * chore: delete old content page(s) * qa * qa * qa * feat: sort btn - to iterate * fix: ml * feat: date added * fix: lint * fix: formatting.ts removal * feat: get_dependencies_as_content_items * qa: final QA changes * refactor: deduplicate + polish content.rs * feat: hook up content.vue with v1 * feat: hide v1 content api behind frontend feature flag * fix: query keys + copy on empty state * chore: i18n pass * feat: reimpl unlink + upload endpoint * feat: use bulk endpoints v1 * fix: lint * fix: flags * fix: responsiveness via container queries * fix: lint * qa: 1 * qa: fixes * qa: fix ssr issues with browse content * qa: header page divider * qa: modals * fix: prepr * fix: issues * fix: lint * fix: toggle v1 ff * qa: 5 * qa: delete modal copy * feat: creation flow modals (#5383) * refactor: delete content v0 usages + impl * feat: qa + fixes * feat: installing banner using state event * feat: fix modpack card bugs + filtering issues * refactor: delete backups v0 api module * feat: v1 servers GET endpoint * fix: backups * feat: swap to kyros upload v1 addon * fix: use tanstack for loader.vue * feat: finish install from discovery modal * qa: bug fixes * feat: set up installation settings * fix: lint * fix: typos * fix: bugs * fix: disable inline content * feat: content tab improvements — upload UX, installation settings, and client-only indicators Upload cancellation and navigation guard: - Add ConfirmLeaveModal that prompts when navigating away during upload - Cancel in-flight XHR uploads when user confirms leaving the page - Add beforeunload handler to warn on browser/tab close during upload - Track uploadedBytes/totalBytes in UploadState for progress display - Replace Collapsible with Transition for upload progress admonition - Show byte progress and percentage in upload banner - Clamp upload progress to prevent exceeding 100% Installation settings (server.properties): - Add KnownPropertiesFields and PropertiesFields types to Archon types - Add buildProperties() to creation flow context to collect gamemode, difficulty, seed, world type, structures, and generator settings - Pass properties through installContent on onboarding, discovery, and ServerSetupModal flows Server setup and discovery flow improvements: - Migrate ServerSetupModal from servers_v0.reinstall to content_v1.installContent - Replace loaderApiNames lookup with toApiLoader() helper - Remove eraseDataOnInstall toggle — always use soft_override: false - Simplify modpack install on discovery page to use first available version and route through creation flow modal for both onboarding and non-onboarding - Differentiate post-install navigation: content page for onboarding, loader options for existing servers Modpack update flow: - Replace updateModpack() call with installContent() using soft_override: true to support version selection in the content updater modal Client-only mod indicators: - Add environment field to AddonVersion (reuses Labrinth.Projects.v3.Environment) - Add environment to ContentItem and isClientOnly to ContentCardTableItem - Show orange TriangleAlertIcon with tooltip on client-only mods in content table - Add "Client-only" filter pill to content filtering (controlled via showClientOnlyFilter on ContentManagerContext) - Apply client-only indicators in both ContentPageLayout and ModpackContentModal Misc: - Add CLAUDE.md note about using prepr commands for lint checks - Export ConfirmLeaveModal from instances barrel * fix: piping * fix: switch content disable for linked server instances * feat: client only filter * fix: prepr * feat: hasUpdate shape update * feat: bulk update endpoint impl for content in panel * feat: websocket state impl again with new phases * fix: ws * fix: use timeout fn for sync admon + fix content card layout scroll for browsers with overflow anchor bug * fix: qa bugs * fix: lint, a11y and i18n * refactor: set up layouts folder properly * fix: linked data cache stuff + lint * feat: move installationsettings to shared layout * fix: lint * fix: issues * feat: temp fuck staging up * fix: lockfile * fix: data sync issues on loader.vue * fix: lint * Hide shader configuration files from content list (#5499) * feat: workaround search problem + split out reset * fix: qa * fix: changelog not showing on first open * fix: qa + optimistic updating improvements * fix: prepr+lint * fix: qa * feat: qa * fix: lint * fix: lint * fix: build * fix: build * fix: type errors * fix: fade and JAVA_HOME passthrough * feat: qa * feat: impl diff shit * fix: qa * fix: app qa * feat: update diff modal * fix: endpoint * fix: qa * fix: qa * fix: use bulk in modpack modal * feat: abort signal impl + fix issues * fix: diff modal trunc * feat: qa * fix: qa * feat: tooltip content tab * fix: prepr * fix: dismiss on settings btn * feat: qa * feat: dont clear handlers on disconnect * fix: lint * fix: wrangler + introduce staging-archon env file --------- Signed-off-by: Calum H. <calum@modrinth.com> Co-authored-by: tdgao <mr.trumgao@gmail.com> Co-authored-by: Artyom Ezri <61311568+Artezon@users.noreply.github.com>
129 lines
7.2 KiB
Markdown
129 lines
7.2 KiB
Markdown
# Modrinth Monorepo
|
|
|
|
This is the Modrinth monorepo — it contains all Modrinth projects, both frontend and backend. When entering a project, either to edit or analyse, you should read it's CLAUDE.md.
|
|
|
|
## Architecture
|
|
|
|
- **Monorepo tooling:** [Turborepo](https://turbo.build/) (`turbo.jsonc`) + [pnpm workspaces](https://pnpm.io/workspaces) (`pnpm-workspace.yaml`)
|
|
- **Frontend:** Vue 3 / Nuxt 3, Tailwind CSS v3
|
|
- **Backend:** Rust (Labrinth API), Postgres, Clickhouse
|
|
- **Indentation:** Use TAB everywhere, never spaces
|
|
|
|
### Apps (`apps/`)
|
|
|
|
| App | Description |
|
|
| ----------------- | ------------------------------ |
|
|
| `frontend` | Main Modrinth website (Nuxt 3) |
|
|
| `app-frontend` | Desktop/app frontend (Vue 3) |
|
|
| `app` | Desktop/app shell (Tauri) |
|
|
| `app-playground` | Testing playground for app |
|
|
| `labrinth` | Backend API service |
|
|
| `daedalus_client` | Daedalus client implementation |
|
|
| `docs` | Documentation site (Astro) |
|
|
|
|
### Packages (`packages/`)
|
|
|
|
| Package | Description |
|
|
| ------------------ | ----------------------------------------------------- |
|
|
| `ui` | Shared Vue component library (`@modrinth/ui`) |
|
|
| `assets` | Styling and auto-generated icons (`@modrinth/assets`) |
|
|
| `api-client` | API client for Nuxt, Tauri, and Node/browser |
|
|
| `app-lib` | Shared app library |
|
|
| `blog` | Blog system and changelog data |
|
|
| `utils` | Shared utility functions |
|
|
| `moderation` | Moderation utilities |
|
|
| `daedalus` | Daedalus protocol |
|
|
| `tooling-config` | ESLint, Prettier, TypeScript configs |
|
|
| `ariadne` | Analytics library |
|
|
| `modrinth-log` | Logging utilities |
|
|
| `modrinth-maxmind` | MaxMind GeoIP |
|
|
| `modrinth-util` | General utilities |
|
|
| `muralpay` | Payment processing |
|
|
| `path-util` | Path utilities |
|
|
| `sqlx-tracing` | SQLx query tracing |
|
|
|
|
## Pre-PR Commands
|
|
|
|
Run these from the **root** folder before opening a pull request - do not run these after each prompt the user gives you, only run when asked, ask the user a question if they want to run it if the user indicates that they are about to create a pull request.
|
|
|
|
- **Website:** `pnpm prepr:frontend:web`
|
|
- **App frontend:** `pnpm prepr:frontend:app`
|
|
- **Frontend libs:** `pnpm prepr:frontend:lib`
|
|
- **All frontend (app+web):** `pnpm prepr`
|
|
- **Labrinth (backend):** See `apps/labrinth/CLAUDE.md`
|
|
|
|
The website and app `prepr` commands
|
|
|
|
## Dev Commands
|
|
|
|
- **Website:** `pnpm web:dev` (copy `.env` template in `apps/frontend/` first)
|
|
- **App:** `pnpm app:dev` (copy `.env` template in `packages/app-lib/` first)
|
|
- **Storybook (packages/ui):** `pnpm storybook`
|
|
|
|
## Project-Specific Instructions
|
|
|
|
Each project may have its own `CLAUDE.md` with detailed instructions:
|
|
|
|
- [`apps/labrinth/CLAUDE.md`](apps/labrinth/CLAUDE.md) — Backend API
|
|
- [`apps/frontend/CLAUDE.md`](apps/frontend/CLAUDE.md) - Frontend Website
|
|
|
|
## Skills (`.claude/skills/`)
|
|
|
|
Project-specific skill files with detailed patterns. Use them when the task matches:
|
|
|
|
- **`api-module`** — Adding a new API endpoint module to `packages/api-client` (types, module class, registry registration)
|
|
- **`cross-platform-pages`** — Building a page that needs to work in both the website (`apps/frontend`) and the desktop app (`apps/app-frontend`)
|
|
- **`dependency-injection`** — Creating or wiring up a `provide`/`inject` context for platform abstraction or deep component state sharing
|
|
- **`figma-mcp`** — Translating a Figma design into Vue components using the Figma MCP tools
|
|
- **`i18n-convert`** — Converting hardcoded English strings in Vue SFCs into the `@modrinth/ui` i18n system (`defineMessages`, `formatMessage`, `IntlFormatted`)
|
|
- **`multistage-modals`** — Building a wizard-like modal with multiple stages, progress tracking, and per-stage buttons using `MultiStageModal`
|
|
- **`tanstack-query`** — Fetching, caching, or mutating server data with `@tanstack/vue-query` (queries, mutations, invalidation, optimistic updates)
|
|
|
|
## Code Guidelines
|
|
|
|
### Comments
|
|
- DO NOT use "heading" comments like: `=== Helper methods ===`.
|
|
- Use doc comments, but avoid inline comments unless ABSOLUTELY necessary for clarity. Code should aim to be self documenting!
|
|
|
|
## Bash Guidelines
|
|
|
|
### Output handling
|
|
- DO NOT pipe output through `head`, `tail`, `less`, or `more`
|
|
- NEVER use `| head -n X` or `| tail -n X` to truncate output
|
|
- IMPORTANT: Run commands directly without pipes when possible
|
|
- IMPORTANT: If you need to limit output, use command-specific flags (e.g. `git log -n 10` instead of `git log | head -10`)
|
|
- ALWAYS read the full output — never pipe through filters
|
|
|
|
### General
|
|
- Do not create new non-source code files (e.g. Bash scripts, SQL scripts) unless explicitly prompted to
|
|
- For Frontend, when doing lint checks, only use the `prepr` commands, do not use `typecheck` or `tsc` etc.
|
|
|
|
## Edit Tool - Whitespace Handling (CLAUDE ONLY)
|
|
|
|
The Read tool uses `→` to mark where line numbers end and file content begins.
|
|
|
|
**Rule:** Copy the EXACT whitespace that appears after the `→` marker.
|
|
- Whatever appears between `→` and the code text is what's actually in the file
|
|
- That whitespace must be used EXACTLY in Edit tool's old_string
|
|
- Don't count arrows, don't interpret - just copy what's after the `→`
|
|
|
|
**Example:**
|
|
14→ private byte tag;
|
|
For Edit, use: ` private byte tag;` (copy everything after →, including the two tabs)
|
|
|
|
**If Edit fails:** Stop and explain the problem. Do not attempt sed/awk/bash workarounds.
|
|
|
|
**IMPORTANT**: Trust the Read tool output. Copy what's after `→` into Edit immediately. DO NOT verify with sed/od/grep first - that's wasting time and the instructions already tell you to stop if Edit fails, not to pre-verify.
|
|
|
|
## Skills
|
|
|
|
Project-specific skills (patterns, conventions, and implementation guides) are located in [`.claude/skills/`](./.claude/skills/). Each skill has a `SKILL.md` describing the pattern:
|
|
|
|
- **[Dependency Injection](./.claude/skills/dependency-injection/SKILL.md)** — Vue provide/inject DI layer using `createContext`
|
|
- **[Cross-Platform Pages](./.claude/skills/cross-platform-pages/SKILL.md)** — Shared component architecture across Nuxt and Tauri frontends
|
|
- **[Multistage Modals](./.claude/skills/multistage-modals/SKILL.md)** — Wizard-like modal flows with `MultiStageModal`
|
|
- **[Figma MCP](./.claude/skills/figma-mcp/SKILL.md)** — Translating Figma designs to Modrinth Vue components
|
|
- **[i18n Convert](./.claude/skills/i18n-convert/SKILL.md)** — Converting hard-coded strings to vue-i18n localization
|
|
- **[API Module](./.claude/skills/api-module/SKILL.md)** — Adding new endpoint modules to `@modrinth/api-client`
|
|
- **[TanStack Query](./.claude/skills/tanstack-query/SKILL.md)** — Server state management with `@tanstack/vue-query` v5
|