JSPM

@jayree/sfdx-plugin-manifest

2.8.3
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1149
  • Score
    100M100P100Q124291F
  • License BSD-3-Clause

A Salesforce CLI plugin containing commands for creating manifest files from Salesforce orgs or git commits of sfdx projects.

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-manifest) 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-manifest

    A Salesforce CLI plugin containing commands for creating manifest files from Salesforce orgs or git commits of sfdx projects.

    sfdx NPM test-and-release Downloads/week License

    Install

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

    Commands

    sfdx jayree:manifest:beta:git:diff

    Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or delete based on changes in your git history.

    USAGE
      $ sfdx jayree:manifest:beta:git:diff REF1 [REF2] [--json] [--api-version <value>] [-d <value>] [--output-dir <value>]
        [--destructive-changes-only]
    
    ARGUMENTS
      REF1  Base commit or branch.
      REF2  Commit or branch to compare to the base commit.
    
    FLAGS
      -d, --source-dir=<value>...  Path to the local source files to include in the manifest.
      --api-version=<value>        Override the api version used for api requests made by this command
      --destructive-changes-only   Create a destructiveChanges manifest only.
      --output-dir=<value>         Directory to save the created manifest files.
    
    GLOBAL FLAGS
      --json  Format output as json.
    
    DESCRIPTION
      Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or
      delete based on changes in your git history.
    
      Use this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two
      git refs.
    
      You can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).
    
    EXAMPLES
      Uses the changes between two arbitrary <commit>.
    
        $ sfdx jayree:manifest:beta:git:diff <commit> <commit>
        $ sfdx jayree:manifest:beta:git:diff <commit>..<commit>
    
      Uses the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both
      <commit>.
    
        $ sfdx jayree:manifest:beta:git:diff <commit>...<commit>
    
      Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1).
    
        $ sfdx jayree:manifest:beta:git:diff branchA..branchB
    
      Uses the diff of what is unique in branchB (REF2).
    
        $ sfdx jayree:manifest:beta:git:diff branchA...branchB
    
      Specify the flags before or after the REF args
    
        $ sfdx jayree:manifest:beta:git:diff --output-dir package <commit> <commit>
        $ sfdx jayree:manifest:beta:git:diff <commit> <commit> --output-dir package
    
      If you specify the 'source-dir' flag before the REF args, use '--' to separate the args from the 'source-dir'
      values.
    
        $ sfdx jayree:manifest:beta:git:diff --source-dir force-app -- <commit> <commit>
    
    FLAG DESCRIPTIONS
      -d, --source-dir=<value>...  Path to the local source files to include in the manifest.
    
        The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
        (in which case the operation is applied to all metadata types in the directory and its subdirectories).
    
        You can specify this flag more than once.
    
      --destructive-changes-only  Create a destructiveChanges manifest only.
    
        Use this flag to create a 'destructiveChanges.xml' and a blank 'package.xml'.
    
      --output-dir=<value>  Directory to save the created manifest files.
    
        The location can be an absolute path or relative to the current working directory.

    See code: src/commands/jayree/manifest/beta/git/diff.ts

    sfdx jayree:manifest:cleanup

    Removes those tags from a manifest file that are present in a second manifest file.

    USAGE
      $ sfdx jayree:manifest:cleanup -f <value> [--json] [-x <value>]
    
    FLAGS
      -f, --file=<value>      (required) Path to the second 'cleanup' manifest file.
      -x, --manifest=<value>  Path to the manifest file.
    
    GLOBAL FLAGS
      --json  Format output as json.
    
    DESCRIPTION
      Removes those tags from a manifest file that are present in a second manifest file.
    
      Use this command to remove components or metadata types from a manifes file.
    
      If the 'cleanup' manifest file (--file) doesn't exist, a template file is created, which can then be modified.
    
    EXAMPLES
      $ sfdx jayree:manifest:cleanup --manifest=package.xml --file=packageignore.xml

    See code: src/commands/jayree/manifest/cleanup.ts

    sfdx jayree:manifest:generate

    Generate a complete manifest file form the specified org.

    USAGE
      $ sfdx jayree:manifest:generate -o <value> [--json] [--api-version <value>] [-q <value>] [-c] [-w] [--include-flow-versions]
        [-f <value>] [--exclude-managed | --exclude-all]
    
    FLAGS
      -c, --match-case               Enable 'match case' for the quickfilter.
      -f, --file=<value>             Write to 'file' instead of stdout.
      -o, --target-org=<value>       (required) Username or alias of the target org.
      -q, --quick-filter=<value>...  Metadata type, member or file path to filter on.
      -w, --match-whole-word         Enable 'match whole word' for the quickfilter.
      --api-version=<value>          Override the api version used for api requests made by this command
      --exclude-all                  Exclude all packages from output.
      --exclude-managed              Exclude managed packages from output.
      --include-flow-versions        Include flow versions as with api version 43.0.
    
    GLOBAL FLAGS
      --json  Format output as json.
    
    DESCRIPTION
      Generate a complete manifest file form the specified org.
    
      Use this command to generate a manifest file based on an existing org.
    
    EXAMPLES
      $ sfdx jayree:manifest:generate --targetusername myOrg@example.com
      <?xml version='1.0' encoding='UTF-8'?>
      <Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>

    See code: src/commands/jayree/manifest/generate.ts

    sfdx jayree:manifest:git:diff

    Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or delete based on changes in your git history.

    USAGE
      $ sfdx jayree:manifest:git:diff REF1 [REF2] [--json] [-d <value>] [--output-dir <value>] [--destructive-changes-only]
    
    ARGUMENTS
      REF1  Base commit or branch.
      REF2  Commit or branch to compare to the base commit.
    
    FLAGS
      -d, --source-dir=<value>...  Path to the local source files to include in the manifest.
      --destructive-changes-only   Create a destructiveChanges manifest only.
      --output-dir=<value>         Directory to save the created manifest files.
    
    GLOBAL FLAGS
      --json  Format output as json.
    
    DESCRIPTION
      Create a project manifest and destructiveChanges manifest that lists the metadata components you want to deploy or
      delete based on changes in your git history.
    
      Use this command to create a manifest and destructiveChanges manifest file based on the difference (git diff) of two
      git refs.
    
      You can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).
    
    EXAMPLES
      Uses the changes between two arbitrary <commit>.
    
        $ sfdx jayree:manifest:git:diff <commit> <commit>
        $ sfdx jayree:manifest:git:diff <commit>..<commit>
    
      Uses the changes on the branch containing and up to the second <commit>, starting at a common ancestor of both
      <commit>.
    
        $ sfdx jayree:manifest:git:diff <commit>...<commit>
    
      Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1).
    
        $ sfdx jayree:manifest:git:diff branchA..branchB
    
      Uses the diff of what is unique in branchB (REF2).
    
        $ sfdx jayree:manifest:git:diff branchA...branchB
    
      Specify the flags before or after the REF args
    
        $ sfdx jayree:manifest:git:diff --output-dir package <commit> <commit>
        $ sfdx jayree:manifest:git:diff <commit> <commit> --output-dir package
    
      If you specify the 'source-dir' flag before the REF args, use '--' to separate the args from the 'source-dir'
      values.
    
        $ sfdx jayree:manifest:git:diff --source-dir force-app -- <commit> <commit>
    
    FLAG DESCRIPTIONS
      -d, --source-dir=<value>...  Path to the local source files to include in the manifest.
    
        The supplied path can be to a single file (in which case the operation is applied to only one file) or to a folder
        (in which case the operation is applied to all metadata types in the directory and its subdirectories).
    
        You can specify this flag more than once.
    
      --destructive-changes-only  Create a destructiveChanges manifest only.
    
        Use this flag to create a 'destructiveChanges.xml' and a blank 'package.xml'.
    
      --output-dir=<value>  Directory to save the created manifest files.
    
        The location can be an absolute path or relative to the current working directory.

    See code: src/commands/jayree/manifest/git/diff.ts