Merge pull request #42 from whyboris/ignore-files-flag

Ignore files command line flag

Author: rtfpessoa

README.md

@@ -71,7 +71,8 @@ Usage: diff2html [options] -- [diff args]
 | -o | --output | Output destination | `preview`, `stdout` | `preview` |
 | -u | --diffy | Upload to diffy.org | `browser`, `pbcopy`, `print` | |
 | -F | --file | Send output to file (overrides output option) | _[string]_ | |
-| --version | | Show version number | | |
+| --ig | --ignore | Ignore particular files from the diff | _[string]_ | |
+| -v | --version | | Show version number | | |
 | -h | --help | Show help | | |
 
 Examples:
@@ -99,6 +100,8 @@ Examples:
     - `//diff2html-synchronisedScroll` - writes code to support selected scroll interaction, must be within a `<script>` block
     - `<!--diff2html-diff-->` - writes diff content to page
 
+`diff2htal --ig package-lock.json --ig yarn.lock`
+- Ignore `package-lock.json` and `yarn.lock` from the generated diff
 
 _NOTE_: notice the `--` in the examples
 
@@ -108,6 +111,10 @@ This is a developer friendly project, all the contributions are welcome.
 To contribute just send a pull request with your changes following the guidelines described in `CONTRIBUTING.md`.
 I will try to review them as soon as possible.
 
+## Developing
+
+Make some changes and then `node src/main.js` 😉
+
 ## License
 
 Copyright 2014-2019 Rodrigo Fernandes. Released under the terms of the MIT license.

src/cli.js

@@ -26,7 +26,7 @@
    * Input
    */
 
-  Diff2HtmlInterface.prototype.getInput = function getInput(inputType, inputArgs, callback) {
+  Diff2HtmlInterface.prototype.getInput = function getInput(inputType, inputArgs, ignore, callback) {
     var that = this;
     switch (inputType) {
       case 'file':
@@ -38,12 +38,13 @@
         break;
 
       default:
-        that._runGitDiff(inputArgs, callback);
+        that._runGitDiff(inputArgs, ignore, callback);
     }
   };
 
-  Diff2HtmlInterface.prototype._runGitDiff = function(gitArgsArr, callback) {
+  Diff2HtmlInterface.prototype._runGitDiff = function(gitArgsArr, ignore, callback) {
     var gitArgs;
+
     if (gitArgsArr.length && gitArgsArr[0]) {
       gitArgs = gitArgsArr.map(function(arg) {
         return '"' + arg + '"'; // wrap parameters
@@ -56,7 +57,16 @@
       gitArgs += ' --no-color';
     }
 
-    var diffCommand = 'git diff ' + gitArgs;
+    var ignoreString = '';
+
+    if (ignore) {
+      ignoreString = ignore.map(function(file) {
+        return ' ":(exclude)' + file + '" ';
+      }).join(' ');
+    }
+
+    var diffCommand = 'git diff ' + gitArgs + ignoreString;
+
     return callback(null, utils.runCmd(diffCommand));
   };
 

src/main.js

@@ -137,13 +137,24 @@ var argv = yargs.usage('Usage: diff2html [options] -- [diff args]')
       type: 'string'
     }
   })
+  .options({
+    'ig': {
+      alias: 'ignore',
+      describe: 'ignore a file',
+      nargs: 1,
+      type: 'array'
+    }
+  })
   .example('diff2html -s line -f html -d word -i command -o preview -- -M HEAD~1',
     'diff last commit, line by line, word comparison between lines,' +
     'previewed in the browser and input from git diff command')
   .example('diff2html -i file -- my-file-diff.diff', 'reading the input from a file')
   .example('diff2html -f json -o stdout -- -M HEAD~1', 'print json format to stdout')
   .example('diff2html -F my-pretty-diff.html -- -M HEAD~1', 'print to file')
+  .example('diff2html --ig -- package-lock.json --ig yarn.lock',
+    'ignore two particular files when generating the diff')
   .help('h')
+  .alias('v', 'version')
   .alias('h', 'help')
   .epilog('© 2014-' + currentYear + ' rtfpessoa\n' +
     'For more information, check out https://diff2html.xyz/\n' +
@@ -193,4 +204,4 @@ function onOutput(err, output) {
   }
 }
 
-cli.getInput(argv.input, argv._, onInput);
+cli.getInput(argv.input, argv._, argv.ig, onInput);