firstsun-dev_git-files-sync/CLAUDE.md

CLAUDE.md

This file provides guidance to Claude Code (claude.ai/code) when working with code in this repository.

Development Commands

• Build: npm run build (runs type check and esbuild in production mode)
• Dev: npm run dev (builds in watch mode using esbuild)
• Lint: npm run lint (runs eslint check)
• Test: npm run test (runs vitest suite)
• Version bump: npm run version (updates manifest.json and versions.json via script)

Code Architecture

• Type: Obsidian Plugin (TypeScript) that syncs vault files with a GitLab or GitHub repository.
• Entry Point: src/main.ts contains the main GitLabFilesPush class extending Plugin.
• Settings: src/settings.ts defines GitLabFilesPushSettings interface, DEFAULT_SETTINGS object, and GitLabSyncSettingTab for the Obsidian UI.
• Services: src/services/ abstracts the git provider behind GitServiceInterface, with GitHubService and GitLabService implementations sharing common logic via BaseGitService.
• Sync logic: src/logic/sync-manager.ts handles push/pull, conflict detection, and rename detection; src/logic/gitignore-manager.ts merges local and remote .gitignore rules.
• UI: src/ui/SyncStatusView.ts renders the sync status side panel; src/ui/components/ holds its sub-views.
• Bundling: Uses esbuild.config.mjs for compilation from TypeScript to a single main.js file.
• Deployment: Relies on manifest.json for plugin metadata and versions.json for version mapping/compatibility.

Conventions

• Use this.loadData() and this.saveData() for persistent settings.
• Use this.addCommand() for registration in the Command Palette.
• Use this.addRibbonIcon() for left-sidebar buttons.
• Use this.registerDomEvent() and this.registerInterval() to ensure automatic cleanup when the plugin is disabled.