packageJson
DevelopmentpackageJson is an Agent Skill for development published in the forcedotcom/salesforcedx-vscode repository on GitHub: a SKILL.md instruction file an AI agent can load to do this task.
package.json conventions for this repo. Use when editing/reviewing a package.json — name, types, browser, files, dependencies, devDependencies, packaging, scripts, or vscode contributes.
QUICK START
How to use this skill
Bring this guide into your coding agent with a prompt tailored to the tool you use.
- Open your project in Codex.
- Copy and paste the prompt below.
- Review files and risks before approving any action.
Prompt to paste
Inspect the Agent Skill at https://github.com/forcedotcom/salesforcedx-vscode/blob/HEAD/.claude/skills/packageJson/SKILL.md and all supporting files. Report provenance, permissions, scripts, dependencies, and security risks. Propose an exact installation into .agents/skills/packagejson, but wait for my approval before writing files or running scripts.
Copying this prompt does not install or run the skill. Review third-party files before use.
name
- non-npm package →
@salesforce/foo(whether published or not) - vscode-extension package →
salesforcedx-vscode-foo - don't rename; flag mismatches to the user
types
- extension: needed only if it's an extensionDependency of another extension
- non-extension package: not needed
browser
- web-enabled extensions only; must point to a bundled dist file
files
- packages that publish to npm need a
filesprop
scripts
See wireit skill
dependencies
- another package in this repo → version
* - no dependency on salesforcedx-vscode-services (extensionDependency / devDependency ok)
devDependencies
- don't duplicate devDependencies already at repo top level
packaging
- legacy vsce script (mutates pjson at package time); don't create new ones, want them gone
vscode "contributes"
tips
commandsshow in command palette by default; suppress vianever/whenundercommandPalette- commands need a unique ID; 2 extensions with the same config → UI warning
- never a
default:trueboolean config (hard to override user/workspace)
ESLint rules
Rules from @salesforce/eslint-plugin-vscode-extensions (packages/eslint-local-rules; published to npm) enforce good package.json:
package-json-i18n-descriptions: Requires%key%placeholders (not hardcoded strings) in commands, config, debuggers, views, walkthroughs. Validates keys exist inpackage.nls.jsonpackage-json-extension-icon: Published VS Code extensions (salesforcedx-vscode*) must have top-levelicon; icon path must exist when specifiedpackage-json-icon-paths: Validatescommands[*].iconandviewsContainers.activitybar[*].iconhave bothlight/darkand files existpackage-json-command-refs: Menu commands must reference defined commands; reports orphaned commandspackage-json-view-refs: View IDs must be referenced in menuwhenclauses orviewsWelcome; reports orphaned views