Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 8 additions & 1 deletion AGENTS.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,14 @@
# Repository Guidelines

## Project Structure & Modules

- frontend/apps/*: Next.js apps (e.g., `@dlh/erd-viewer-app`, `@dlh/erd-viewer-docs`).
- frontend/packages/*: Shared libraries and tools (e.g., `schema`, `erd-core`, `cli`, `ui`).
- frontend/packages/*: Shared libraries and tools (e.g., `erd-viewer-schema`, `erd-viewer-core`, `erd-viewer-cli`, `erd-viewer-ui`).
- frontend/internal-packages/*: Infra and tooling (`e2e`, `configs`, `storybook`, `agent`).
- assets/: Images and media. docs/: Documentation. scripts/: Repo utilities.

## Build, Test, and Development

- Install: `pnpm install`
- All apps/packages (Turbo):
- Dev: `pnpm dev` (or one app: `pnpm -F @dlh/erd-viewer-app dev`)
Expand All @@ -19,26 +21,31 @@
- Build Next: `pnpm -F @dlh/erd-viewer-app build`

## Coding Style & Naming

- Language: TypeScript/TSX; React components in PascalCase (e.g., `App.tsx`); utilities in camelCase (e.g., `mergeSchema.ts`).
- CSS Modules: `*.module.css` with typed CSS via `typed-css-modules`.
- Lint/Format: Biome and ESLint. Run `pnpm fmt` and `pnpm lint`. Pre-commit hooks run `pnpm lint` (see `lefthook.yml`).

## Testing Guidelines

- Unit tests: Vitest. Place near source as `*.test.ts(x)` or in `__tests__/`.
- E2E tests: Playwright in `frontend/internal-packages/e2e`.
- Commands: `pnpm test` for unit, `pnpm test:e2e` for Playwright, `pnpm test:coverage` for V8 coverage.

## Commit & Pull Requests

- Commit style: Conventional Commits (e.g., `feat:`, `fix:`, `chore(deps): ...`).
- Before pushing: `pnpm fmt && pnpm lint && pnpm test`.
- PRs: clear description, linked issues, screenshots for UI changes, and note any env or migration impacts.
- Versioning: If you change a publishable package, add a changeset: `pnpm changeset`.

## Security & Configuration

- Environment: use `.env`/`.env.local` (created automatically by `pnpm prebuild`). Never commit secrets.
- Sync Vercel envs (optional): `pnpm vercel:env-pull` and link with `pnpm vercel:link`.
- Common vars: `NEXT_PUBLIC_*`, Sentry keys, and job runner tokens (see `turbo.json` env list).

## Tips

- Target a single package with `pnpm -F <package-name> <script>`.
- Use Turbo filters when running large tasks locally for faster feedback.
6 changes: 3 additions & 3 deletions frontend/packages/cli/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -359,7 +359,7 @@ These changes ensure users always see the latest ERD visualization after regener

### Patch Changes

- [#957](https://github.com/liam-hq/liam/pull/957) - 🐛 Enhance tests for long SQL statements and fix errorOffset handling. ref. https://github.com/liam-hq/liam/issues/874 / Thanks [@hoshinotsuyoshi](https://github.com/hoshinotsuyoshi)!
- [#957](https://github.com/liam-hq/liam/pull/957) - 🐛 Enhance tests for long SQL statements and fix errorOffset handling. ref. <https://github.com/liam-hq/liam/issues/874> / Thanks [@hoshinotsuyoshi](https://github.com/hoshinotsuyoshi)!

## 0.5.0

Expand Down Expand Up @@ -391,7 +391,7 @@ These changes ensure users always see the latest ERD visualization after regener
### Patch Changes

- [#792](https://github.com/liam-hq/liam/pull/792) - ♻️ Added a tooltip for truncated table names to improve usability. / Thanks [@prakha](https://github.com/prakha)!
- [#759](https://github.com/liam-hq/liam/pull/759) - ♻️ Reorganize erd-core Structure: Parallelize ERDContent & Consolidate Shared Utilities in features/erd-core / Thanks [@junkisai](https://github.com/junkisai)!
- [#759](https://github.com/liam-hq/liam/pull/759) - ♻️ Reorganize erd-viewer-core Structure: Parallelize ERDContent & Consolidate Shared Utilities in features/erd-viewer-core / Thanks [@junkisai](https://github.com/junkisai)!
- [#798](https://github.com/liam-hq/liam/pull/798) - 🐛 integrate user editing state into related tables component / Thanks [@junkisai](https://github.com/junkisai)!
- [#797](https://github.com/liam-hq/liam/pull/797) - 🐛 When nodes without relationships are present, display only that node in RelatedTables. / Thanks [@junkisai](https://github.com/junkisai)!

Expand All @@ -410,7 +410,7 @@ Increases the likelihood of processing larger `.sql` files without encountering

### Patch Changes

- [#754](https://github.com/liam-hq/liam/pull/754) - 🐛 Fix file operations to support Windows compatibility. ref. https://github.com/liam-hq/liam/issues/751 / Thanks [@hoshinotsuyoshi](https://github.com/hoshinotsuyoshi)!
- [#754](https://github.com/liam-hq/liam/pull/754) - 🐛 Fix file operations to support Windows compatibility. ref. <https://github.com/liam-hq/liam/issues/751> / Thanks [@hoshinotsuyoshi](https://github.com/hoshinotsuyoshi)!

## 0.4.1

Expand Down
2 changes: 1 addition & 1 deletion frontend/packages/erd-core/CHANGELOG.md
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@ Note: UI representation is still under development, but link icon display has be
### Patch Changes

- [#792](https://github.com/liam-hq/liam/pull/792) - ♻️ Added a tooltip for truncated table names to improve usability. / Thanks [@prakha](https://github.com/prakha)!
- [#759](https://github.com/liam-hq/liam/pull/759) - ♻️ Reorganize erd-core Structure: Parallelize ERDContent & Consolidate Shared Utilities in features/erd-core / Thanks [@junkisai](https://github.com/junkisai)!
- [#759](https://github.com/liam-hq/liam/pull/759) - ♻️ Reorganize erd-viewer-core Structure: Parallelize ERDContent & Consolidate Shared Utilities in features/erd-viewer-core / Thanks [@junkisai](https://github.com/junkisai)!
- [#798](https://github.com/liam-hq/liam/pull/798) - 🐛 integrate user editing state into related tables component / Thanks [@junkisai](https://github.com/junkisai)!
- [#797](https://github.com/liam-hq/liam/pull/797) - 🐛 When nodes without relationships are present, display only that node in RelatedTables. / Thanks [@junkisai](https://github.com/junkisai)!

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,11 @@ type Props = {
commandName: string
}


// TODO: Work on this for DLH ERD VIEWER



// TODO: set gif or image for "Show All Table" and "Hide All Table" commands
const COMMAND_VIDEO_SOURCE: Record<string, string> = {
'copy link':
Expand Down
Loading