salesforcedx-templates

Introduction

This repository provides:

• @salesforce/templates to support the library and Salesforce VS Code extensions.

Consumer build requirements (e.g. salesforcedx-vscode)

Repos that bundle @salesforce/templates (e.g. with esbuild) and use a templates manifest must:

1. Copy built-in templates into the bundle output before the bundle step that runs generateTemplatesManifest. The published package includes templates at lib/templates. You can copy from that path, or use the exported path:
   • getBuiltinTemplatesPath (returns the resolved path to lib/templates when not on the web platform; undefined on web).
2. Wireit / task order: Ensure the script that populates dist/templates (or your equivalent) runs before the vscode:bundle (or similar) task. Otherwise the bundle step will fail with ENOENT: no such file or directory, scandir '.../dist/templates'.

Template paths inside the package are kept short (via placeholders in lib/templates) so they stay within Windows path limits used by pack:verify.

Getting Started

If you're interested in contributing, take a look at the CONTRIBUTING guide.

If you're interested in building the library locally, take a look at the development doc.

You can find more information about commands that the related plugin provides in the commands doc.

Bump DEFAULT_API_VERSION

DEFAULT_API_VERSION is maintained in src/utils/constants.ts. Please bump the value every time there is a major release.