Skip to content

AGENTS.md

Latest commit

 

History

History
125 lines (95 loc) · 3.17 KB

AGENTS.md

File metadata and controls

125 lines (95 loc) · 3.17 KB
  • To regenerate the JavaScript SDK, run ./packages/sdk/js/script/build.ts.
  • ALWAYS USE PARALLEL TOOLS WHEN APPLICABLE.
  • The GitHub default branch is dev, but Membrane-specific work belongs on membrane.
  • Prefer automation: execute requested actions without confirmation unless blocked by missing info or safety/irreversibility.

Style Guide

General Principles

  • Keep things in one function unless composable or reusable
  • Avoid try/catch where possible
  • Avoid using the any type
  • Prefer single word variable names where possible
  • Use Bun APIs when possible, like Bun.file()
  • Rely on type inference when possible; avoid explicit type annotations or interfaces unless necessary for exports or clarity
  • Prefer functional array methods (flatMap, filter, map) over for loops; use type guards on filter to maintain type inference downstream

Naming

Prefer single word names for variables and functions. Only use multiple words if necessary.

// Good
const foo = 1
function journal(dir: string) {}

// Bad
const fooBar = 1
function prepareJournal(dir: string) {}

Reduce total variable count by inlining when a value is only used once.

// Good
const journal = await Bun.file(path.join(dir, "journal.json")).json()

// Bad
const journalPath = path.join(dir, "journal.json")
const journal = await Bun.file(journalPath).json()

Destructuring

Avoid unnecessary destructuring. Use dot notation to preserve context.

// Good
obj.a
obj.b

// Bad
const { a, b } = obj

Variables

Prefer const over let. Use ternaries or early returns instead of reassignment.

// Good
const foo = condition ? 1 : 2

// Bad
let foo
if (condition) foo = 1
else foo = 2

Control Flow

Avoid else statements. Prefer early returns.

// Good
function foo() {
  if (condition) return 1
  return 2
}

// Bad
function foo() {
  if (condition) return 1
  else return 2
}

Schema Definitions (Drizzle)

Use snake_case for field names so column names don't need to be redefined as strings.

// Good
const table = sqliteTable("session", {
  id: text().primaryKey(),
  project_id: text().notNull(),
  created_at: integer().notNull(),
})

// Bad
const table = sqliteTable("session", {
  id: text("id").primaryKey(),
  projectID: text("project_id").notNull(),
  createdAt: integer("created_at").notNull(),
})

Testing

  • Avoid mocks as much as possible
  • Test actual implementation, do not duplicate logic into tests

Fork Reminder (Append-Only)

  • This fork's source branch is membrane.
  • Start Membrane-specific work from origin/membrane.
  • main and dev are upstream-tracking branches and may be overwritten by sync.
  • Upstream sync scripts (from repo root):
    • bun run script/membrane-sync.ts (sync from upstream dev)
    • bun run script/membrane-sync.ts --main (sync from upstream main)
  • Membrane release tags use membrane-v* (for example membrane-v1.0.1).
  • membrane/core OpenCode setup references:
    • https://github.com/membranehq/core/blob/main/agent/README.md#opencode-binary
    • https://github.com/membranehq/core/blob/main/agent/scripts/setup-opencode.ts
  • Keep this reminder block at the bottom so upstream syncs are low-conflict.