@jayree/sfdx-plugin-source

@jayree/sfdx-plugin-source

A Salesforce CLI plugin containing commands to generate and compare sfdx source snapshot files.

Install

sfdx plugins:install @jayree/sfdx-plugin-source

Commands

• sfdx jayree:project:compare:snapshot
• sfdx jayree:project:fix
• sfdx jayree:project:generate:snapshot
• sfdx jayree:project:list:tracking
• sfdx jayree:project:store:tracking:get
• sfdx jayree:project:store:tracking:set

sfdx jayree:project:compare:snapshot

Compare sfdx source snapshot files.

USAGE
  $ sfdx jayree:project:compare:snapshot [--json] [--filepath <value>]

FLAGS
  --filepath=<value>  [default: ./sfdx-source-snapshot.json] Path of the generated snapshot file.

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:snapshot:compare

See code: src/commands/jayree/project/compare/snapshot.ts

sfdx jayree:project:fix

Fix retrieved metadata.

USAGE
  $ sfdx jayree:project:fix [--json] [-o <value>] [-t <value>]

FLAGS
  -o, --target-org=<value>
  -t, --task=<value>...     Task name(s) listed in sfdx-project.json.

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:fix

See code: src/commands/jayree/project/fix.ts

sfdx jayree:project:generate:snapshot

Generate sfdx source snapshot files.

USAGE
  $ sfdx jayree:project:generate:snapshot [--json] [--filepath <value>]

FLAGS
  --filepath=<value>  [default: ./sfdx-source-snapshot.json] Path to save the generated snapshot file.

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:snapshot:generate

See code: src/commands/jayree/project/generate/snapshot.ts

sfdx jayree:project:list:tracking

List changes in a scratch org by remote revision counter number.

USAGE
  $ sfdx jayree:project:list:tracking -o <value> [--json] [--api-version <value>] [-r <value>]

FLAGS
  -o, --target-org=<value>  (required) Username or alias of the target org.
  -r, --revision=<value>    Start at a specific revision counter number.
  --api-version=<value>     Override the api version used for api requests made by this command

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:tracking:list

EXAMPLES
  $ sfdx jayree:source:tracking:list
  $ sfdx jayree:source:tracking:list -u [e-mail]
  $ sfdx jayree:source:tracking:list -u [e-mail] -r 101

See code: src/commands/jayree/project/list/tracking.ts

sfdx jayree:project:store:tracking:get

Get stored revision counter number.

USAGE
  $ sfdx jayree:project:store:tracking:get -o <value> [--json]

FLAGS
  -o, --target-org=<value>  (required) Username or alias of the target org.

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:tracking:store:get

EXAMPLES
  $ sfdx jayree:source:tracking:store:get
  $ sfdx jayree:source:tracking:store:get -u [e-mail]

See code: src/commands/jayree/project/store/tracking/get.ts

sfdx jayree:project:store:tracking:set

Store revision counter number.

USAGE
  $ sfdx jayree:project:store:tracking:set -o <value> [--json] [--api-version <value>] [-r <value>]

FLAGS
  -o, --target-org=<value>  (required) Username or alias of the target org.
  -r, --revision=<value>    Revision counter number (default: remote revision counter number).
  --api-version=<value>     Override the api version used for api requests made by this command

GLOBAL FLAGS
  --json  Format output as json.

ALIASES
  $ sfdx jayree:source:tracking:store:set

EXAMPLES
  $ sfdx jayree:source:tracking:store:set
  $ sfdx jayree:source:tracking:store:set -u [e-mail]
  $ sfdx jayree:source:tracking:store:set -u MyTestOrg1 -r 101

See code: src/commands/jayree/project/store/tracking/set.ts

Hooks

prerun

• Resets source tracking using force:source:tracking:reset before executing force:source:pull or project:retrieve:start.

IMPORTANT: This hook will only run if SFDX_ENABLE_JAYREE_HOOKS_RESET_BEFORE_PULL=true is set. It uses the stored serverMaxRevisionCounter as revision counter number (see: jayree:source:tracking:store:set). If the hook doesn't find a stored value it asks if the current local revision counter number should be stored and used.

scopedPreRetrieve

• Disables the prettierFormat hook. See sfdx-plugin-prettier for more details.

scopedPostRetrieve (plugin-source plugin) / postsourceupdate (legacy salesforce-alm plugin)

• Applies source fixes of the jayree project fix command, deletes and moves source files to separate package directories. See the configuration file sfdx-project.json for examples. Set "isActive": true,´ to apply this fix during scopedPostRetrieve` hook.

IMPORTANT: Since the hook is not able to update the (JSON) output of the command, an additional output is generated. Set the environment variable SFDX_ENABLE_JAYREE_HOOKS_JSON_OUTPUT=true and additional comma-separated JSON output will be appended, where the output must be parsed as an array, e.g. JSON.parse(`[${stdout}]`). See an example below:

import execa from "execa";
import { CliUx } from "@oclif/core";

async function run() {
  const { stdout } = await execa("sfdx", [
    "force:source:retrieve",
    "--metadata",
    "Group:*",
    "--json"
  ]);
  const parsedStdout = JSON.parse(`[${stdout}]`);
  CliUx.ux.styledJSON(
    parsedStdout.length > 1
      ? {
          ...parsedStdout[0],
          result: {
            ...parsedStdout[0].result,
            fixedFiles: parsedStdout[1].fixedFiles
          }
        }
      : parsedStdout[0]
  );
}

run();

• Calls prettierFormat hook. See sfdx-plugin-prettier for more details.

Changelog

1.3.1 (2023-05-23)

Bug Fixes

• deps: bump @salesforce/sf-plugins-core from 2.4.3 to 3.0.1 (#199) (ae5feee)

Features

• align topics with sf topics (acb11ae)