@salesforce/templates

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:

• 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).
• 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.

Similar packages

Other packages similar to @salesforce/templates

create-react-app

create-react-app is a package that sets up a new React project with a predefined structure and configuration. It is similar to @salesforce/templates in that it helps developers quickly start new projects with best practices in place. However, it is focused on React applications rather than Salesforce DX projects.

vue-cli

vue-cli is a package that provides a set of tools for scaffolding Vue.js projects. Like @salesforce/templates, it offers templates and configurations to help developers get started quickly. The main difference is that vue-cli is tailored for Vue.js development, whereas @salesforce/templates is designed for Salesforce DX.

angular-cli

angular-cli is a command-line interface tool that helps developers create and manage Angular projects. It offers similar functionalities to @salesforce/templates by providing templates and project structures. The key distinction is that angular-cli is specific to Angular applications, while @salesforce/templates is for Salesforce DX.