erd-studio CLAUDE.md

CLAUDE.md

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

Naming

The extension display name is ERD Studio (package name erd-studio).

Directory Structure

ERD domain files live at {project_root}/.erd-studio/{layer}/{domain}.json. Each file is a unified domain containing the logical stage data. The custom editor activates for files matching:

• **/.erd-studio/*/*.json

The base directory is configurable via the erdStudio.semanticDir setting (default: .erd-studio).

.erd-studio/
├── layers.json
├── templates/
├── silver/
│   ├── customer-360.json   ← domain file (logical stage)
│   └── orders.json
└── gold/
    └── reporting.json

Internal Identifiers

All internal identifiers use the erdStudio prefix (erd-studio for the activity bar container id), with the command palette category "ERD Studio". The extension was originally published with a dbtSemantic prefix; two compatibility shims keep pre-rename users working and must not be removed:

• Legacy command aliases: every erdStudio.* command is also registered in code as dbtSemantic.* (see LEGACY_ALIASED_COMMANDS at the end of activate() in src/extension.ts) so old keybindings keep working. These are code-only registrations — never contribute them in package.json.
• Legacy setting fallback: settings are read via getErdStudioSetting() (src/services/configService.ts), which prefers explicit erdStudio.* values and falls back to explicit dbtSemantic.* values. The deprecated dbtSemantic.projectPath / dbtSemantic.semanticDir entries in package.json carry markdownDeprecationMessage and must stay contributed. Never read settings with getConfiguration('erdStudio').get(...) directly — always use the helper.

Build & Test Commands

npm run build          # Build both extension + webview bundles (esbuild)
npm run watch          # Watch mode — rebuilds on change
npm run compile        # Type-check only (both tsconfigs, no emit)
npm run test           # Run unit tests (vitest)
npm run test:watch     # Run tests in watch mode
npm run package        # Production build (minified, no sourcemaps)