microsoft/vscode-react-native
Publicmirrored from https://github.com/microsoft/vscode-react-nativeAvailable
tools/gulp-extras.js
137lines · modecode
| 1 | // Copyright (c) Microsoft Corporation. All rights reserved. |
| 2 | // Licensed under the MIT license. See LICENSE file in the project root for details. |
| 3 | "use strict"; |
| 4 | |
| 5 | var child_process = require("child_process"); |
| 6 | var fs = require("fs"); |
| 7 | var gutil = require("gulp-util"); |
| 8 | var path = require("path"); |
| 9 | var PluginError = gutil.PluginError; |
| 10 | var through = require("through2"); |
| 11 | |
| 12 | /** |
| 13 | * Pretty logger using gutil.log |
| 14 | * @param {string} pluginName Name of the pluginName |
| 15 | * @param {Object} file A gulp file to report on |
| 16 | * @param {string} message The error message to display |
| 17 | */ |
| 18 | var logError = function(pluginName, file, message) { |
| 19 | var sourcePath = path.relative(__dirname, file.path).replace("../",""); |
| 20 | gutil.log("[" + gutil.colors.cyan(pluginName) + "] " + gutil.colors.red("error") + " " + sourcePath + ": " + message); |
| 21 | }; |
| 22 | |
| 23 | /** |
| 24 | * Plugin to verify the Microsoft copyright notice is present |
| 25 | */ |
| 26 | var checkCopyright = function() { |
| 27 | var pluginName = "check-copyright"; |
| 28 | var hadErrors = false; |
| 29 | var copyrightNotice = "// Copyright (c) Microsoft Corporation. All rights reserved.\n// Licensed under the MIT license. See LICENSE file in the project root for details."; |
| 30 | |
| 31 | return through.obj(function(file, encoding, callback) { |
| 32 | if (file.isBuffer()) { |
| 33 | var fileContents = file.contents.toString(encoding); |
| 34 | fileContents = fileContents.replace("\r\n", "\n"); |
| 35 | fileContents = fileContents.replace("\"use strict\";\n", ""); |
| 36 | |
| 37 | if (fileContents.indexOf(copyrightNotice) !== 0) { |
| 38 | logError(pluginName, file, "missing copyright notice"); |
| 39 | hadErrors = true; |
| 40 | } |
| 41 | } |
| 42 | |
| 43 | callback(null, file); |
| 44 | }, |
| 45 | function(callback) { |
| 46 | if (hadErrors) { |
| 47 | return this.emit("error", new PluginError(pluginName, "Failed copyright check")); |
| 48 | } |
| 49 | callback(); |
| 50 | }); |
| 51 | }; |
| 52 | |
| 53 | /** |
| 54 | * Helper function to check if a file exists case sensitive |
| 55 | * @param {string} filePath The path to check |
| 56 | * @returns {boolean} If the path exists case sensitive |
| 57 | */ |
| 58 | var existsCaseSensitive = function(filePath) { |
| 59 | if (fs.existsSync(filePath)) { |
| 60 | var fileName = path.basename(filePath); |
| 61 | return fs.readdirSync(path.dirname(filePath)).indexOf(fileName) !== -1; |
| 62 | } |
| 63 | |
| 64 | return false; |
| 65 | }; |
| 66 | |
| 67 | /** |
| 68 | * Plugin to verify if import statements use correct casing |
| 69 | */ |
| 70 | var checkImports = function() { |
| 71 | var pluginName = "check-imports"; |
| 72 | var hadErrors = false; |
| 73 | var re = /(?:\s|^)(?:[^\n:]*).*from ["'](\.[^"']*)["'];/; |
| 74 | |
| 75 | return through.obj(function(file, encoding, callback) { |
| 76 | if (file.isBuffer()) { |
| 77 | var fileContents = file.contents.toString(encoding); |
| 78 | var importStatements = fileContents.match(new RegExp(re.source, "g")) || []; |
| 79 | var workingDirectory = path.dirname(file.path); |
| 80 | |
| 81 | importStatements.forEach(function(importStatement) { |
| 82 | var modulePath = re.exec(importStatement); |
| 83 | if (modulePath && modulePath[1]) { |
| 84 | var moduleFilePath = path.resolve(workingDirectory, modulePath[1] + ".ts"); |
| 85 | |
| 86 | if (!existsCaseSensitive(moduleFilePath)) { |
| 87 | logError(pluginName, file, "unresolved import: \"" + modulePath[1] + "\""); |
| 88 | hadErrors = true; |
| 89 | } |
| 90 | } |
| 91 | }); |
| 92 | } |
| 93 | |
| 94 | callback(null, file); |
| 95 | }, |
| 96 | function(callback) { |
| 97 | if (hadErrors) { |
| 98 | return this.emit("error", new PluginError(pluginName, "Failed import casing check")); |
| 99 | } |
| 100 | callback(); |
| 101 | }); |
| 102 | }; |
| 103 | |
| 104 | var executeCommand = function(command, args, callback, opts) { |
| 105 | var proc = child_process.spawn(command + (process.platform === "win32" ? ".cmd" : ""), args, opts); |
| 106 | var errorSignaled = false; |
| 107 | |
| 108 | proc.stdout.on("data", function(data) { |
| 109 | console.log("" + data); |
| 110 | }); |
| 111 | |
| 112 | proc.stderr.on("data", function(data) { |
| 113 | console.error("" + data); |
| 114 | }); |
| 115 | |
| 116 | proc.on("error", function(error) { |
| 117 | if (!errorSignaled) { |
| 118 | callback("An error occurred. " + error); |
| 119 | errorSignaled = true; |
| 120 | } |
| 121 | }); |
| 122 | |
| 123 | proc.on("exit", function(code) { |
| 124 | if (code === 0) { |
| 125 | callback(); |
| 126 | } else if (!errorSignaled) { |
| 127 | callback("Error code: " + code); |
| 128 | errorSignaled = true; |
| 129 | } |
| 130 | }); |
| 131 | }; |
| 132 | |
| 133 | module.exports = { |
| 134 | checkCopyright: checkCopyright, |
| 135 | checkImports: checkImports, |
| 136 | executeCommand: executeCommand |
| 137 | } |