Merge branch 'master' into unit-testing

Author: whyboris

README.md

@@ -54,60 +54,70 @@ Diff to Html generates pretty HTML diffs from unified and git diff output in you
 
 ## Usage
 
-    Usage: diff2html [options] -- [diff args]
-
-    Options:
-      -s, --style                       Output style   [choices: "line", "side"] [default: "line"]
-      --sc, --synchronisedScroll        Synchronised horizontal scroll   [choices: "enabled", "disabled"] [default: "enabled"]
-      --su, --summary                   Show files summary   [choices: "closed", "open", "hidden"] [default: "closed"]
-      --lm, --matching                  Diff line matching type   [choices: "lines", "words", "none"] [default: "none"]
-      --lmt, --matchWordsThreshold      Diff line matching word threshold   [default: "0.25"]
-      --lmm, --matchingMaxComparisons   Diff line matching maximum line comparisons of a block of changes [default: 2500]
-      --hwt, --htmlWrapperTemplate      Path to custom template to be rendered when using the "html" output format [string]
-      -f, --format                      Output format   [choices: "html", "json"] [default: "html"]
-      -d, --diff                        Diff style   [choices: "word", "char"] [default: "word"]
-      -i, --input                       Diff input source   [choices: "file", "command", "stdin"] [default: "command"]
-      -o, --output                      Output destination   [choices: "preview", "stdout"] [default: "preview"]
-      -u, --diffy                       Upload to diffy.org   [choices: "browser", "pbcopy", "print"]
-      -F, --file                        Send output to file (overrides output option)   [string]
-      --version                         Show version number
-      -h, --help                        Show help
-
-    Examples:
-      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
-      diff2html -i file -- my-file-diff.diff
-          -> reading the input from a file
-      diff -u file1.txt file2.txt | diff2html -i stdin
-          -> reading diff from stdin
-      diff2html -f json -o stdout -- -M HEAD~1
-          -> print json format to stdout
-      diff2html -F my-pretty-diff.html -- -M HEAD~1
-          ->  print to file
-      diff2html -F my-pretty-diff.html --hwt my-custom-template.html -- -M HEAD~1
-          ->  print to file using custom markup
-              templates can include the following variables:
-                `<!--diff2html-css-->` - writes default CSS to page
-                `<!--diff2html-js-ui-->` - writes default JavaScript UI scripts to page
-                `//diff2html-fileListCloseable` - writes code to support selected list interaction, must be within a <script> block
-                `//diff2html-synchronisedScroll` - writes code to support selected scroll interaction, must be within a <script> block
-                `<!--diff2html-diff-->` - writes diff content to page
-
-    © 2014-2016 rtfpessoa
-    For support, check out https://github.com/rtfpessoa/diff2html-cli
-
-> NOTE: notice the `--` in the examples
+Usage: diff2html [options] -- [diff args]
+
+| flag | alias | description | choices | default |
+| --- | --- | --- | --- | --- |
+| -s  | --style |  Output style | `line`, `side` | `line` |
+| --sc | --synchronisedScroll | Synchronised horizontal scroll | `enabled`, `disabled` | `enabled` |
+| --su | --summary | Show files summary | `closed`, `open`, `hidden` | `closed` |
+| --lm | --matching | Diff line matching type | `lines`, `words`, `none` | `none` |
+| --lmt | --matchWordsThreshold | Diff line matching word threshold | | `0.25` |
+| --lmm | --matchingMaxComparisons | Diff line matching maximum line comparisons of a block of changes | `2500` |
+| --hwt | --htmlWrapperTemplate | Path to custom template to be rendered when using the `html` output format | _[string]_ |
+| -f | --format | Output format | `html`, `json` | `html` |
+| -d | --diff | Diff style | `word`, `char` | `word` |
+| -i | --input | Diff input source | `file`, `command`, `stdin` | `command` |
+| -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]_ | |
+| --ig | --ignore | Ignore particular files from the diff | _[string]_ | |
+| -v | --version | | Show version number | | |
+| -h | --help | Show help | | |
+
+Examples:
+
+`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
+
+`diff2html -i file -- my-file-diff.diff`
+- reading the input from a file
+
+`diff -u file1.txt file2.txt | diff2html -i stdin`
+- reading diff from stdin
+
+`diff2html -f json -o stdout -- -M HEAD~1`
+- print json format to stdout
+
+`diff2html -F my-pretty-diff.html -- -M HEAD~1`
+-  print to file
+
+`diff2html -F my-pretty-diff.html --hwt my-custom-template.html -- -M HEAD~1`
+-  print to file using custom markup templates can include the following variables:
+    - `<!--diff2html-css-->` - writes default CSS to page
+    - `<!--diff2html-js-ui-->` - writes default JavaScript UI scripts to page
+    - `//diff2html-fileListCloseable` - writes code to support selected list interaction, must be within a `<script>` block
+    - `//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
 
 ## Contributions
 
 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-2016 Rodrigo Fernandes. Released under the terms of the MIT license.
+Copyright 2014-2019 Rodrigo Fernandes. Released under the terms of the MIT license.
 
 ## Thanks
 

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