mirror of
https://github.com/giancarloerra/socraticode.git
synced 2026-07-03 14:05:21 +02:00
Giancarlo Erra
50d8853ea6
Interactive Viewer (primary)
────────────────────────────
codebase_graph_visualize now accepts mode="mermaid" (default, existing
behaviour — text Mermaid diagram) or mode="interactive". Interactive
mode generates a self-contained HTML page and opens it in the user's
default browser via the `open` npm package (cross-platform: macOS,
Linux, Windows). Cytoscape.js 3.30.2 + Dagre 0.8.5 + cytoscape-dagre
2.5.0 are vendored under src/assets/ — no CDN, works offline.
Features:
- File view — every source file as a node, imports as edges, language
colour-coded, circular deps highlighted in red.
- Symbol view toggle — functions/classes/methods as nodes with call
edges (confidence-styled). Embedded when the symbol graph fits under
20k symbols / 60k call edges; above that threshold the file view
remains usable and a banner directs users to codebase_impact /
codebase_symbols for symbol-level queries.
- Sidebar on node click — imports, dependents, per-file symbol list
(first 30 + link to codebase_symbols), action buttons for blast
radius and call flow.
- Right-click any node → blast radius overlay (reverse-transitive
closure). Call-flow button on the sidebar for forward traversal.
- Live search across files and symbols, six Cytoscape layouts
(Dagre / force / concentric / breadth-first / grid / circle),
PNG export (filename sanitised for cross-platform safety).
- `open: false` parameter skips auto-launch and just returns the file
path — useful in headless environments.
Viewer is XSS-safe by construction: all DOM built with createElement
+ textContent (no innerHTML anywhere); embedded JSON escapes every
"<" as \u003c so a stray </script> in a file path or symbol name
cannot break out of the script-type="application/json" container.
New files:
- src/assets/{cytoscape.min.js,dagre.min.js,cytoscape-dagre.js,
viewer-template.html,viewer-styles.css,viewer-app.js}
- scripts/copy-assets.mjs — postbuild copier (tsc does not handle
non-TS files); wired into npm run build and prepublishOnly
- src/services/graph-visualize-html.ts — HTML builder with scale-cap
logic (MAX_SYMBOLS / MAX_EDGES / MAX_SYMS_PER_FILE) and parallel
per-file Qdrant payload loading
- src/services/graph-visualize-browser.ts — temp-file write +
cross-platform open wrapper
- tests/unit/graph-visualize-html.test.ts — 5 tests (self-contained,
escape-safety, symbolMode omitted/capped, cycle marking)
- tests/unit/graph-visualize-browser.test.ts — 4 tests (deterministic
path, overwrite, success + failure paths)
New runtime dependency: open@^10.2.0 (Sindre Sorhus, zero transitive
deps, cross-platform).
British-English doc sweep (secondary)
─────────────────────────────────────
Switched all project docs to British English spelling:
behavior → behaviour organized → organised
color-coded → colour-coded initialization → initialisation
visualization → visualisation customization → customisation
recognized → recognised optimized → optimised
acknowledgment → acknowledgement finalize → finalise
analyzing → analysing apologizing → apologising
sexualized → sexualised
Affected files: README, DEVELOPER, AGENTS, CLAUDE, GEMINI, SECURITY,
CONTRIBUTING, CODE_OF_CONDUCT, agents/codebase-explorer.md,
skills/codebase-exploration/{SKILL.md,references/tool-reference.md},
skills/codebase-management/references/tool-reference.md.
Also surfaced Impact Analysis in the top-level README paragraph.
Docs
────
- README: "Interactive graph explorer" subsection under Impact Analysis,
tool-table row updated.
- DEVELOPER.md: architecture section under codebase_graph_visualize
covering asset layout, data flow, cap logic, XSS-safety invariants.
- AGENTS.md / CLAUDE.md / GEMINI.md: new "User asks for a visual /
interactive / shareable graph" row in the tool-routing table.
- skills/codebase-exploration/: SKILL.md bullet + tool-reference.md
full mode description.
- CHANGELOG.md: "Interactive Graph Explorer" section under Unreleased.
Quality gates (all green)
─────────────────────────
- Biome lint: clean
- TypeScript (tsc): clean
- Unit tests: 685/685
- Integration tests: 154/154 (real Qdrant + Ollama)
- CodeRabbit: No findings (1 fix applied — filename sanitisation)
- Snyk code test: 0 issues
Co-Authored-By: Claude Opus 4.7 (1M context) <noreply@anthropic.com>
132 lines
5.3 KiB
Markdown
132 lines
5.3 KiB
Markdown
# Contributor Covenant Code of Conduct
|
|
|
|
## Our Pledge
|
|
|
|
We as members, contributors, and leaders pledge to make participation in our
|
|
community a harassment-free experience for everyone, regardless of age, body
|
|
size, visible or invisible disability, ethnicity, sex characteristics, gender
|
|
identity and expression, level of experience, education, socio-economic status,
|
|
nationality, personal appearance, race, caste, color, religion, or sexual
|
|
identity and orientation.
|
|
|
|
We pledge to act and interact in ways that contribute to an open, welcoming,
|
|
diverse, inclusive, and healthy community.
|
|
|
|
## Our Standards
|
|
|
|
Examples of behaviour that contributes to a positive environment for our
|
|
community include:
|
|
|
|
* Demonstrating empathy and kindness toward other people
|
|
* Being respectful of differing opinions, viewpoints, and experiences
|
|
* Giving and gracefully accepting constructive feedback
|
|
* Accepting responsibility and apologising to those affected by our mistakes,
|
|
and learning from the experience
|
|
* Focusing on what is best not just for us as individuals, but for the overall
|
|
community
|
|
|
|
Examples of unacceptable behaviour include:
|
|
|
|
* The use of sexualised language or imagery, and sexual attention or advances of
|
|
any kind
|
|
* Trolling, insulting or derogatory comments, and personal or political attacks
|
|
* Public or private harassment
|
|
* Publishing others' private information, such as a physical or email address,
|
|
without their explicit permission
|
|
* Other conduct which could reasonably be considered inappropriate in a
|
|
professional setting
|
|
|
|
## Enforcement Responsibilities
|
|
|
|
Community leaders are responsible for clarifying and enforcing our standards of
|
|
acceptable behaviour and will take appropriate and fair corrective action in
|
|
response to any behaviour that they deem inappropriate, threatening, offensive,
|
|
or harmful.
|
|
|
|
Community leaders have the right and responsibility to remove, edit, or reject
|
|
comments, commits, code, wiki edits, issues, and other contributions that are
|
|
not aligned to this Code of Conduct, and will communicate reasons for moderation
|
|
decisions when appropriate.
|
|
|
|
## Scope
|
|
|
|
This Code of Conduct applies within all community spaces, and also applies when
|
|
an individual is officially representing the community in public spaces.
|
|
Examples of representing our community include using an official email address,
|
|
posting via an official social media account, or acting as an appointed
|
|
representative at an online or offline event.
|
|
|
|
## Enforcement
|
|
|
|
Instances of abusive, harassing, or otherwise unacceptable behaviour may be
|
|
reported to the project maintainer at **giancarlo@altaire.com**.
|
|
|
|
All complaints will be reviewed and investigated promptly and fairly. The
|
|
project maintainer is obligated to respect the privacy and security of the
|
|
reporter of any incident.
|
|
|
|
## Enforcement Guidelines
|
|
|
|
Community leaders will follow these Community Impact Guidelines in determining
|
|
the consequences for any action they deem in violation of this Code of Conduct:
|
|
|
|
### 1. Correction
|
|
|
|
**Community Impact**: Use of inappropriate language or other behaviour deemed
|
|
unprofessional or unwelcome in the community.
|
|
|
|
**Consequence**: A private, written warning from community leaders, providing
|
|
clarity around the nature of the violation and an explanation of why the
|
|
behaviour was inappropriate. A public apology may be requested.
|
|
|
|
### 2. Warning
|
|
|
|
**Community Impact**: A violation through a single incident or series of
|
|
actions.
|
|
|
|
**Consequence**: A warning with consequences for continued behaviour. No
|
|
interaction with the people involved, including unsolicited interaction with
|
|
those enforcing the Code of Conduct, for a specified period of time. This
|
|
includes avoiding interactions in community spaces as well as external channels
|
|
like social media. Violating these terms may lead to a temporary or permanent
|
|
ban.
|
|
|
|
### 3. Temporary Ban
|
|
|
|
**Community Impact**: A serious violation of community standards, including
|
|
sustained inappropriate behaviour.
|
|
|
|
**Consequence**: A temporary ban from any sort of interaction or public
|
|
communication with the community for a specified period of time. No public or
|
|
private interaction with the people involved, including unsolicited interaction
|
|
with those enforcing the Code of Conduct, is allowed during this period.
|
|
Violating these terms may lead to a permanent ban.
|
|
|
|
### 4. Permanent Ban
|
|
|
|
**Community Impact**: Demonstrating a pattern of violation of community
|
|
standards, including sustained inappropriate behaviour, harassment of an
|
|
individual, or aggression toward or disparagement of classes of individuals.
|
|
|
|
**Consequence**: A permanent ban from any sort of public interaction within the
|
|
community.
|
|
|
|
## Attribution
|
|
|
|
This Code of Conduct is adapted from the [Contributor Covenant][homepage],
|
|
version 2.1, available at
|
|
[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
|
|
|
|
Community Impact Guidelines were inspired by
|
|
[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
|
|
|
|
For answers to common questions about this code of conduct, see the FAQ at
|
|
[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
|
|
[https://www.contributor-covenant.org/translations][translations].
|
|
|
|
[homepage]: https://www.contributor-covenant.org
|
|
[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
|
|
[Mozilla CoC]: https://github.com/mozilla/diversity
|
|
[FAQ]: https://www.contributor-covenant.org/faq
|
|
[translations]: https://www.contributor-covenant.org/translations
|