Add --keep and -k flags to the CLI. (#12)

.gitignore

@@ -4,3 +4,4 @@ node_modules
 .DS_Store
 dist
 bin
+.history

.npmignore

@@ -1,3 +1,4 @@
 .ref
 .tmp
 .DS_Store
+.history

README.md

@@ -38,6 +38,14 @@ This utility can recover from most errors, and as such, it will continue to **se
 
 A summary is displayed when the entire batch transcoding operation is finished. The summary includes the overall number of errors encountered and files successfully created.
 
+### Before You Begin
+
+**WARNING:** If the program cannot successfully transcode an input file, and then verify the output video file, it will be marked as _errored_ and the transcoded file (if one exists) will be deleted from the output directory. This is done to prevent partially-transcoded files from remaining in the output directory that then need to be manually deleted before retrying the transcoding operation.
+
+If you run the program using an output directory containing previously-transcoded video, especially for source files that still exist in your input directory, you **must** use the `--diff` option to ensure sucessful transcodes from previous batches are not deleted from the output directory. In `--diff` mode, input files are skipped when their corresponding output files already exist in the output directory.
+
+Alternatively, you can use the `--keep` option to ensure files are never deleted from the output directory, even if they have errors or failed to finish transcoding. However, subsequent runs, with or without using the `--diff` option, will not reprocess failed input files, unless the corresponding output files are manually deleted.
+
 ### Instructions
 
 Recursively search for videos to transcode using [video_transcoding](https://github.com/donmelton/video_transcoding). If an `input` **directory** is not specified then the current directory will be used as the input directory.
@@ -118,6 +126,8 @@ batch.cli();
   - Do not preserve relative directory structure in output directory. If this is enabled, the base output folder will contain all transcoded videos. Note: this option has no effect unless you specify an `output` directory.
 - `--quiet` _Flag: does not accept a value_ (Default: `false`)
   - Prevents **any** logging to stdout and will only exit `0` on success or `1` on error
+- `--keep` _Flag: does not accept a value_ (Default: `false`) (Alias: `-k`)
+  - **Never delete any output files**, no matter what happens, **even if the encoding task fails** for the corresponding input file. If you use this option, input files that fail to encode correctly, or finish encoding, will not be deleted from the output folder. Subsequent runs, with or without using the `--diff` option, will not reprocess the failed input files, unless the corresponding output files are manually deleted.
 
 ### Providing options to transcode-video
 

batch-transcode-video.js

@@ -14,10 +14,11 @@ let defs = {
     mask: 'm',
     help: 'h',
     version: 'v',
-    force: 'f'
+    force: 'f',
+    keep: 'k'
   },
   boolean: [
-    'debug', 'quiet', 'flatten', 'diff', 'help', 'version'
+    'debug', 'quiet', 'flatten', 'diff', 'help', 'version', 'keep'
   ],
   string: [
     'input', 'output', 'mask', 'force'

index-cli.js

@@ -44,7 +44,7 @@ export default class CliBatchTranscodeVideo extends BatchTranscodeVideo {
             if (file.isRunning) {
               file.status = VideoFile.ERRORED;
             }
-            if (file.isErrored) {
+            if (file.isErrored && this.options['keep'] !== true) {
               // Try and delete the destination file if it exists
               unlinkSync(file.destFilePath);
             }

lib/default-options.js

@@ -6,7 +6,7 @@ export default {
   // Output folder
   output: null,
   // Search pattern for glob in input directory
-  mask: '**' + path.sep + '*.{mp4,avi,mkv,m4v,ts,mov}',
+  mask: '**' + path.sep + '*.{mp4,avi,mkv,m4v,ts,mov,vob}',
   // Verbose logging
   debug: false,
   // Do not preserve relative directory structure in output directory
@@ -17,5 +17,7 @@ export default {
   diff: false,
   // If crop detection returns multiple values then take the least extreme crop
   force: false,
+  // Never delete any output files, no matter what happens
+  keep: false,
   help: false
 };

lib/help.js

@@ -41,6 +41,11 @@ const args = [
   {
     arg: 'quiet',
     desc: 'Do not log output messages to command line, only exit 0 if successful or 1 if there are errors. This will disable the progress bars that display the current progress and remaining time estimates and also the summary output (writes, errors, stats) at end of process.'
+  },
+  {
+    arg: 'keep',
+    desc: 'Never delete any output files, no matter what happens, even if the encoding task fails for the corresponding input file. If you use this option, input files that fail to encode correctly, or finish encoding, will not be deleted from the output folder. Subsequent runs, with or without using the --diff option, will not reprocess the failed input files, unless the corresponding output files are manually deleted.',
+    alias: 'k'
   }
 ];