chore: track .pi-map.md and .pi-map.index.md artifacts

Remove the map files from .gitignore so they are committed as project navigation artifacts, and also unignore them in the sample fixture. Regenerate all maps so the committed versions reflect the current source.
2026-06-16 14:38:42 +00:00
parent cb581f44b9
commit 3e7410b6bd
46 changed files with 1158 additions and 3 deletions
@@ -0,0 +1,30 @@
+# fixtures/sample-project/src (index)
+dir: fixtures/sample-project/src
+
+## role
+Entry point module that demonstrates user creation, email validation, and logging for a sample project.
+## parent
+index: fixtures/sample-project/.pi-map.index.md
+map: fixtures/sample-project/.pi-map.md
+## children
+- fixtures/sample-project/src/components
+  index: fixtures/sample-project/src/components/.pi-map.index.md
+  map: fixtures/sample-project/src/components/.pi-map.md
+- fixtures/sample-project/src/models
+  index: fixtures/sample-project/src/models/.pi-map.index.md
+  map: fixtures/sample-project/src/models/.pi-map.md
+- fixtures/sample-project/src/utils
+  index: fixtures/sample-project/src/utils/.pi-map.index.md
+  map: fixtures/sample-project/src/utils/.pi-map.md
+## files
+- index.ts
+## links
+index: fixtures/sample-project/src/.pi-map.index.md
+map: fixtures/sample-project/src/.pi-map.md
+## workflows
+- change src behavior
+  read: index.ts
+- explore src subdirectories
+  index: fixtures/sample-project/src/components/.pi-map.index.md, fixtures/sample-project/src/models/.pi-map.index.md, fixtures/sample-project/src/utils/.pi-map.index.md
+## dirty
+-
@@ -0,0 +1,26 @@
+# fixtures/sample-project/src
+dir: fixtures/sample-project/src
+
+index: fixtures/sample-project/src/.pi-map.index.md
+
+## role
+Entry point module that demonstrates user creation, email validation, and logging for a sample project.
+## files
+- index.ts | Entry point that creates a user, validates their email, and logs the result | exp: func:main(), call:createUser, call:validateEmail, call:logger.error, call:logger.info | dep: ./models/user.js, ./utils/validation.js, ./utils/logger.js
+## arch
+Simple procedural script with direct function calls and sequential execution pattern.
+## tags
+user, email, js, main, call:create, call:validate, call:logger.error, call:logger.info
+## symbols
+- main
+- call:createUser
+- call:validateEmail
+- call:logger.error
+- call:logger.info
+## workflows
+- change src behavior
+  read: index.ts
+- explore src subdirectories
+  index: fixtures/sample-project/src/components/.pi-map.index.md, fixtures/sample-project/src/models/.pi-map.index.md, fixtures/sample-project/src/utils/.pi-map.index.md
+## dirty
+-
@@ -0,0 +1,21 @@
+# fixtures/sample-project/src/components (index)
+dir: fixtures/sample-project/src/components
+
+## role
+Provides reusable UI components for building the application's interface.
+## parent
+index: fixtures/sample-project/src/.pi-map.index.md
+map: fixtures/sample-project/src/.pi-map.md
+## children
+-
+## files
+- Button.tsx
+- UserCard.tsx
+## links
+index: fixtures/sample-project/src/components/.pi-map.index.md
+map: fixtures/sample-project/src/components/.pi-map.md
+## workflows
+- change components behavior
+  read: Button.tsx, UserCard.tsx
+## dirty
+-
@@ -0,0 +1,26 @@
+# fixtures/sample-project/src/components
+dir: fixtures/sample-project/src/components
+
+index: fixtures/sample-project/src/components/.pi-map.index.md
+
+## role
+Provides reusable UI components for building the application's interface.
+## files
+- Button.tsx | A reusable React button component that renders a styled button with configurable label, visual variant, click handler, and disabled state. | exp: ButtonProps, func:Button({ label, variant = "primary", onClick, disabled = false, }: ButtonProps) → JSX.Element | dep: react, React
+- UserCard.tsx | Renders a user card component with optional edit and delete action buttons. | exp: UserCardProps, func:UserCard({ user, onEdit, onDelete }: UserCardProps) → JSX.Element, call:onEdit, call:onDelete | dep: react, ../models/user.js, React
+## arch
+Simple functional React components with props-based configuration, following a basic presentational component pattern.
+## tags
+button, user, card, react, props, call:on, edit, delete
+## symbols
+- Button
+- UserCard
+- ButtonProps
+- UserCardProps
+- call:onEdit
+- call:onDelete
+## workflows
+- change components behavior
+  read: Button.tsx, UserCard.tsx
+## dirty
+-
@@ -0,0 +1,20 @@
+# fixtures/sample-project/src/models (index)
+dir: fixtures/sample-project/src/models
+
+## role
+Defines the User data model with creation and serialization capabilities including email validation.
+## parent
+index: fixtures/sample-project/src/.pi-map.index.md
+map: fixtures/sample-project/src/.pi-map.md
+## children
+-
+## files
+- user.ts
+## links
+index: fixtures/sample-project/src/models/.pi-map.index.md
+map: fixtures/sample-project/src/models/.pi-map.md
+## workflows
+- change models behavior
+  read: user.ts
+## dirty
+-
@@ -0,0 +1,26 @@
+# fixtures/sample-project/src/models
+dir: fixtures/sample-project/src/models
+
+index: fixtures/sample-project/src/models/.pi-map.index.md
+
+## role
+Defines the User data model with creation and serialization capabilities including email validation.
+## files
+- user.ts | Defines a User interface and provides functions to create and serialize users with email validation. | exp: User, func:createUser(data: Omit<User, "id" | "createdAt">) → User, call:validateEmail, call:crypto.randomUUID, raise:Error, func:serializeUser(user: User) → string, call:JSON.stringify | dep: ../utils/validation.js
+## arch
+Domain model pattern with interface-based typing, pure functions for data transformation, and embedded validation logic.
+## tags
+user, create, serialize, email, validation, call:validate, call:crypto.random, uuid
+## symbols
+- createUser
+- serializeUser
+- User
+- call:validateEmail
+- call:crypto.randomUUID
+- raise:Error
+- call:JSON.stringify
+## workflows
+- change models behavior
+  read: user.ts
+## dirty
+-
@@ -0,0 +1,21 @@
+# fixtures/sample-project/src/utils (index)
+dir: fixtures/sample-project/src/utils
+
+## role
+Provides foundational cross-cutting utility functions for logging and input validation used throughout the application.
+## parent
+index: fixtures/sample-project/src/.pi-map.index.md
+map: fixtures/sample-project/src/.pi-map.md
+## children
+-
+## files
+- logger.ts
+- validation.ts
+## links
+index: fixtures/sample-project/src/utils/.pi-map.index.md
+map: fixtures/sample-project/src/utils/.pi-map.md
+## workflows
+- change utils behavior
+  read: logger.ts, validation.ts
+## dirty
+-
@@ -0,0 +1,28 @@
+# fixtures/sample-project/src/utils
+dir: fixtures/sample-project/src/utils
+
+index: fixtures/sample-project/src/utils/.pi-map.index.md
+
+## role
+Provides foundational cross-cutting utility functions for logging and input validation used throughout the application.
+## files
+- logger.ts | Provides a simple typed console logger with timestamps and convenience wrappers for different log levels. | exp: LogLevel, func:log(level: LogLevel, message: string) → void, call:new Date().toISOString, call:console.log, call:level.toUpperCase, func:debug(message: string) → void, call:log, func:info(message: string) → void, call:log, func:warn(message: string) → void, call:log, func:error(message: string) → void, call:log
+- validation.ts | Provides basic string validation utilities for emails, non-empty checks, and minimum length requirements. | exp: func:validateEmail(email: string) → boolean, call:EMAIL_REGEX.test, func:validateNotEmpty(value: string) → boolean, call:value.trim, func:validateMinLength(value: string, min: number) → boolean
+## arch
+Flat utility module pattern with pure functions, no dependencies between modules, each exporting independent typed helper functions.
+## tags
+call:log, validate, log, logger, validation, empty, length, provides
+## symbols
+- log
+- debug
+- info
+- warn
+- error
+- validateEmail
+- validateNotEmpty
+- validateMinLength
+## workflows
+- change utils behavior
+  read: logger.ts, validation.ts
+## dirty
+-