project-knowledge-bootstrap

Files (1)

• SKILL.md

SKILL.md (first lines)

# Project Knowledge Bootstrap

Populates the `.setup-agents/project-knowledge.md` contract by scanning the project structure.
Run this skill when `project-knowledge.md` exists but has empty sections.

## Trigger

- The architect role starts its first task and `project-knowledge.md` has empty sections.
- Any agent detects `force-app/` exists but `## Codebase Map` is blank.

## Protocol

### 1. Detect Project Type

```bash
# Check for Salesforce project markers
ls force-app/main/default 2>/dev/null && echo "SALESFORCE"
ls sfdx-project.json 2>/dev/null && echo "SFDX"
ls package.xml 2>/dev/null && echo "PACKAGE_XML"
```

### 2. Scan Codebase Structure

```bash
# Directory tree (depth 3 for overview)
find force-app -type d -maxdepth 3 | sort

# Count artifacts by type
echo "=== Apex Classes ===" && ls force-app/main/default/classes/*.cls 2>/dev/null | wc -l
echo "=== Triggers ===" && ls force-app/main/default/triggers/*.trigger 2>/dev/null | wc -l
echo "=== LWC ===" && ls force-app/main/default/lwc/ 2>/dev/null | wc -l
echo "=== Flows ===" && ls force-app/main/default/flows/*.flow-meta.xml 2>/dev/null | wc -l
echo "=== Objects ===" && ls force-app/main/default/objects/ 2>/dev/null | wc -l
echo "=== Perm Sets ===" && ls force-app/main/default/permissionsets/*.permissionset-meta.xml 2>/dev/null | wc -l
```

### 3. Detect Naming Conventions

For each artifact type, sample 3-5 existing files and infer the pattern:

```bash
# Apex class naming
ls force-app/main/default/classes/*.cls 2>/dev/null | head -5

# Test class naming (suffix? prefix? folder?)
ls force-app/main/default/classes/*Test*.cls 2>/dev/null | head -5
ls force-app/main/default/classes/*_Test*.cls 2>/dev/null | head -5

# Trigger naming
ls force-app/main/default/triggers/*.trigger 2>/dev/null | head -5

# LWC naming
ls force-app/main/default/lwc/ 2>/dev/null | head -5

# Custom object naming
ls force-app/main/default/objects/ 2>/dev/null | grep "__c" | head -5

# Flow naming
ls force-app/main/default/flows/*.flow-meta.xml 2>/dev/null | head -5
```

**Rules for inference:**
- If a prefix is consistent across 80%+ of files, record it (e.g., `APP_ClassName`).
- If test classes use a suffix, record it (e.g., `*Test` vs `*_Test`).
- If no clear pattern emerges, leave the convention cell **empty** and add a note:
  "No convention detected — ask user before creating new artifacts."

### 4. Detect Label Language

```bash
# Sample custom field labels from object metadata
grep -h "<label>" force-app/main/default/objects/*/fields/*.field-meta.xml 2>/dev/null | head -10

# Sample custom object labels
grep -h "<label>" force-app/main/default/objects/*/*.object-meta.xml 2>/dev/null | head -5

# Sample flow labels
grep -h "<label>" force-app/main/default/flows/*.flow-meta.xml 2>/dev/null | head -5
```

**Language detection heuristic:**
- If labels contain accented characters (á, é, ñ, ü) or non-ASCII → likely Spanish/Portuguese/French.
- If labels are CamelCase English words → English.
- If mixed → record "Mixed — confirm with user."
- Record both the label language AND description language (they may differ).

### 5. Identify Architecture Patterns

```bash
# Look for trigger handler pattern
grep -rl "TriggerHandler\|ITriggerHandler\|TriggerDispatcher" force-app/ 2>/dev/null | head -3

# Look for data access layer
grep -rl "Selector\|Repository\|DataAccess\|DynamicQueries\|DatabaseService" force-app/ 2>/dev/null | head -3

# Look for service layer
grep -rl "Service\b" force-app/main/default/classes/ 2>/dev/null | grep -v Test | head -5

# Look for async patterns
grep -rl "implements Queueable\|@future\|implements Schedulable\|implements Database.Batchable" force-app/ 2>/dev/null | head -5

# Look for Platform Events
ls force-app/main/default/platformEventChannelMembers/ 2>/dev/null
ls force-app/main/default/customMetadata/ 2>/dev/null | head -5
```

### 6. Build Documentation Index

Populate `.setup-agents/doc-index.md` (a separate lightweight file agents read to locate docs).

```bash
# Find documentation files and directories
ls docs/ 2>/dev/null && echo "=== docs/ exists ==="
ls docs/adr/ 2>/dev/null && echo "=== ADRs found ==="
find . -maxdepth 2 -name "README*" -o -name "CHANGELOG*" -o -name "CONTRIBUTING*" | sort
find . -maxdepth 3 -name "*.md" -path "*/docs/*" | sort | head -20
ls wiki/ 2>/dev/null || ls .wiki/ 2>/dev/null || echo "No local wiki"
find . -maxdepth 2 -name "decisions" -type d 2>/dev/null
find . -maxdepth 2 -name "runbook*" -o -name "playbook*" | head -5

From jterratsdev/smart-deployment, BSD-3-Clause.

More from jterratsdev/smart-deployment