|
| 1 | +var path = require("path"); |
| 2 | +var fs = require("fs"); |
| 3 | +var diffChecker = require("./src/diffchecker.js"); |
| 4 | + |
| 5 | +var typeConverters = { |
| 6 | + stache: 'html', |
| 7 | + mustache: 'html', |
| 8 | + component: 'html' |
| 9 | +}; |
| 10 | +var convertType = function(type) { |
| 11 | + return typeConverters[type] || type; |
| 12 | +}; |
| 13 | + |
| 14 | +var createGroupedLines = function(sequentialLines) { |
| 15 | + var groupedLines = sequentialLines[0] + '-' + sequentialLines[sequentialLines.length-1] |
| 16 | + return groupedLines |
| 17 | +} |
| 18 | + |
| 19 | +var checkSequence = function(diffLines) { |
| 20 | + //check to chunk lines together |
| 21 | + var singleLines = []; |
| 22 | + //temp array to hold sequences |
| 23 | + var sequentialLines = []; |
| 24 | + var prevLine = null; |
| 25 | + for (var index = 0; index < diffLines.length; index++) { |
| 26 | + var line = diffLines[index]; |
| 27 | + |
| 28 | + if (prevLine ) { |
| 29 | + if (prevLine + 1 === line) { |
| 30 | + sequentialLines.push(line); |
| 31 | + } |
| 32 | + else { |
| 33 | + //break sequencing |
| 34 | + if (sequentialLines.length > 1) { |
| 35 | + //updating singles array |
| 36 | + var startingSeqIndex = singleLines.indexOf(sequentialLines[0]); |
| 37 | + singleLines.splice(startingSeqIndex, sequentialLines.length, createGroupedLines(sequentialLines) ) |
| 38 | + |
| 39 | + } |
| 40 | + sequentialLines = []; |
| 41 | + sequentialLines.push(line); |
| 42 | + } |
| 43 | + // last line is part of sequence |
| 44 | + if(index + 1 === diffLines.length) { |
| 45 | + if (prevLine + 1 === line) { |
| 46 | + sequentialLines.push(line); |
| 47 | + if (sequentialLines.length > 1) { |
| 48 | + var startingSeqIndex = singleLines.indexOf(sequentialLines[0]); |
| 49 | + singleLines.splice(startingSeqIndex, sequentialLines.length, createGroupedLines(sequentialLines) ) |
| 50 | + sequentialLines = []; |
| 51 | + } |
| 52 | + } |
| 53 | + else { |
| 54 | + singleLines.push(line); |
| 55 | + } |
| 56 | + } |
| 57 | + else { |
| 58 | + singleLines.push(line); |
| 59 | + } |
| 60 | + prevLine = line; |
| 61 | + } |
| 62 | + else { |
| 63 | + singleLines.push(line); |
| 64 | + sequentialLines.push(line); |
| 65 | + prevLine = line; |
| 66 | + } |
| 67 | + } |
| 68 | + return singleLines; |
| 69 | +} |
| 70 | + |
| 71 | +/** |
| 72 | + * @parent bit-docs-tag-sourceref/tags |
| 73 | + * @module {bit-docs-process-tags/types/tag} bit-docs-tag-sourceref/tags/sourceref @sourceref |
| 74 | + * |
| 75 | + * @description Creates a diff from two files to get the changed lines and wraps them with markdown for code block. |
| 76 | + * |
| 77 | + * @signature `@diff PATH1 PATH2 only` |
| 78 | + * |
| 79 | + * Wraps file contents with triple \` so it shows up as a code block. |
| 80 | + * |
| 81 | + * @param {String} PATH1 The path to original file to be checked against. |
| 82 | + * @param {String} PATH2 The path to new version of original file. |
| 83 | + * @param {String} only Option flag to only show changed lines |
| 84 | + * |
| 85 | + */ |
| 86 | +module.exports = { |
| 87 | + add: function(line, curData) { |
| 88 | + var onlyFlag = line.indexOf('only') > -1 ? 'only': ''; |
| 89 | + var files = line.replace(/@diff|only/g, "").trim().split(" "); |
| 90 | + //break if more then two throw new error |
| 91 | + if (files.length > 2) { |
| 92 | + return false; |
| 93 | + } |
| 94 | + if (this.src.path) { |
| 95 | + var pathedFiles = [] |
| 96 | + for (var fileI = 0; fileI < files.length; fileI++) { |
| 97 | + let fileName = files[fileI]; |
| 98 | + pathedFiles.push(path.join(path.dirname(this.src.path), fileName)); |
| 99 | + } |
| 100 | + files = pathedFiles; |
| 101 | + } |
| 102 | + var file1 = fs.readFileSync(files[0]).toString(); |
| 103 | + var file2 = fs.readFileSync(files[1]).toString(); |
| 104 | + var validCurData = (curData && curData.length !== 2); |
| 105 | + var fileType = convertType(path.extname(files[1]).substring(1)); |
| 106 | + var useCurData = useCurData ? validCurData && (typeof curData.description === "string") && !curData.body : false;; |
| 107 | + var markdown = '\n```' + fileType + '\n' + file2 + '\n```'; |
| 108 | + var diffLines = diffChecker.diff(file1, file2); |
| 109 | + if(diffLines.length) { |
| 110 | + var lines = checkSequence(diffLines); |
| 111 | + markdown += '\n <div line-highlight="' + lines.toString() + ',' + onlyFlag + '"></div>'; |
| 112 | + }; |
| 113 | + if (useCurData) { |
| 114 | + curData.description += markdown; |
| 115 | + } else { |
| 116 | + this.body += markdown; |
| 117 | + } |
| 118 | + } |
| 119 | +}; |
0 commit comments