Merge pull request #10 from rtfpessoa/improve-project

Improve project code quality, style and docs

Author: rtfpessoa

config.jscs.json .jscsrcconfig.jscs.json renamed to .jscsrc

@@ -6,21 +6,23 @@
     "else"
   ],
   "disallowMixedSpacesAndTabs": true,
-  "disallowMultipleVarDecl": "exceptUndefined",
+  "disallowMultipleVarDecl": {
+    "allExcept": [
+      "undefined"
+    ]
+  },
   "disallowNewlineBeforeBlockStatements": true,
-  "disallowQuotedKeysInObjects": null,
   "disallowSpaceAfterObjectKeys": true,
   "disallowSpaceAfterPrefixUnaryOperators": true,
   "disallowSpacesInFunction": {
     "beforeOpeningRoundBrace": true
   },
   "disallowSpacesInsideParentheses": true,
   "disallowTrailingWhitespace": true,
-  "maximumLineLength": 90,
+  "maximumLineLength": 130,
   "requireCamelCaseOrUpperCaseIdentifiers": true,
   "requireCapitalizedComments": true,
   "requireCapitalizedConstructors": true,
-  "requireCurlyBraces": true,
   "requireSpaceAfterKeywords": [
     "if",
     "else",
@@ -44,6 +46,5 @@
   },
   "requireTrailingComma": null,
   "validateIndentation": 2,
-  "validateLineBreaks": "LF",
-  "validateQuoteMarks": "'"
+  "validateLineBreaks": "LF"
 }

CONTRIBUTING.md

