@jayree/sfdx-plugin-manifest 2.9.1 → 3.0.0

package/CHANGELOG.md

@@ -1,3 +1,15 @@
+# [3.0.0](https://github.com/jayree/sfdx-plugin-manifest/compare/v2.9.1...v3.0.0) (2023-03-03)
+
+
+### Features
+
+* **manifest:git:diff:** make :beta:git:diff the default command. The old command is available as :legacy:git:diff ([2f4b9dc](https://github.com/jayree/sfdx-plugin-manifest/commit/2f4b9dc80dd3a4e6241c44907a88c5f00bcade63))
+
+
+### BREAKING CHANGES
+
+* **manifest:git:diff:** This change makes :beta:git:diff the default command.
+
 ## [2.9.1](https://github.com/jayree/sfdx-plugin-manifest/compare/v2.9.0...v2.9.1) (2023-03-03)
 
 

package/README.md

@@ -21,6 +21,7 @@ sfdx plugins:install @jayree/sfdx-plugin-manifest
 * [`sfdx jayree:manifest:cleanup`](#sfdx-jayreemanifestcleanup)
 * [`sfdx jayree:manifest:generate`](#sfdx-jayreemanifestgenerate)
 * [`sfdx jayree:manifest:git:diff`](#sfdx-jayreemanifestgitdiff)
+* [`sfdx jayree:manifest:legacy:git:diff`](#sfdx-jayreemanifestlegacygitdiff)
 
 ### `sfdx jayree:manifest:beta:git:diff`
 
@@ -53,6 +54,9 @@ DESCRIPTION
 
   You can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).
 
+ALIASES
+  $ sfdx jayree:manifest:beta:git:diff
+
 EXAMPLES
   Uses the changes between two arbitrary <commit>.
 
@@ -99,8 +103,6 @@ FLAG DESCRIPTIONS
     The location can be an absolute path or relative to the current working directory.
 ```
 
-_See code: [src/commands/jayree/manifest/beta/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v2.9.1/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.
@@ -127,7 +129,7 @@ EXAMPLES
   $ sfdx jayree:manifest:cleanup --manifest=package.xml --file=packageignore.xml
 ```
 
-_See code: [src/commands/jayree/manifest/cleanup.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v2.9.1/src/commands/jayree/manifest/cleanup.ts)_
+_See code: [src/commands/jayree/manifest/cleanup.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v3.0.0/src/commands/jayree/manifest/cleanup.ts)_
 
 ### `sfdx jayree:manifest:generate`
 
@@ -163,7 +165,7 @@ EXAMPLES
   <Package xmlns='http://soap.sforce.com/2006/04/metadata'>...</Package>
 ```
 
-_See code: [src/commands/jayree/manifest/generate.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v2.9.1/src/commands/jayree/manifest/generate.ts)_
+_See code: [src/commands/jayree/manifest/generate.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v3.0.0/src/commands/jayree/manifest/generate.ts)_
 
 ### `sfdx jayree:manifest:git:diff`
 
@@ -171,7 +173,8 @@ Create a project manifest and destructiveChanges manifest that lists the metadat
 
 ```
 USAGE
-  $ sfdx jayree:manifest:git:diff REF1 [REF2] [--json] [-d <value>] [--output-dir <value>] [--destructive-changes-only]
+  $ sfdx jayree:manifest:git:diff REF1 [REF2] [--json] [--api-version <value>] [-d <value>] [--output-dir <value>]
+    [--destructive-changes-only]
 
 ARGUMENTS
   REF1  Base commit or branch.
@@ -179,6 +182,7 @@ ARGUMENTS
 
 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.
 
@@ -194,6 +198,9 @@ DESCRIPTION
 
   You can use all ways to spell <commit> which are valid for 'git diff' (See https://git-scm.com/docs/git-diff).
 
+ALIASES
+  $ sfdx jayree:manifest:beta:git:diff
+
 EXAMPLES
   Uses the changes between two arbitrary <commit>.
 
@@ -240,5 +247,83 @@ FLAG DESCRIPTIONS
     The location can be an absolute path or relative to the current working directory.
 ```
 
-_See code: [src/commands/jayree/manifest/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v2.9.1/src/commands/jayree/manifest/git/diff.ts)_
+_See code: [src/commands/jayree/manifest/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v3.0.0/src/commands/jayree/manifest/git/diff.ts)_
+
+### `sfdx jayree:manifest:legacy: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:legacy: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:legacy:git:diff <commit> <commit>
+    $ sfdx jayree:manifest:legacy: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:legacy:git:diff <commit>...<commit>
+
+  Uses the diff of what is unique in branchB (REF2) and unique in branchA (REF1).
+
+    $ sfdx jayree:manifest:legacy:git:diff branchA..branchB
+
+  Uses the diff of what is unique in branchB (REF2).
+
+    $ sfdx jayree:manifest:legacy:git:diff branchA...branchB
+
+  Specify the flags before or after the REF args
+
+    $ sfdx jayree:manifest:legacy:git:diff --output-dir package <commit> <commit>
+    $ sfdx jayree:manifest:legacy: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:legacy: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/legacy/git/diff.ts](https://github.com/jayree/sfdx-plugin-manifest/blob/v3.0.0/src/commands/jayree/manifest/legacy/git/diff.ts)_
 <!-- commandsstop -->

package/lib/commands/jayree/manifest/git/diff.d.ts

@@ -1,37 +1,40 @@
 import { SfCommand } from '@salesforce/sf-plugins-core';
 import { Optional } from '@salesforce/ts-types';
 export interface GitDiffCommandResult {
-    destructiveChanges: object;
-    manifest: object;
+    manifest?: {
+        path: string;
+        name: string;
+    };
+    destructiveChanges?: {
+        path: string;
+        name: string;
+    };
 }
-export default class GitDiff extends SfCommand<GitDiffCommandResult> {
+export default class GitDiffCommand extends SfCommand<GitDiffCommandResult> {
     static readonly summary: string;
     static readonly description: string;
     static readonly examples: string[];
     static readonly args: {
-        ref1: import("@oclif/core/lib/interfaces/parser").Arg<string, Record<string, unknown>>;
-        ref2: import("@oclif/core/lib/interfaces/parser").Arg<string | undefined, Record<string, unknown>>;
+        ref1: import("@oclif/core/lib/interfaces/parser.js").Arg<string, Record<string, unknown>>;
+        ref2: import("@oclif/core/lib/interfaces/parser.js").Arg<string | undefined, Record<string, unknown>>;
     };
     static readonly requiresProject = true;
+    static readonly deprecateAliases = true;
+    static readonly aliases: string[];
     static readonly flags: {
-        'source-dir': import("@oclif/core/lib/interfaces").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        'output-dir': import("@oclif/core/lib/interfaces").OptionFlag<string, import("@oclif/core/lib/interfaces/parser").CustomOptions>;
-        'destructive-changes-only': import("@oclif/core/lib/interfaces").BooleanFlag<boolean>;
+        'api-version': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'source-dir': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string[] | undefined, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'output-dir': import("@oclif/core/lib/interfaces/parser.js").OptionFlag<string, import("@oclif/core/lib/interfaces/parser.js").CustomOptions>;
+        'destructive-changes-only': import("@oclif/core/lib/interfaces/parser.js").BooleanFlag<boolean>;
     };
-    private isOutputEnabled;
     private outputDir;
-    private destructiveChangesOnly;
-    private projectRoot;
-    private sourceApiVersion;
-    private destructiveChanges;
-    private manifest;
-    private gitLines;
-    private ref1VirtualTreeContainer;
-    private ref2VirtualTreeContainer;
+    private manifestName;
+    private destructiveChangesName;
+    private outputPath;
     private componentSet;
-    private outputErrors;
-    private outputWarnings;
-    private fsPaths;
+    private destructiveChangesOnly;
     run(): Promise<GitDiffCommandResult>;
     protected getSourceApiVersion(): Promise<Optional<string>>;
+    protected createManifest(): Promise<void>;
+    protected formatResult(): GitDiffCommandResult;
 }