• Description
• Usage
  • Contributing
• JSON Schemas
• Using TestSetup
• Message Transformer

Description

The @salesforce/core library provides client-side management of Salesforce DX projects, org authentication, connections to Salesforce APIs, and other utilities. Much of the core functionality that powers the Salesforce CLI plugins comes from this library. You can use this functionality in your plugins too.

Usage

See the API documentation.

Contributing

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

Issues

Report all issues to the issues only repository.

JSON Schemas

This library provides JSON schemas for sfdx-project.json and scratch org definition files. These schemas are generated from Zod schemas that are also exported for runtime validation.

Importing JSON Schemas

// Import the JSON schema files directly
import sfdxProjectSchema from '@salesforce/core/sfdx-project.schema.json';
import scratchDefSchema from '@salesforce/core/project-scratch-def.schema.json';
Copy

Using Zod Schemas for Validation

.parse validates and the result is TS-typed. See zod docs for all the parsing options.

import { ProjectJsonSchema, ScratchOrgDefSchema } from '@salesforce/core';

// Validate and parse sfdx-project.json contents (throws on invalid)
const projectJson = ProjectJsonSchema.parse(projectJsonContents);

// Validate and parse scratch org definition
const scratchDef = ScratchOrgDefSchema.parse(scratchDefContents);
Copy

Using TestSetup

The Salesforce DX Core Library provides a unit testing utility to help with mocking and sand-boxing core components. This feature allows unit tests to execute without needing to make API calls to salesforce.com.

See the Test Setup documentation.

Message Transformer

The Messages class, by default, loads message text during run time. It's optimized to do this only per file.

If you're using @salesforce/core or other code that uses its Messages class in a bundler (webpack, esbuild, etc) it may struggle with these runtime references. Bundle from the compiled code (post-messageTranssformer)

src/messageTransformer will "inline" the messages into the js files during TS compile using https://github.com/nonara/ts-patch.

In your plugin or library,

yarn add --dev ts-patch

tsconfig.json

{
  ...
  "plugins": [{ "transform": "@salesforce/core/lib/messageTransformer", "import": "messageTransformer" }]
}
Copy

.sfdevrc.json, which gets merged into package.json

"wireit": {
    "compile": {
      "command": "tspc -p . --pretty --incremental",
      "files": [
        "src/**/*.ts",
        "tsconfig.json",
        "messages"
      ],
      "output": [
        "lib/**",
        "*.tsbuildinfo"
      ],
      "clean": "if-file-deleted"
    }
  }

Copy

Performance Testing

There are some benchmark.js checks to get a baseline for Logger performance. https://forcedotcom.github.io/sfdx-core/perf-Linux https://forcedotcom.github.io/sfdx-core/perf-Windows

You can add more test cases in test/perf/logger/main.js

If you add tests for new parts of sfdx-core outside of Logger, add new test Suites and create new jobs in the GHA perf.yml