wardleyToGo: Instructions file for Claude Code

CLAUDE.md

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

Project Overview

WardleyToGo is a Go library and set of tools for creating and rendering Wardley Maps. It consists of:

• Core library (github.com/owulveryck/wardleyToGo): A Go SDK providing primitives to code Wardley Maps as graphs
• WTG2 DSL: A high-level domain-specific language for designing Wardley Maps (grammar in wtg2/grammar.bnf)
• SVG renderer: Renders maps to SVG format with embedded CSS/JS
• WebAssembly demo: Interactive playground for WTG2 DSL

Key Architecture

Core Components

• Map (map.go): Central structure representing a Wardley Map as a directed graph using internal/graph
• Component (defs.go): Interface for map elements with positions on a 100x100 coordinate system
• Collaboration (collaboration.go): Interface for edges/relationships between components
• Area: Interface for rectangular regions on the map

Parser

• WTG2 parser (parser/wtg2/): Parses the WTG2 domain-specific language into an AST, then builds a wardleyToGo.Map

Encoder

• SVG encoder (encoding/svg/): Renders maps to SVG format with embedded CSS/JS

Component Types

• Wardley components (components/wardley/): Traditional Wardley Map components with evolution stages

Experimental (exp/)

• OWM parser (exp/parser_owm/): Parser for OnlineWardleyMaps format (experimental)
• Team Topologies (exp/teamtopologies/): Team collaboration patterns (experimental)

Common Development Commands

Building and Testing

# Run tests
go test ./...

# Run tests with coverage
go test -coverprofile=coverage.txt ./...

# Run a single test
go test -run TestSpecificFunction ./path/to/package

# Build the wtg2svg CLI
go build ./cmd/wtg2svg/

# Convert WTG2 to SVG
cat wtg2/example.wtg2 | go run ./cmd/wtg2svg/ > output.svg

# Format imports (run after modifying Go files)
goimports -w .

# Clean module cache and dependencies
go clean -modcache
go mod tidy