// Write or update documentation, tooltips, translations, and help text for the vscode-sfdx-hardis VS Code extension. Use when the user asks to document, describe, explain for users, or update README/translations.
| name | document |
| description | Write or update documentation, tooltips, translations, and help text for the vscode-sfdx-hardis VS Code extension. Use when the user asks to document, describe, explain for users, or update README/translations. |
| compatibility | Designed for Claude Code (or similar products) |
| metadata | {"author":"cloudity","version":"1.0"} |
Write or update documentation for the vscode-sfdx-hardis extension.
| Type | Location |
|---|---|
| Extension features, user-facing docs | README.md |
| Claude Code instructions | CLAUDE.md |
| Claude Code skills | .claude/skills/*/SKILL.md |
| i18n strings (user-visible text) | src/i18n/*.json (all 9 locales) |
| Command tooltips | hardis-commands-provider.ts via t("tooltipKey") |
| Command help links | helpUrl property pointing to https://sfdx-hardis.cloudity.com/ |
Every label, tooltip, error message, and description shown to users must go through the i18n system (t() in TypeScript, {i18n.keyName} in LWC templates). Never hardcode user-visible English strings.
Every command in hardis-commands-provider.ts must have a descriptive tooltip explaining what it does and any prerequisites. Use t("descriptiveTooltipKey").
Update when adding new user-facing features (command categories, panels, configuration options). Follow the existing section structure.
Only add where the logic is non-obvious. Do not add JSDoc to every function or comments restating what the code does.
Commands should link to the relevant page on https://sfdx-hardis.cloudity.com/ when applicable.
src/i18n/en.json first (source of truth)fr.json, es.json, de.json, it.json, nl.json, ja.json, pl.json, pt-BR.json){{varName}} interpolation placeholders and <br/> tags exactly as-is in all languagesmessage, descriptionexecCommandWithProgress()showErrorMessage, showInformationMessage, showWarning, updateTitle[markers] in bracketsImplement features, bug fixes, or refactors in the vscode-sfdx-hardis VS Code extension. Use when the user asks to write code, fix a bug, add a feature, or make changes to the codebase.
Fix duplicate code issues reported by jscpd in the vscode-sfdx-hardis extension. Use when the user asks to fix, resolve, or address jscpd duplications, copy-paste detector findings, or MegaLinter COPYPASTE_JSCPD errors. Either factorizes the duplicates into shared helpers, or, when factorization would hurt clarity, adds jscpd ignore markers to silence them.
Fix security vulnerabilities reported by Trivy and OSV-Scanner in the vscode-sfdx-hardis extension. Use when the user asks to fix, triage, or address Trivy / OSV-Scanner / MegaLinter REPOSITORY_TRIVY / REPOSITORY_OSV_SCANNER findings. Tries upgrading the affected dependency first, then a yarn resolution override, and only ignores the finding if the vulnerability is genuinely non-exploitable in this extension's context.
Add a new monitoring command to the vscode-sfdx-hardis VS Code extension. Use when the user asks to add, register, or wire up a monitoring command (sf hardis:org:monitor:* or sf hardis:org:diagnose:* shown in the Org Monitoring menu and Monitoring Config Workbench).
Analyze code, architecture, data flow, or behavior in the vscode-sfdx-hardis VS Code extension. Use when the user asks to understand, trace, audit, or investigate how something works in this codebase.
Design new features, architectural changes, or refactors for the vscode-sfdx-hardis VS Code extension. Use when the user asks to plan, architect, or propose how to build something new or restructure existing code.