JSPM

  • Created
  • Published
  • Downloads 373
  • Score
    100M100P100Q99917F
  • License BSD-3-Clause

A Salesforce CLI plugin containing commands to generate and compare sfdx source snapshot files or manipulate local source tracking.

Package Exports

    This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@jayree/sfdx-plugin-source) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

    Readme

    @jayree/sfdx-plugin-source

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

    sfdx NPM test-and-release Downloads/week License

    Install

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

    Commands

    sfdx jayree:source:snapshot:compare

    compares sfdx source snapshot files

    USAGE
      $ sfdx jayree:source:snapshot:compare [--json] [--filepath <value>]
    
    FLAGS
      --filepath=<value>  [default: ./sfdx-source-snapshot.json] path of the generated snapshot file
    
    GLOBAL FLAGS
      --json  Format output as json.

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

    sfdx jayree:source:snapshot:generate

    generates sfdx source snapshot files

    USAGE
      $ sfdx jayree:source:snapshot:generate [--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.

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

    sfdx jayree:source:tracking:list

    list changes in a scratch org by remote revision counter number

    USAGE
      $ sfdx jayree:source:tracking:list -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.
    
    EXAMPLES
      $ sfdx jayree:source:tracking:list
      $ sfdx jayree:source:tracking:list -u me@my.org
      $ sfdx jayree:source:tracking:list -u me@my.org -r 101

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

    sfdx jayree:source:tracking:store:get

    get stored revision counter number

    USAGE
      $ sfdx jayree:source:tracking:store:get -o <value> [--json]
    
    FLAGS
      -o, --target-org=<value>  (required) Username or alias of the target org.
    
    GLOBAL FLAGS
      --json  Format output as json.
    
    EXAMPLES
      $ sfdx jayree:source:tracking:store:get
      $ sfdx jayree:source:tracking:store:get -u me@my.org

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

    sfdx jayree:source:tracking:store:set

    store revision counter number

    USAGE
      $ sfdx jayree:source:tracking:store: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.
    
    EXAMPLES
      $ sfdx jayree:source:tracking:store:set
      $ sfdx jayree:source:tracking:store:set -u me@my.org
      $ sfdx jayree:source:tracking:store:set -u MyTestOrg1 -r 101

    See code: src/commands/jayree/source/tracking/store/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.