@@ -0,0 +1,62 @@
+## How to contribute to diff2html-cli
+
+### Main rules
+
+* Before you open a ticket or send a pull request, [search](https://github.com/rtfpessoa/diff2html-cli/issues) for previous discussions about the same feature or issue. Add to the earlier ticket if you find one.
+
+* If you're proposing a new feature, make sure you create an issue to let other contributors know what you are working on.
+
+* Before sending a pull request make sure your code is tested.
+
+* Before sending a pull request for a feature, be sure to run tests with `npm test`.
+
+* Use the same coding style as the rest of the codebase, most of the check can be performed with `npm run style`.
+
+* Use `git rebase` (not `git merge`) to sync your work from time to time with the master branch.
+
+* After creating your pull request make sure the build is passing on [CircleCI](https://circleci.com/gh/rtfpessoa/diff2html-cli)
+and that [Codacy](https://www.codacy.com/app/Codacy/diff2html-cli) is also confident in the code quality.
+
+* In your pull request, do not commit the `dist` or `build` folder if you needed to build the release files.
+
+### Commit Style
+
+Writing good commit logs is important. A commit log should describe what changed and why.
+Follow these guidelines when writing one:
+
+1. The first line should be 50 characters or less and contain a short
+   description of the change prefixed with the name of the changed
+   subsystem (e.g. "net: add localAddress and localPort to Socket").
+2. Keep the second line blank.
+3. Wrap all other lines at 72 columns.
+
+A good commit log can look something like this:
+
+```
+subsystem: explaining the commit in one line
+
+Body of commit message is a few lines of text, explaining things
+in more detail, possibly giving some background about the issue
+being fixed, etc. etc.
+
+The body of the commit message can be several paragraphs, and
+please do proper word-wrap and keep columns shorter than about
+72 characters or so. That way `git log` will show things
+nicely even when it is indented.
+```
+
+### Developer's Certificate of Origin 1.0
+
+By making a contribution to this project, I certify that:
+
+* (a) The contribution was created in whole or in part by me and I
+  have the right to submit it under the open source license indicated
+  in the file; or
+* (b) The contribution is based upon previous work that, to the best
+  of my knowledge, is covered under an appropriate open source license
+  and I have the right under that license to submit that work with
+  modifications, whether created in whole or in part by me, under the
+  same open source license (unless I am permitted to submit under a
+  different license), as indicated in the file; or
+* (c) The contribution was provided directly to me by some other
+  person who certified (a), (b) or (c) and I have not modified it.

README.md

@@ -1,6 +1,17 @@
-# Diff to Html CLI by [rtfpessoa](https://github.com/rtfpessoa)
+# diff2html-cli
 
-[![Codacy Badge](https://api.codacy.com/project/badge/grade/e6139937d72f40ed8b3920d53c74298a)](https://www.codacy.com/app/Codacy/diff2html-cli)
+[![Circle CI](https://circleci.com/gh/rtfpessoa/diff2html-cli.svg?style=svg)](https://circleci.com/gh/rtfpessoa/diff2html-cli)
+[![Codacy Code Badge](https://api.codacy.com/project/badge/grade/e6139937d72f40ed8b3920d53c74298a)](https://www.codacy.com/app/Codacy/diff2html-cli)
+[![Codacy Coverage Badge](https://api.codacy.com/project/badge/coverage/e6139937d72f40ed8b3920d53c74298a)](https://www.codacy.com/app/Codacy/diff2html-cli)
+
+[![npm](https://img.shields.io/npm/v/diff2html-cli.svg)](https://www.npmjs.com/package/diff2html-cli)
+[![David](https://img.shields.io/david/rtfpessoa/diff2html-cli.svg)](https://david-dm.org/rtfpessoa/diff2html-cli)
+[![David](https://img.shields.io/david/dev/rtfpessoa/diff2html-cli.svg)](https://david-dm.org/rtfpessoa/diff2html-cli)
+
+[![node](https://img.shields.io/node/v/diff2html-cli.svg)]()
+[![npm](https://img.shields.io/npm/l/diff2html-cli.svg)]()
+[![npm](https://img.shields.io/npm/dm/diff2html-cli.svg)](https://www.npmjs.com/package/diff2html-cli)
+[![Gitter](https://badges.gitter.im/rtfpessoa/diff2html.svg)](https://gitter.im/rtfpessoa/diff2html?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
 
 Diff to Html generates pretty HTML diffs from git diff output in your terminal
 
@@ -16,6 +27,8 @@ Diff to Html generates pretty HTML diffs from git diff output in your terminal
 
 * Code syntax highlight
 
+* Line similarity matching
+
 ## Online Example
 
 > Go to [Diff2HTML](http://rtfpessoa.github.io/diff2html/)
@@ -38,47 +51,43 @@ Diff to Html generates pretty HTML diffs from git diff output in your terminal
 
 ## Usage
 
-    diff2html [options] -- [diff args]
-
+    Usage: diff2html [options] -- [diff args]
 
     Options:
-      -s, --style   Output style
-                                [string] [choices: "line", "side"] [default: "line"]
-      -f, --format  Output format
-                                [string] [choices: "html", "json"] [default: "html"]
-      -d, --diff    Diff style  [string] [choices: "word", "char"] [default: "word"]
-      -i, --input   Diff input source
-                 [string] [choices: "file", "command", "stdin"] [default: "command"]
-      -o, --output  Output destination
-                        [string] [choices: "preview", "stdout"] [default: "preview"]
-      -u, --diffy   Upload to diffy.org
-                                    [string] [choices: "browser", "pbcopy", "print"]
-      -F, --file    Send output to file (overrides output option)           [string]
-      --version     Show version number                                    [boolean]
-      -h, --help    Show help                                              [boolean]
-
+      -s, --style                   Output style   [string] [choices: "line", "side"] [default: "line"]
+      --su, --summary               Show files summary   [boolean] [default: "true"]
+      --lm, --matching              Diff line matching type   [string] [choices: "lines", "words", "none"] [default: "none"]
+      --lmt, --matchWordsThreshold  Diff line matching word threshold   [string] [default: "0.25"]
+      -f, --format                  Output format   [string] [choices: "html", "json"] [default: "html"]
+      -d, --diff                    Diff style   [string] [choices: "word", "char"] [default: "word"]
+      -i, --input                   Diff input source   [string] [choices: "file", "command", "stdin"] [default: "command"]
+      -o, --output                  Output destination   [string] [choices: "preview", "stdout"] [default: "preview"]
+      -u, --diffy                   Upload to diffy.org   [string] [choices: "browser", "pbcopy", "print"]
+      -F, --file                    Send output to file (overrides output option)   [string]
+      --version                     Show version number                    [boolean]
+      -h, --help                    Show help                              [boolean]
 
     Examples:
-      diff2html -s line -f html -d word -i      diff last commit, line by line, word
-      command -o preview -- -M HEAD~1           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
-      diff2html -f json -o stdout -- -M HEAD~1  print json format to stdout
-      diff2html -F my-pretty-diff.html -- -M    print to file
-      HEAD~1
-
-
-    © 2015 rtfpessoa
+      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
+      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
+
+    © 2014 rtfpessoa
     For support, check out https://github.com/rtfpessoa/diff2html-cli
 
 > NOTE: notice the `--` in the examples
 
 ## Contributions
 
-All the contributions are welcome.
-
-To contribute just send a pull request with your changes and I will review it asap.
+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.
 
 ## License
 

circle.yml

@@ -0,0 +1,9 @@
+test:
+  override:
+    - nvm install 0.12 && npm test
+    - nvm install 4 && npm test
+  post:
+    - npm install
+    - istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec
+    - cat ./coverage/lcov.info | ./node_modules/.bin/codacy-coverage
+    - rm -rf ./coverage

package.json

@@ -36,19 +36,25 @@
   },
   "preferGlobal": "true",
   "scripts": {
-    "test": ""
+    "test": "mocha",
+    "style": "jscs src test",
+    "codacy": "istanbul cover ./node_modules/mocha/bin/_mocha --report lcovonly -- -R spec && cat ./coverage/lcov.info | ./node_modules/.bin/codacy-coverage && rm -rf ./coverage"
   },
   "bin": {
     "diff2html": "./bin/diff2html"
   },
   "main": "./src/main.js",
   "dependencies": {
-    "yargs": "3.31.*",
-    "extend": "3.0.*",
-    "request": "2.67.*",
-    "diff2html": "*"
+    "yargs": "^3.31.0",
+    "extend": "^3.0.0",
+    "request": "^2.67.0",
+    "diff2html": "1.2.0"
   },
   "devDependencies": {
+    "codacy-coverage": "^1.1.3",
+    "istanbul": "^0.4.1",
+    "jscs": "^2.7.0",
+    "mocha": "^2.3.4"
   },
   "license": "MIT",
   "files": [

src/cli.js

@@ -0,0 +1,135 @@
+/*
+ *
+ * Diff to HTML CLI (cli.js)
+ * Author: rtfpessoa
+ *
+ */
+
+(function() {
+
+  var diff2Html = require('diff2html').Diff2Html;
+
+  var log = require('./logger.js').Logger;
+  var http = require('./http-utils.js').HttpUtils;
+  var utils = require('./utils.js').Utils;
+
+  function Diff2HtmlInterface() {
+  }
+
+  /*
+   * Input
+   */
+
+  Diff2HtmlInterface.prototype.getInput = function getInput(inputType, inputArgs, callback) {
+    var that = this;
+    switch (inputType) {
+      case 'file':
+        utils.readFile(inputArgs[0], callback);
+        break;
+
+      case 'stdin':
+        utils.readStdin(callback);
+        break;
+
+      default:
+        that._runGitDiff(inputArgs, callback);
+    }
+  };
+
+  Diff2HtmlInterface.prototype._runGitDiff = function(gitArgsArr, callback) {
+    var gitArgs;
+    if (gitArgsArr.length && gitArgsArr[0]) {
+      gitArgs = gitArgsArr.join(' ');
+    } else {
+      gitArgs = '-M HEAD~1';
+    }
+
+    var diffCommand = 'git diff ' + gitArgs;
+    return callback(null, utils.runCmd(diffCommand));
+  };
+
+  /*
+   * Output
+   */
+
+  Diff2HtmlInterface.prototype.getOutput = function(baseConfig, input, callback) {
+    var that = this;
+    var config = baseConfig;
+    config.wordByWord = (baseConfig.diff === 'word');
+    config.charByChar = (baseConfig.diff === 'char');
+
+    var jsonContent = diff2Html.getJsonFromDiff(input, config);
+
+    if (baseConfig.format === 'html') {
+      config.inputFormat = 'json';
+
+      if (baseConfig.style === 'side') {
+        config.outputFormat = 'side-by-side';
+      } else {
+        config.outputFormat = 'line-by-line';
+      }
+
+      if (baseConfig.summary) {
+        config.showFiles = true;
+      }
+
+      var htmlContent = Diff2Html.getPrettyHtml(jsonContent, config);
+      return callback(null, that._prepareHTML(htmlContent));
+    } else if (baseConfig.format === 'json') {
+      return callback(null, JSON.stringify(jsonContent));
+    }
+
+    return callback(new Error('Wrong output format `' + baseConfig.format + '`!'));
+  };
+
+  Diff2HtmlInterface.prototype._prepareHTML = function(content) {
+    var template = utils.readFileSync(__dirname + '/../dist/template.html');
+
+    var cssFile = __dirname + '/../node_modules/diff2html/css/diff2html.css';
+    var cssFallbackFile = __dirname + '/../dist/diff2html.css';
+    if (utils.existsSync(cssFile)) cssFile = cssFallbackFile;
+
+    var cssContent = utils.readFileSync(cssFile);
+
+    return template
+      .replace('<!--css-->', '<style>\n' + cssContent + '\n</style>')
+      .replace('<!--diff-->', content);
+  };
+
+  /*
+   * Output destination
+   */
+
+  Diff2HtmlInterface.prototype.preview = function(content, format) {
+    var filePath = '/tmp/diff.' + format;
+    utils.writeFile(filePath, content);
+    utils.runCmd('open ' + filePath);
+  };
+
+  Diff2HtmlInterface.prototype.postToDiffy = function(diff, postType) {
+    var jsonParams = {udiff: diff};
+
+    http.post('http://diffy.org/api/new', jsonParams, function(err, response) {
+      if (err) {
+        log.error(err);
+        return;
+      }
+
+      if (response.status !== 'error') {
+        log.print('Link powered by diffy.org:');
+        log.print(response.url);
+
+        if (postType === 'browser') {
+          utils.runCmd('open ' + response.url);
+        } else if (postType === 'pbcopy') {
+          utils.runCmd('echo "' + response.url + '" | pbcopy');
+        }
+      } else {
+        log.error('Error: ' + message);
+      }
+    });
+  };
+
+  module.exports.Diff2HtmlInterface = new Diff2HtmlInterface();
+
+})();