From 05e79420c4e2c2979ab56394f3054e5144ef3bed Mon Sep 17 00:00:00 2001 From: radswiat Date: Mon, 10 Apr 2017 21:33:32 +0100 Subject: [PATCH 1/3] Long awaited improvements, in progress --- .babelrc | 17 + demo/package.json | 0 demo/webpack.conf.js | 3 + dist/components/auto-inc-version.js | 67 - dist/components/inject-as-comment.js | 49 - dist/components/inject-by-tag.js | 31 - dist/components/inject-into-any-file.js | 46 - dist/components/inject-into-html.js | 25 - dist/config.js | 24 - dist/core/log.js | 47 - dist/core/utils.js | 21 - dist/index-bundle.js | 472 +++ dist/main.js | 53 - package.json | 20 +- src/config.js | 24 + src/config.ts | 24 - src/core/log.js | 67 + src/core/log.ts | 67 - src/core/utils.js | 24 + src/core/utils.ts | 24 - src/main.js | 90 + src/main.ts | 101 - tools/compile.js | 16 + tools/webpack.conf.js | 50 + tsconfig.json | 17 - typings.json | 5 - typings/globals/node/index.d.ts | 3790 ----------------------- typings/globals/node/typings.json | 8 - typings/index.d.ts | 1 - 29 files changed, 781 insertions(+), 4402 deletions(-) create mode 100644 .babelrc create mode 100644 demo/package.json create mode 100644 demo/webpack.conf.js delete mode 100644 dist/components/auto-inc-version.js delete mode 100644 dist/components/inject-as-comment.js delete mode 100644 dist/components/inject-by-tag.js delete mode 100644 dist/components/inject-into-any-file.js delete mode 100644 dist/components/inject-into-html.js delete mode 100644 dist/config.js delete mode 100644 dist/core/log.js delete mode 100644 dist/core/utils.js create mode 100644 dist/index-bundle.js delete mode 100644 dist/main.js create mode 100644 src/config.js delete mode 100644 src/config.ts create mode 100644 src/core/log.js delete mode 100644 src/core/log.ts create mode 100644 src/core/utils.js delete mode 100644 src/core/utils.ts create mode 100644 src/main.js delete mode 100644 src/main.ts create mode 100644 tools/compile.js create mode 100644 tools/webpack.conf.js delete mode 100644 tsconfig.json delete mode 100644 typings.json delete mode 100644 typings/globals/node/index.d.ts delete mode 100644 typings/globals/node/typings.json delete mode 100644 typings/index.d.ts diff --git a/.babelrc b/.babelrc new file mode 100644 index 0000000..ca0e475 --- /dev/null +++ b/.babelrc @@ -0,0 +1,17 @@ +{ + "babelrc": false, + "presets": [ + "es2015", + "stage-2" + ], + "plugins": [ + ["module-resolver", { + "root": ["./src/"], + "alias": { + "config": "./config", + "core": "./core" + } + }], + "transform-runtime" + ] +} \ No newline at end of file diff --git a/demo/package.json b/demo/package.json new file mode 100644 index 0000000..e69de29 diff --git a/demo/webpack.conf.js b/demo/webpack.conf.js new file mode 100644 index 0000000..659c8c8 --- /dev/null +++ b/demo/webpack.conf.js @@ -0,0 +1,3 @@ +/** + * Created by 608234548 on 10/04/2017. + */ diff --git a/dist/components/auto-inc-version.js b/dist/components/auto-inc-version.js deleted file mode 100644 index e55399d..0000000 --- a/dist/components/auto-inc-version.js +++ /dev/null @@ -1,67 +0,0 @@ -var semver = require('semver'); -var config = require('../config'); -var path = require('path'); -var fs = require('fs'); -var u = require('../core/utils'); -var chalk = require('chalk'); -var Promise = require('bluebird'); -var log = require('../core/log'); -var IncVersion = (function () { - function IncVersion(context) { - this.context = context; - } - IncVersion.prototype.apply = function () { - var _this = this; - return new Promise(function (resolve, reject) { - _this.resolve = resolve; - _this.reject = reject; - _this.start(); - }); - }; - IncVersion.prototype.start = function () { - this.packageFile = this.openPackageFile(); - if (u.isArgv('major')) { - this.major(); - } - else if (u.isArgv('minor')) { - this.minor(); - } - else if (u.isArgv('patch')) { - this.patch(); - } - else { - this.reject(); - } - }; - IncVersion.prototype.openPackageFile = function () { - return JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); - }; - IncVersion.prototype.closePackageFile = function (newVersion) { - var _this = this; - this.packageFile.version = newVersion; - fs.writeFile(path.normalize(config.PATH_PACKAGE), JSON.stringify(this.packageFile, null, 4), function (err) { - if (err) { - _this.reject(err); - return console.log(err); - } - log.info("autoIncVersion : new version : " + newVersion); - log.info('package.json updated!'); - _this.context.version = newVersion; - _this.resolve(); - }); - }; - IncVersion.prototype.major = function () { - var newVersion = semver.inc(this.packageFile.version, 'major'); - this.closePackageFile(newVersion); - }; - IncVersion.prototype.minor = function () { - var newVersion = semver.inc(this.packageFile.version, 'minor'); - this.closePackageFile(newVersion); - }; - IncVersion.prototype.patch = function () { - var newVersion = semver.inc(this.packageFile.version, 'patch'); - this.closePackageFile(newVersion); - }; - return IncVersion; -}()); -module.exports = IncVersion; diff --git a/dist/components/inject-as-comment.js b/dist/components/inject-as-comment.js deleted file mode 100644 index 39a1aa9..0000000 --- a/dist/components/inject-as-comment.js +++ /dev/null @@ -1,49 +0,0 @@ -var chalk = require('chalk'); -var path = require('path'); -var endOfLine = require('os').EOL; -var config = require('../config'); -var log = require('../core/log'); -'use strict'; -var InjectAsComment = (function () { - function InjectAsComment(context) { - this.context = context; - } - InjectAsComment.prototype.apply = function () { - var _this = this; - this.context.compiler.plugin('emit', function (compilation, cb) { - for (var basename in compilation.assets) { - var ext = path.extname(basename); - var asset = compilation.assets[basename]; - switch (ext) { - case '.js': - _this.injectIntoJs(asset); - break; - case '.html': - _this.injectIntoHtml(asset); - break; - case '.css': - _this.injectIntoCss(asset); - break; - case 'default': break; - } - log.info("InjectAsComment : match : " + basename + " : injected : " + _this.context.version); - } - cb(); - }); - return new Promise(function (resolve, reject) { resolve(); }); - }; - InjectAsComment.prototype.injectIntoCss = function (asset) { - var modAsset = "/** [" + config.SHORT + "] Build version: " + this.context.version + " **/" + endOfLine + asset.source(); - asset.source = function () { return modAsset; }; - }; - InjectAsComment.prototype.injectIntoHtml = function (asset) { - var modAsset = "" + endOfLine + asset.source(); - asset.source = function () { return modAsset; }; - }; - InjectAsComment.prototype.injectIntoJs = function (asset) { - var modAsset = "// [" + config.SHORT + "] Build version: " + this.context.version + endOfLine + " " + asset.source(); - asset.source = function () { return modAsset; }; - }; - return InjectAsComment; -}()); -module.exports = InjectAsComment; diff --git a/dist/components/inject-by-tag.js b/dist/components/inject-by-tag.js deleted file mode 100644 index ab5a6b7..0000000 --- a/dist/components/inject-by-tag.js +++ /dev/null @@ -1,31 +0,0 @@ -var log = require('../core/log'); -'use strict'; -var InjectByTag = (function () { - function InjectByTag(context) { - this.context = context; - } - InjectByTag.prototype.apply = function () { - var _this = this; - this.context.compiler.plugin('emit', function (compilation, cb) { - var _loop_1 = function() { - if (_this.context.options.injectByTagFileRegex.test(basename)) { - var replaced_1 = 0; - var asset = compilation.assets[basename]; - var modFile_1 = asset.source().replace(/(\<\{version\}\>)/g, function () { - replaced_1++; - return _this.context.version; - }); - asset.source = function () { return modFile_1; }; - log.info("InjectByTag : match : " + basename + " : replaced : " + replaced_1); - } - }; - for (var basename in compilation.assets) { - _loop_1(); - } - cb(); - }); - return new Promise(function (resolve, reject) { resolve(); }); - }; - return InjectByTag; -}()); -module.exports = InjectByTag; diff --git a/dist/components/inject-into-any-file.js b/dist/components/inject-into-any-file.js deleted file mode 100644 index 4c45825..0000000 --- a/dist/components/inject-into-any-file.js +++ /dev/null @@ -1,46 +0,0 @@ -var chalk = require('chalk'); -var path = require('path'); -var endOfLine = require('os').EOL; -var config = require('./../config'); -'use strict'; -var InjectIntoAnyFile = (function () { - function InjectIntoAnyFile(context) { - this.context = context; - } - InjectIntoAnyFile.prototype.apply = function () { - var _this = this; - this.context.compiler.plugin('emit', function (compilation, cb) { - for (var basename in compilation.assets) { - var ext = path.extname(basename); - var asset = compilation.assets[basename]; - switch (ext) { - case '.js': - _this.injectIntoJs(asset); - break; - case '.html': - _this.injectIntoHtml(asset); - break; - case '.css': - _this.injectIntoCss(asset); - break; - } - } - cb(); - }); - return new Promise(function (resolve, reject) { resolve(); }); - }; - InjectIntoAnyFile.prototype.injectIntoCss = function (asset) { - var modAsset = "/** [" + config.SHORT + "] Build version: " + this.context.version + " **/ " + endOfLine + " " + asset.source() + " "; - asset.source = function () { return modAsset; }; - }; - InjectIntoAnyFile.prototype.injectIntoHtml = function (asset) { - var modAsset = " " + endOfLine + " " + asset.source() + " "; - asset.source = function () { return modAsset; }; - }; - InjectIntoAnyFile.prototype.injectIntoJs = function (asset) { - var modAsset = "// [" + config.SHORT + "] Build version: " + this.context.version + " " + endOfLine + " " + asset.source() + " "; - asset.source = function () { return modAsset; }; - }; - return InjectIntoAnyFile; -}()); -module.exports = InjectIntoAnyFile; diff --git a/dist/components/inject-into-html.js b/dist/components/inject-into-html.js deleted file mode 100644 index 892a534..0000000 --- a/dist/components/inject-into-html.js +++ /dev/null @@ -1,25 +0,0 @@ -'use strict'; -var InjectIntoHtml = (function () { - function InjectIntoHtml(context) { - this.context = context; - } - InjectIntoHtml.prototype.apply = function () { - var _this = this; - this.context.compiler.plugin('emit', function (compilation, cb) { - var _loop_1 = function() { - if (_this.context.options.injectIntoHtmlRegex.test(basename)) { - var asset = compilation.assets[basename]; - var modFile_1 = asset.source().replace(/(\<\{version\}\>)/g, _this.context.version); - asset.source = function () { return modFile_1; }; - } - }; - for (var basename in compilation.assets) { - _loop_1(); - } - cb(); - }); - return new Promise(function (resolve, reject) { resolve(); }); - }; - return InjectIntoHtml; -}()); -module.exports = InjectIntoHtml; diff --git a/dist/config.js b/dist/config.js deleted file mode 100644 index a350957..0000000 --- a/dist/config.js +++ /dev/null @@ -1,24 +0,0 @@ -module.exports = { - NAME: 'Auto Inject Version', - SHORT: 'AIV', - PATH_PACKAGE: './package.json', - NON_WEBPACK_COMPONENTS: [ - { - option: 'autoIncrease', - path: './components/auto-inc-version' - } - ], - WEBPACK_COMPONENTS: [ - { - option: 'injectByTag', - path: './components/inject-by-tag' - }, - { - option: 'injectAsComment', - path: './components/inject-as-comment' - } - ], - LOGS_TEXT: { - AIS_START: 'Auto inject version started' - } -}; diff --git a/dist/core/log.js b/dist/core/log.js deleted file mode 100644 index ad3f971..0000000 --- a/dist/core/log.js +++ /dev/null @@ -1,47 +0,0 @@ -var config = require('../config'); -var chalk = require('chalk'); -var endOfLine = require('os').EOL; -var u = require('./utils'); -var Log = (function () { - function Log() { - this.logLevel = 3; - this.getLogLevel(); - } - Log.prototype.getLogLevel = function () { - if (u.isArgv('aiv-log-full')) { - this.logLevel = 3; - } - else if (u.isArgv('aiv-log-none')) { - this.logLevel = 0; - } - }; - Log.prototype.getHead = function () { - return endOfLine + chalk.bgYellow.black('[AIV] : '); - }; - Log.prototype.getText = function (id) { - return config.LOGS_TEXT[id]; - }; - Log.prototype.call = function (type, msgId) { - if (typeof this[type] === 'function') { - this[type](this.getText(msgId)); - } - }; - Log.prototype.error = function (msg) { - if (this.logLevel < 3) - return; - console.log(this.getHead() + " " + chalk.red('error') + " : " + msg); - }; - Log.prototype.info = function (msg) { - if (!this.logLevel) - return; - console.log(this.getHead() + " " + chalk.blue('info') + " : " + msg); - }; - Log.prototype.warn = function (msg) { - if (!this.logLevel) - return; - console.log(this.getHead() + " " + chalk.yellow('warn') + " : " + msg); - }; - return Log; -}()); -var log = new Log(); -module.exports = log; diff --git a/dist/core/utils.js b/dist/core/utils.js deleted file mode 100644 index d1a7248..0000000 --- a/dist/core/utils.js +++ /dev/null @@ -1,21 +0,0 @@ -var Utils = (function () { - function Utils() { - } - Utils.isArgv = function (arg) { - return Boolean(process.argv.find(function (item) { - return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; - })); - }; - Utils.merge = function (obj1, obj2) { - var obj3 = {}; - for (var attrname in obj1) { - obj3[attrname] = obj1[attrname]; - } - for (var attrname in obj2) { - obj3[attrname] = obj2[attrname]; - } - return obj3; - }; - return Utils; -}()); -module.exports = Utils; diff --git a/dist/index-bundle.js b/dist/index-bundle.js new file mode 100644 index 0000000..7fb9f9f --- /dev/null +++ b/dist/index-bundle.js @@ -0,0 +1,472 @@ +/******/ (function(modules) { // webpackBootstrap +/******/ // The module cache +/******/ var installedModules = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) +/******/ return installedModules[moduleId].exports; +/******/ +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ i: moduleId, +/******/ l: false, +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); +/******/ +/******/ // Flag the module as loaded +/******/ module.l = true; +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/******/ +/******/ // expose the modules object (__webpack_modules__) +/******/ __webpack_require__.m = modules; +/******/ +/******/ // expose the module cache +/******/ __webpack_require__.c = installedModules; +/******/ +/******/ // identity function for calling harmony imports with the correct context +/******/ __webpack_require__.i = function(value) { return value; }; +/******/ +/******/ // define getter function for harmony exports +/******/ __webpack_require__.d = function(exports, name, getter) { +/******/ if(!__webpack_require__.o(exports, name)) { +/******/ Object.defineProperty(exports, name, { +/******/ configurable: false, +/******/ enumerable: true, +/******/ get: getter +/******/ }); +/******/ } +/******/ }; +/******/ +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = function(module) { +/******/ var getter = module && module.__esModule ? +/******/ function getDefault() { return module['default']; } : +/******/ function getModuleExports() { return module; }; +/******/ __webpack_require__.d(getter, 'a', getter); +/******/ return getter; +/******/ }; +/******/ +/******/ // Object.prototype.hasOwnProperty.call +/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; +/******/ +/******/ // __webpack_public_path__ +/******/ __webpack_require__.p = ""; +/******/ +/******/ // Load entry module and return exports +/******/ return __webpack_require__(__webpack_require__.s = 11); +/******/ }) +/************************************************************************/ +/******/ ([ +/* 0 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/helpers/classCallCheck"); + +/***/ }), +/* 1 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/helpers/createClass"); + +/***/ }), +/* 2 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +module.exports = { + NAME: 'Auto Inject Version', + SHORT: 'AIV', + PATH_PACKAGE: './package.json', + NON_WEBPACK_COMPONENTS: [{ + option: 'autoIncrease', + path: './components/auto-inc-version' + }], + WEBPACK_COMPONENTS: [{ + option: 'injectByTag', + path: './components/inject-by-tag' + }, { + option: 'injectAsComment', + path: './components/inject-as-comment' + }], + LOGS_TEXT: { + AIS_START: 'Auto inject version started' + } +}; + +/***/ }), +/* 3 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var Utils = function () { + function Utils() { + (0, _classCallCheck3.default)(this, Utils); + } + + (0, _createClass3.default)(Utils, null, [{ + key: 'isArgv', + value: function isArgv(arg) { + return Boolean(process.argv.find(function (item) { + return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; + })); + } + + /** + * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 + * @param obj1 + * @param obj2 + * @returns obj3 a new object based on obj1 and obj2 + */ + + }, { + key: 'merge', + value: function merge(obj1, obj2) { + var obj3 = {}; + for (var attrname in obj1) { + obj3[attrname] = obj1[attrname]; + } + for (var attrname in obj2) { + obj3[attrname] = obj2[attrname]; + } + return obj3; + } + }]); + return Utils; +}(); + +module.exports = Utils; + +/***/ }), +/* 4 */ +/***/ (function(module, exports) { + +module.exports = require("chalk"); + +/***/ }), +/* 5 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _chalk = __webpack_require__(4); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _fs = __webpack_require__(8); + +var _fs2 = _interopRequireDefault(_fs); + +var _path = __webpack_require__(10); + +var _path2 = _interopRequireDefault(_path); + +var _config = __webpack_require__(2); + +var _config2 = _interopRequireDefault(_config); + +var _utils = __webpack_require__(3); + +var _utils2 = _interopRequireDefault(_utils); + +var _log = __webpack_require__(6); + +var _log2 = _interopRequireDefault(_log); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var WebpackAutoInject = function () { + + /** + * Constructor, + * called on webpack config load + * @param options + */ + function WebpackAutoInject(options) { + (0, _classCallCheck3.default)(this, WebpackAutoInject); + + this.options = _utils2.default.merge(WebpackAutoInject.options, options); + var packageFile = JSON.parse(_fs2.default.readFileSync(_path2.default.normalize(_config2.default.PATH_PACKAGE), 'utf8')); + this.version = packageFile.version; + _log2.default.call('info', 'AIS_START'); + this.executeNoneWebpackComponents(); + } + + /** + * Webpack apply call, + * when webpack is initialized and + * plugin has been called by webpack + * @param compiler + */ + + + /** + * Default options + */ + + + (0, _createClass3.default)(WebpackAutoInject, [{ + key: 'apply', + value: function apply(compiler) { + this.compiler = compiler; + this.executeWebpackComponents(); + } + + /** + * Execute none webpack components + * - runs as soon as possible, + * > without waiting for webpack init + */ + + }, { + key: 'executeNoneWebpackComponents', + value: function executeNoneWebpackComponents() { + this.executeComponents(_config2.default.NON_WEBPACK_COMPONENTS, function () {}); + } + + /** + * Execute webpack components + * - runs when webpack is initialized + * and plugins is called by webpack + */ + + }, { + key: 'executeWebpackComponents', + value: function executeWebpackComponents() { + this.executeComponents(_config2.default.WEBPACK_COMPONENTS, function () {}); + } + + /** + * Execute components, + * - general layer for comp execution + * - used for both, webpack and non webpack comp + */ + + }, { + key: 'executeComponents', + value: function executeComponents(components, done) { + var _this = this; + + // no more components, + // finish + if (!components.length) { + done();return; + } + + // take first component + var comp = components.shift(); + + // if component is disabled, call next component + if (!this.options[comp.option]) { + this.executeComponents(components, done); + return; + } + + // execute component + var inst = new (!(function webpackMissingModule() { var e = new Error("Cannot find module \".\""); e.code = 'MODULE_NOT_FOUND'; throw e; }()))(this); + inst.apply().then(function () { + _this.executeComponents(components, done); + }, function (err) { + _this.executeComponents(components, done); + }); + } + }]); + return WebpackAutoInject; +}(); + +WebpackAutoInject.options = { + autoIncrease: true, + injectAsComment: true, + injectByTag: true, + injectByTagFileRegex: /^index\.html$/ +}; +exports.default = WebpackAutoInject; + +/***/ }), +/* 6 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _config = __webpack_require__(2); + +var _config2 = _interopRequireDefault(_config); + +var _chalk = __webpack_require__(4); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _utils = __webpack_require__(3); + +var _utils2 = _interopRequireDefault(_utils); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var endOfLine = __webpack_require__(9).EOL; + +var Log = function () { + // default 1 + + function Log() { + (0, _classCallCheck3.default)(this, Log); + this.logLevel = 3; + + this.getLogLevel(); + } + + (0, _createClass3.default)(Log, [{ + key: 'getLogLevel', + value: function getLogLevel() { + if (u.isArgv('aiv-log-full')) { + this.logLevel = 3; + } else if (u.isArgv('aiv-log-none')) { + this.logLevel = 0; + } + } + + /** + * Get console log head + * @returns {string} + */ + + }, { + key: 'getHead', + value: function getHead() { + return endOfLine + _chalk2.default.bgYellow.black('[AIV] : '); + } + + /** + * Get log text by ID from config file + */ + + }, { + key: 'getText', + value: function getText(id) { + return _config2.default.LOGS_TEXT[id]; + } + + /** + * Call any type + * @param type + * @param msg + */ + + }, { + key: 'call', + value: function call(type, msgId) { + if (typeof this[type] === 'function') { + this[type](this.getText(msgId)); + } + } + }, { + key: 'error', + value: function error(msg) { + if (this.logLevel < 3) return; + console.log(this.getHead() + ' ' + _chalk2.default.red('error') + ' : ' + msg); + } + }, { + key: 'info', + value: function info(msg) { + if (!this.logLevel) return; + console.log(this.getHead() + ' ' + _chalk2.default.blue('info') + ' : ' + msg); + } + }, { + key: 'warn', + value: function warn(msg) { + if (!this.logLevel) return; + console.log(this.getHead() + ' ' + _chalk2.default.yellow('warn') + ' : ' + msg); + } + }]); + return Log; +}(); + +exports.default = new Log(); + +/***/ }), +/* 7 */ +/***/ (function(module, exports) { + +function webpackEmptyContext(req) { + throw new Error("Cannot find module '" + req + "'."); +} +webpackEmptyContext.keys = function() { return []; }; +webpackEmptyContext.resolve = webpackEmptyContext; +module.exports = webpackEmptyContext; +webpackEmptyContext.id = 7; + +/***/ }), +/* 8 */ +/***/ (function(module, exports) { + +module.exports = require("fs"); + +/***/ }), +/* 9 */ +/***/ (function(module, exports) { + +module.exports = require("os"); + +/***/ }), +/* 10 */ +/***/ (function(module, exports) { + +module.exports = require("path"); + +/***/ }), +/* 11 */ +/***/ (function(module, exports, __webpack_require__) { + +module.exports = __webpack_require__(5); + + +/***/ }) +/******/ ]); \ No newline at end of file diff --git a/dist/main.js b/dist/main.js deleted file mode 100644 index a05e194..0000000 --- a/dist/main.js +++ /dev/null @@ -1,53 +0,0 @@ -var chalk = require('chalk'); -var fs = require('fs'); -var path = require('path'); -var config = require('./config'); -var Promise = require('bluebird'); -var u = require('./core/utils'); -var log = require('./core/log'); -'use strict'; -var WebpackAutoInject = (function () { - function WebpackAutoInject(options) { - this.options = u.merge(WebpackAutoInject.options, options); - var packageFile = JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); - this.version = packageFile.version; - log.call('info', 'AIS_START'); - this.executeNoneWebpackComponents(); - } - WebpackAutoInject.prototype.apply = function (compiler) { - this.compiler = compiler; - this.executeWebpackComponents(); - }; - WebpackAutoInject.prototype.executeNoneWebpackComponents = function () { - this.executeComponents(config.NON_WEBPACK_COMPONENTS, function () { - }); - }; - WebpackAutoInject.prototype.executeWebpackComponents = function () { - this.executeComponents(config.WEBPACK_COMPONENTS, function () { - }); - }; - WebpackAutoInject.prototype.executeComponents = function (components, done) { - var _this = this; - if (!components.length) { - done(); - return; - } - var comp = components.shift(); - if (!this.options[comp.option]) { - this.executeComponents(components, done); - return; - } - var inst = new (require(comp.path))(this); - inst.apply().then(function () { - _this.executeComponents(components, done); - }, function (err) { _this.executeComponents(components, done); }); - }; - WebpackAutoInject.options = { - autoIncrease: true, - injectAsComment: true, - injectByTag: true, - injectByTagFileRegex: /^index\.html$/ - }; - return WebpackAutoInject; -}()); -module.exports = WebpackAutoInject; diff --git a/package.json b/package.json index 2775ba2..8e89285 100644 --- a/package.json +++ b/package.json @@ -5,12 +5,28 @@ "description": "Webpack plugin for auto inject version from package.json", "main": "dist/main.js", "scripts": { - "build": "tsc -w" + "start": "babel-node tools/compile.js" }, "author": "Radoslaw Swiat", "license": "ISC", "devDependencies": { - "typings": "^1.4.0" + "babel-cli": "^6.10.1", + "babel-core": "^6.24.1", + "babel-eslint": "^6.0.0", + "babel-loader": "^6.2.4", + "babel-plugin-module-resolver": "^2.4.0", + "babel-plugin-transform-runtime": "^6.12.0", + "babel-preset-es2015": "^6.6.0", + "babel-preset-node5": "^11.0.1", + "babel-preset-react": "^6.5.0", + "babel-preset-stage-2": "^6.22.0", + "eslint": "^2.7.0", + "eslint-config-airbnb": "^6.2.0", + "eslint-loader": "^1.5.0", + "eslint-plugin-babel": "^3.2.0", + "gutil": "^1.6.4", + "webpack": "^2.3.3", + "webpack-node-externals": "^1.5.4" }, "dependencies": { "bluebird": "^3.4.6", diff --git a/src/config.js b/src/config.js new file mode 100644 index 0000000..d2cd36b --- /dev/null +++ b/src/config.js @@ -0,0 +1,24 @@ +module.exports = { + NAME : 'Auto Inject Version', + SHORT : 'AIV', + PATH_PACKAGE : './package.json', + NON_WEBPACK_COMPONENTS : [ + { + option : 'autoIncrease', + path : './components/auto-inc-version' + } + ], + WEBPACK_COMPONENTS : [ + { + option : 'injectByTag', + path : './components/inject-by-tag' + }, + { + option : 'injectAsComment', + path : './components/inject-as-comment' + } + ], + LOGS_TEXT : { + AIS_START : 'Auto inject version started' + } +} \ No newline at end of file diff --git a/src/config.ts b/src/config.ts deleted file mode 100644 index e64549c..0000000 --- a/src/config.ts +++ /dev/null @@ -1,24 +0,0 @@ -module.exports = { - NAME : 'Auto Inject Version', - SHORT : 'AIV', - PATH_PACKAGE : './package.json', - NON_WEBPACK_COMPONENTS : [ - { - option : 'autoIncrease', - path : './components/auto-inc-version' - } - ], - WEBPACK_COMPONENTS : [ - { - option : 'injectByTag', - path : './components/inject-by-tag' - }, - { - option : 'injectAsComment', - path : './components/inject-as-comment' - } - ], - LOGS_TEXT : { - AIS_START : 'Auto inject version started' - } -} \ No newline at end of file diff --git a/src/core/log.js b/src/core/log.js new file mode 100644 index 0000000..7926ba1 --- /dev/null +++ b/src/core/log.js @@ -0,0 +1,67 @@ +import config from 'config'; +import chalk from 'chalk'; +import utils from 'core/utils'; +const endOfLine = require('os').EOL; + + +class Log{ + + logLevel = 3; // default 1 + + constructor() { + this.getLogLevel(); + } + + getLogLevel() { + if(u.isArgv('aiv-log-full')){ + this.logLevel = 3; + }else if(u.isArgv('aiv-log-none')) { + this.logLevel = 0; + } + } + + /** + * Get console log head + * @returns {string} + */ + getHead() { + return endOfLine + chalk.bgYellow.black('[AIV] : ') + } + + /** + * Get log text by ID from config file + */ + getText(id) { + return config.LOGS_TEXT[id]; + } + + /** + * Call any type + * @param type + * @param msg + */ + call(type, msgId) { + if(typeof this[type] === 'function') { + this[type](this.getText(msgId)); + } + } + + error (msg) { + if(this.logLevel < 3) return; + console.log(`${this.getHead()} ${chalk.red('error')} : ${msg}`); + } + + + info (msg) { + if(!this.logLevel) return; + console.log(`${this.getHead()} ${chalk.blue('info')} : ${msg}`); + } + + warn (msg) { + if(!this.logLevel) return; + console.log(`${this.getHead()} ${chalk.yellow('warn')} : ${msg}`); + } + +} + +export default new Log(); \ No newline at end of file diff --git a/src/core/log.ts b/src/core/log.ts deleted file mode 100644 index 533fbce..0000000 --- a/src/core/log.ts +++ /dev/null @@ -1,67 +0,0 @@ -const config = require('../config'); -const chalk = require('chalk'); -const endOfLine = require('os').EOL; -const u = require('./utils'); - -class Log{ - - private logLevel = 3; // default 1 - - constructor() { - this.getLogLevel(); - } - - private getLogLevel() { - if(u.isArgv('aiv-log-full')){ - this.logLevel = 3; - }else if(u.isArgv('aiv-log-none')) { - this.logLevel = 0; - } - } - - /** - * Get console log head - * @returns {string} - */ - private getHead() { - return endOfLine + chalk.bgYellow.black('[AIV] : ') - } - - /** - * Get log text by ID from config file - */ - private getText(id) { - return config.LOGS_TEXT[id]; - } - - /** - * Call any type - * @param type - * @param msg - */ - call(type, msgId) { - if(typeof this[type] === 'function') { - this[type](this.getText(msgId)); - } - } - - error (msg) { - if(this.logLevel < 3) return; - console.log(`${this.getHead()} ${chalk.red('error')} : ${msg}`); - } - - - info (msg) { - if(!this.logLevel) return; - console.log(`${this.getHead()} ${chalk.blue('info')} : ${msg}`); - } - - warn (msg) { - if(!this.logLevel) return; - console.log(`${this.getHead()} ${chalk.yellow('warn')} : ${msg}`); - } - -} - -var log = new Log(); -module.exports = log; \ No newline at end of file diff --git a/src/core/utils.js b/src/core/utils.js new file mode 100644 index 0000000..7c5f80c --- /dev/null +++ b/src/core/utils.js @@ -0,0 +1,24 @@ +class Utils{ + + static isArgv(arg) { + return Boolean(process.argv.find(function(item) { + return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; + })); + } + + /** + * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 + * @param obj1 + * @param obj2 + * @returns obj3 a new object based on obj1 and obj2 + */ + static merge(obj1,obj2){ + var obj3 = {}; + for (var attrname in obj1) { obj3[attrname] = obj1[attrname]; } + for (var attrname in obj2) { obj3[attrname] = obj2[attrname]; } + return obj3; + } + +} + +module.exports = Utils; \ No newline at end of file diff --git a/src/core/utils.ts b/src/core/utils.ts deleted file mode 100644 index 2cb602e..0000000 --- a/src/core/utils.ts +++ /dev/null @@ -1,24 +0,0 @@ -class Utils{ - - static isArgv(arg) { - return Boolean(process.argv.find(function(item) { - return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; - })); - } - - /** - * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 - * @param obj1 - * @param obj2 - * @returns obj3 a new object based on obj1 and obj2 - */ - static merge(obj1,obj2){ - var obj3 = {}; - for (var attrname in obj1) { obj3[attrname] = obj1[attrname]; } - for (var attrname in obj2) { obj3[attrname] = obj2[attrname]; } - return obj3; - } - -} - -module.exports = Utils; \ No newline at end of file diff --git a/src/main.js b/src/main.js new file mode 100644 index 0000000..24e910f --- /dev/null +++ b/src/main.js @@ -0,0 +1,90 @@ +import chalk from 'chalk'; +import fs from 'fs'; +import path from 'path'; +import config from 'config'; +import u from 'core/utils'; +import log from 'core/log'; + +export default class WebpackAutoInject{ + + /** + * Default options + */ + static options = { + autoIncrease: true, + injectAsComment: true, + injectByTag: true, + injectByTagFileRegex: /^index\.html$/ + }; + + /** + * Constructor, + * called on webpack config load + * @param options + */ + constructor(options) { + this.options = u.merge(WebpackAutoInject.options, options); + let packageFile = JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); + this.version = packageFile.version; + log.call('info', 'AIS_START'); + this.executeNoneWebpackComponents(); + } + + /** + * Webpack apply call, + * when webpack is initialized and + * plugin has been called by webpack + * @param compiler + */ + apply(compiler) { + this.compiler = compiler; + this.executeWebpackComponents(); + } + + /** + * Execute none webpack components + * - runs as soon as possible, + * > without waiting for webpack init + */ + executeNoneWebpackComponents() { + this.executeComponents(config.NON_WEBPACK_COMPONENTS, () => { + }); + } + + /** + * Execute webpack components + * - runs when webpack is initialized + * and plugins is called by webpack + */ + executeWebpackComponents() { + this.executeComponents(config.WEBPACK_COMPONENTS, () => { + }); + } + + /** + * Execute components, + * - general layer for comp execution + * - used for both, webpack and non webpack comp + */ + executeComponents(components, done) { + + // no more components, + // finish + if(!components.length) { done(); return;} + + // take first component + let comp = components.shift(); + + // if component is disabled, call next component + if(!this.options[comp.option]) { + this.executeComponents(components, done); + return; + } + + // execute component + let inst = new (require(comp.path))(this); + inst.apply().then(() => { + this.executeComponents(components, done); + }, (err) => {this.executeComponents(components, done);}) + } +} \ No newline at end of file diff --git a/src/main.ts b/src/main.ts deleted file mode 100644 index 538cf35..0000000 --- a/src/main.ts +++ /dev/null @@ -1,101 +0,0 @@ -/// -const chalk = require('chalk'); -const fs = require('fs'); -const path = require('path'); -const config = require('./config'); -const Promise = require('bluebird'); -const u = require('./core/utils'); -const log = require('./core/log'); - -'use strict'; - -class WebpackAutoInject{ - - private options; - private compiler; - private version; - - /** - * Default options - */ - static options = { - autoIncrease : true, - injectAsComment : true, - injectByTag : true, - injectByTagFileRegex : /^index\.html$/ - } - - /** - * Constructor, - * called on webpack config load - * @param options - */ - constructor(options) { - this.options = u.merge(WebpackAutoInject.options, options); - var packageFile = JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); - this.version = packageFile.version; - log.call('info', 'AIS_START'); - this.executeNoneWebpackComponents(); - } - - /** - * Webpack apply call, - * when webpack is initialized and - * plugin has been called by webpack - * @param compiler - */ - protected apply(compiler) { - this.compiler = compiler; - this.executeWebpackComponents(); - } - - /** - * Execute none webpack components - * - runs as soon as possible, - * > without waiting for webpack init - */ - private executeNoneWebpackComponents() { - this.executeComponents(config.NON_WEBPACK_COMPONENTS, () => { - }); - } - - /** - * Execute webpack components - * - runs when webpack is initialized - * and plugins is called by webpack - */ - private executeWebpackComponents() { - this.executeComponents(config.WEBPACK_COMPONENTS, () => { - }); - } - - /** - * Execute components, - * - general layer for comp execution - * - used for both, webpack and non webpack comp - */ - private executeComponents(components, done) { - - // no more components, - // finish - if(!components.length) { done(); return;} - - // take first component - let comp = components.shift(); - - // if component is disabled, call next component - if(!this.options[comp.option]) { - this.executeComponents(components, done); - return; - } - - // execute component - let inst = new (require(comp.path))(this); - inst.apply().then(() => { - this.executeComponents(components, done); - }, (err) => {this.executeComponents(components, done);}) - } -} - - -module.exports = WebpackAutoInject; \ No newline at end of file diff --git a/tools/compile.js b/tools/compile.js new file mode 100644 index 0000000..6a50317 --- /dev/null +++ b/tools/compile.js @@ -0,0 +1,16 @@ +import webpack from 'webpack'; +import gutil from 'gutil'; +import webpackConfig from './webpack.conf'; + +function run() { + console.log('compiling'); + let compiler = webpack(webpackConfig); + compiler.run((err, stats) => { + gutil.log('[webpack:build]', stats.toString({ + chunks: false, // Makes the build much quieter + colors: true + })); + }); +} + +run(); diff --git a/tools/webpack.conf.js b/tools/webpack.conf.js new file mode 100644 index 0000000..ce0433f --- /dev/null +++ b/tools/webpack.conf.js @@ -0,0 +1,50 @@ +import path from 'path'; +const webpack = require('webpack'); +import nodeExternals from 'webpack-node-externals'; + +export default { + target: 'node', + externals: [nodeExternals()], + entry: { + index: [ + './src/main.js' + ] + }, + resolve: { + extensions: ['.js'] + }, + output: { + filename: '[name]-bundle.js', + path: path.resolve(process.cwd(), 'dist') + }, + module: { + // rules: [ + // { // eslint feature + // enforce: 'pre', + // test: /\.js$/, + // loader: 'eslint-loader', + // exclude: /node_modules/ + // } + // ], + loaders: [ + { + test: /\.js$/, + loader: 'babel-loader', + include: [ + path.resolve('src') + ] + }, + { + test: /\.json$/, + loader: 'json-loader' + }, + { + test: /\.txt$/, + loader: 'raw-loader' + } + ] + }, + plugins: [ + + ] +}; diff --git a/tsconfig.json b/tsconfig.json deleted file mode 100644 index f9c06b9..0000000 --- a/tsconfig.json +++ /dev/null @@ -1,17 +0,0 @@ -{ - "compilerOptions": { - "target": "es5", - "module": "commonjs", - "moduleResolution": "node", - "declaration": false, - "noImplicitAny": false, - "removeComments": true, - "noLib": false, - "preserveConstEnums": true, - "suppressImplicitAnyIndexErrors": true, - "outDir": "./dist" - }, - "filesGlob": [ - "./src/" - ] -} diff --git a/typings.json b/typings.json deleted file mode 100644 index a831cba..0000000 --- a/typings.json +++ /dev/null @@ -1,5 +0,0 @@ -{ - "globalDependencies": { - "node": "registry:dt/node#6.0.0+20161019125345" - } -} diff --git a/typings/globals/node/index.d.ts b/typings/globals/node/index.d.ts deleted file mode 100644 index 1ad9f85..0000000 --- a/typings/globals/node/index.d.ts +++ /dev/null @@ -1,3790 +0,0 @@ -// Generated by typings -// Source: https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/988a48ab2cfff3243868d70d836332a118d9f060/node/node.d.ts -interface Error { - stack?: string; -} - -interface ErrorConstructor { - captureStackTrace(targetObject: Object, constructorOpt?: Function): void; - stackTraceLimit: number; -} - -// compat for TypeScript 1.8 -// if you use with --target es3 or --target es5 and use below definitions, -// use the lib.es6.d.ts that is bundled with TypeScript 1.8. -interface MapConstructor { } -interface WeakMapConstructor { } -interface SetConstructor { } -interface WeakSetConstructor { } - -/************************************************ -* * -* GLOBAL * -* * -************************************************/ -declare var process: NodeJS.Process; -declare var global: NodeJS.Global; - -declare var __filename: string; -declare var __dirname: string; - -declare function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearTimeout(timeoutId: NodeJS.Timer): void; -declare function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; -declare function clearInterval(intervalId: NodeJS.Timer): void; -declare function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; -declare function clearImmediate(immediateId: any): void; - -interface NodeRequireFunction { - (id: string): any; -} - -interface NodeRequire extends NodeRequireFunction { - resolve(id: string): string; - cache: any; - extensions: any; - main: any; -} - -declare var require: NodeRequire; - -interface NodeModule { - exports: any; - require: NodeRequireFunction; - id: string; - filename: string; - loaded: boolean; - parent: any; - children: any[]; -} - -declare var module: NodeModule; - -// Same as module.exports -declare var exports: any; -declare var SlowBuffer: { - new (str: string, encoding?: string): Buffer; - new (size: number): Buffer; - new (size: Uint8Array): Buffer; - new (array: any[]): Buffer; - prototype: Buffer; - isBuffer(obj: any): boolean; - byteLength(string: string, encoding?: string): number; - concat(list: Buffer[], totalLength?: number): Buffer; -}; - - -// Buffer class -type BufferEncoding = "ascii" | "utf8" | "utf16le" | "ucs2" | "binary" | "hex"; -interface Buffer extends NodeBuffer { } - -/** - * Raw data is stored in instances of the Buffer class. - * A Buffer is similar to an array of integers but corresponds to a raw memory allocation outside the V8 heap. A Buffer cannot be resized. - * Valid string encodings: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - */ -declare var Buffer: { - /** - * Allocates a new buffer containing the given {str}. - * - * @param str String to store in buffer. - * @param encoding encoding to use, optional. Default is 'utf8' - */ - new (str: string, encoding?: string): Buffer; - /** - * Allocates a new buffer of {size} octets. - * - * @param size count of octets to allocate. - */ - new (size: number): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: Uint8Array): Buffer; - /** - * Produces a Buffer backed by the same allocated memory as - * the given {ArrayBuffer}. - * - * - * @param arrayBuffer The ArrayBuffer with which to share memory. - */ - new (arrayBuffer: ArrayBuffer): Buffer; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: any[]): Buffer; - /** - * Copies the passed {buffer} data onto a new {Buffer} instance. - * - * @param buffer The buffer to copy. - */ - new (buffer: Buffer): Buffer; - prototype: Buffer; - /** - * Allocates a new Buffer using an {array} of octets. - * - * @param array - */ - from(array: any[]): Buffer; - /** - * When passed a reference to the .buffer property of a TypedArray instance, - * the newly created Buffer will share the same allocated memory as the TypedArray. - * The optional {byteOffset} and {length} arguments specify a memory range - * within the {arrayBuffer} that will be shared by the Buffer. - * - * @param arrayBuffer The .buffer property of a TypedArray or a new ArrayBuffer() - * @param byteOffset - * @param length - */ - from(arrayBuffer: ArrayBuffer, byteOffset?: number, length?: number): Buffer; - /** - * Copies the passed {buffer} data onto a new Buffer instance. - * - * @param buffer - */ - from(buffer: Buffer): Buffer; - /** - * Creates a new Buffer containing the given JavaScript string {str}. - * If provided, the {encoding} parameter identifies the character encoding. - * If not provided, {encoding} defaults to 'utf8'. - * - * @param str - */ - from(str: string, encoding?: string): Buffer; - /** - * Returns true if {obj} is a Buffer - * - * @param obj object to test. - */ - isBuffer(obj: any): obj is Buffer; - /** - * Returns true if {encoding} is a valid encoding argument. - * Valid string encodings in Node 0.12: 'ascii'|'utf8'|'utf16le'|'ucs2'(alias of 'utf16le')|'base64'|'binary'(deprecated)|'hex' - * - * @param encoding string to test. - */ - isEncoding(encoding: string): boolean; - /** - * Gives the actual byte length of a string. encoding defaults to 'utf8'. - * This is not the same as String.prototype.length since that returns the number of characters in a string. - * - * @param string string to test. - * @param encoding encoding used to evaluate (defaults to 'utf8') - */ - byteLength(string: string, encoding?: string): number; - /** - * Returns a buffer which is the result of concatenating all the buffers in the list together. - * - * If the list has no items, or if the totalLength is 0, then it returns a zero-length buffer. - * If the list has exactly one item, then the first item of the list is returned. - * If the list has more than one item, then a new Buffer is created. - * - * @param list An array of Buffer objects to concatenate - * @param totalLength Total length of the buffers when concatenated. - * If totalLength is not provided, it is read from the buffers in the list. However, this adds an additional loop to the function, so it is faster to provide the length explicitly. - */ - concat(list: Buffer[], totalLength?: number): Buffer; - /** - * The same as buf1.compare(buf2). - */ - compare(buf1: Buffer, buf2: Buffer): number; - /** - * Allocates a new buffer of {size} octets. - * - * @param size count of octets to allocate. - * @param fill if specified, buffer will be initialized by calling buf.fill(fill). - * If parameter is omitted, buffer will be filled with zeros. - * @param encoding encoding used for call to buf.fill while initalizing - */ - alloc(size: number, fill?: string | Buffer | number, encoding?: string): Buffer; - /** - * Allocates a new buffer of {size} octets, leaving memory not initialized, so the contents - * of the newly created Buffer are unknown and may contain sensitive data. - * - * @param size count of octets to allocate - */ - allocUnsafe(size: number): Buffer; - /** - * Allocates a new non-pooled buffer of {size} octets, leaving memory not initialized, so the contents - * of the newly created Buffer are unknown and may contain sensitive data. - * - * @param size count of octets to allocate - */ - allocUnsafeSlow(size: number): Buffer; -}; - -/************************************************ -* * -* GLOBAL INTERFACES * -* * -************************************************/ -declare namespace NodeJS { - export interface ErrnoException extends Error { - errno?: string; - code?: string; - path?: string; - syscall?: string; - stack?: string; - } - - export class EventEmitter { - addListener(event: string | symbol, listener: Function): this; - on(event: string | symbol, listener: Function): this; - once(event: string | symbol, listener: Function): this; - removeListener(event: string | symbol, listener: Function): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - listenerCount(type: string | symbol): number; - // Added in Node 6... - prependListener(event: string | symbol, listener: Function): this; - prependOnceListener(event: string | symbol, listener: Function): this; - eventNames(): (string | symbol)[]; - } - - export interface ReadableStream extends EventEmitter { - readable: boolean; - read(size?: number): string | Buffer; - setEncoding(encoding: string): void; - pause(): ReadableStream; - resume(): ReadableStream; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: string): void; - unshift(chunk: Buffer): void; - wrap(oldStream: ReadableStream): ReadableStream; - } - - export interface WritableStream extends EventEmitter { - writable: boolean; - write(buffer: Buffer | string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - } - - export interface ReadWriteStream extends ReadableStream, WritableStream { - pause(): ReadWriteStream; - resume(): ReadWriteStream; - } - - export interface Events extends EventEmitter { } - - export interface Domain extends Events { - run(fn: Function): void; - add(emitter: Events): void; - remove(emitter: Events): void; - bind(cb: (err: Error, data: any) => any): any; - intercept(cb: (data: any) => any): any; - dispose(): void; - - addListener(event: string, listener: Function): this; - on(event: string, listener: Function): this; - once(event: string, listener: Function): this; - removeListener(event: string, listener: Function): this; - removeAllListeners(event?: string): this; - } - - export interface MemoryUsage { - rss: number; - heapTotal: number; - heapUsed: number; - } - - export interface ProcessVersions { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - modules: string; - openssl: string; - } - - export interface Process extends EventEmitter { - stdout: WritableStream; - stderr: WritableStream; - stdin: ReadableStream; - argv: string[]; - argv0: string; - execArgv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - env: any; - exit(code?: number): void; - exitCode: number; - getgid(): number; - setgid(id: number): void; - setgid(id: string): void; - getuid(): number; - setuid(id: number): void; - setuid(id: string): void; - version: string; - versions: ProcessVersions; - config: { - target_defaults: { - cflags: any[]; - default_configuration: string; - defines: string[]; - include_dirs: string[]; - libraries: string[]; - }; - variables: { - clang: number; - host_arch: string; - node_install_npm: boolean; - node_install_waf: boolean; - node_prefix: string; - node_shared_openssl: boolean; - node_shared_v8: boolean; - node_shared_zlib: boolean; - node_use_dtrace: boolean; - node_use_etw: boolean; - node_use_openssl: boolean; - target_arch: string; - v8_no_strict_aliasing: number; - v8_use_snapshot: boolean; - visibility: string; - }; - }; - kill(pid: number, signal?: string | number): void; - pid: number; - title: string; - arch: string; - platform: string; - memoryUsage(): MemoryUsage; - nextTick(callback: Function, ...args: any[]): void; - umask(mask?: number): number; - uptime(): number; - hrtime(time?: number[]): number[]; - domain: Domain; - - // Worker - send?(message: any, sendHandle?: any): void; - disconnect(): void; - connected: boolean; - } - - export interface Global { - Array: typeof Array; - ArrayBuffer: typeof ArrayBuffer; - Boolean: typeof Boolean; - Buffer: typeof Buffer; - DataView: typeof DataView; - Date: typeof Date; - Error: typeof Error; - EvalError: typeof EvalError; - Float32Array: typeof Float32Array; - Float64Array: typeof Float64Array; - Function: typeof Function; - GLOBAL: Global; - Infinity: typeof Infinity; - Int16Array: typeof Int16Array; - Int32Array: typeof Int32Array; - Int8Array: typeof Int8Array; - Intl: typeof Intl; - JSON: typeof JSON; - Map: MapConstructor; - Math: typeof Math; - NaN: typeof NaN; - Number: typeof Number; - Object: typeof Object; - Promise: Function; - RangeError: typeof RangeError; - ReferenceError: typeof ReferenceError; - RegExp: typeof RegExp; - Set: SetConstructor; - String: typeof String; - Symbol: Function; - SyntaxError: typeof SyntaxError; - TypeError: typeof TypeError; - URIError: typeof URIError; - Uint16Array: typeof Uint16Array; - Uint32Array: typeof Uint32Array; - Uint8Array: typeof Uint8Array; - Uint8ClampedArray: Function; - WeakMap: WeakMapConstructor; - WeakSet: WeakSetConstructor; - clearImmediate: (immediateId: any) => void; - clearInterval: (intervalId: NodeJS.Timer) => void; - clearTimeout: (timeoutId: NodeJS.Timer) => void; - console: typeof console; - decodeURI: typeof decodeURI; - decodeURIComponent: typeof decodeURIComponent; - encodeURI: typeof encodeURI; - encodeURIComponent: typeof encodeURIComponent; - escape: (str: string) => string; - eval: typeof eval; - global: Global; - isFinite: typeof isFinite; - isNaN: typeof isNaN; - parseFloat: typeof parseFloat; - parseInt: typeof parseInt; - process: Process; - root: Global; - setImmediate: (callback: (...args: any[]) => void, ...args: any[]) => any; - setInterval: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - setTimeout: (callback: (...args: any[]) => void, ms: number, ...args: any[]) => NodeJS.Timer; - undefined: typeof undefined; - unescape: (str: string) => string; - gc: () => void; - v8debug?: any; - } - - export interface Timer { - ref(): void; - unref(): void; - } -} - -interface IterableIterator { } - -/** - * @deprecated - */ -interface NodeBuffer extends Uint8Array { - write(string: string, offset?: number, length?: number, encoding?: string): number; - toString(encoding?: string, start?: number, end?: number): string; - toJSON(): { type: 'Buffer', data: any[] }; - equals(otherBuffer: Buffer): boolean; - compare(otherBuffer: Buffer, targetStart?: number, targetEnd?: number, sourceStart?: number, sourceEnd?: number): number; - copy(targetBuffer: Buffer, targetStart?: number, sourceStart?: number, sourceEnd?: number): number; - slice(start?: number, end?: number): Buffer; - writeUIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeUIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntLE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - writeIntBE(value: number, offset: number, byteLength: number, noAssert?: boolean): number; - readUIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readUIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntLE(offset: number, byteLength: number, noAssert?: boolean): number; - readIntBE(offset: number, byteLength: number, noAssert?: boolean): number; - readUInt8(offset: number, noAssert?: boolean): number; - readUInt16LE(offset: number, noAssert?: boolean): number; - readUInt16BE(offset: number, noAssert?: boolean): number; - readUInt32LE(offset: number, noAssert?: boolean): number; - readUInt32BE(offset: number, noAssert?: boolean): number; - readInt8(offset: number, noAssert?: boolean): number; - readInt16LE(offset: number, noAssert?: boolean): number; - readInt16BE(offset: number, noAssert?: boolean): number; - readInt32LE(offset: number, noAssert?: boolean): number; - readInt32BE(offset: number, noAssert?: boolean): number; - readFloatLE(offset: number, noAssert?: boolean): number; - readFloatBE(offset: number, noAssert?: boolean): number; - readDoubleLE(offset: number, noAssert?: boolean): number; - readDoubleBE(offset: number, noAssert?: boolean): number; - swap16(): Buffer; - swap32(): Buffer; - swap64(): Buffer; - writeUInt8(value: number, offset: number, noAssert?: boolean): number; - writeUInt16LE(value: number, offset: number, noAssert?: boolean): number; - writeUInt16BE(value: number, offset: number, noAssert?: boolean): number; - writeUInt32LE(value: number, offset: number, noAssert?: boolean): number; - writeUInt32BE(value: number, offset: number, noAssert?: boolean): number; - writeInt8(value: number, offset: number, noAssert?: boolean): number; - writeInt16LE(value: number, offset: number, noAssert?: boolean): number; - writeInt16BE(value: number, offset: number, noAssert?: boolean): number; - writeInt32LE(value: number, offset: number, noAssert?: boolean): number; - writeInt32BE(value: number, offset: number, noAssert?: boolean): number; - writeFloatLE(value: number, offset: number, noAssert?: boolean): number; - writeFloatBE(value: number, offset: number, noAssert?: boolean): number; - writeDoubleLE(value: number, offset: number, noAssert?: boolean): number; - writeDoubleBE(value: number, offset: number, noAssert?: boolean): number; - fill(value: any, offset?: number, end?: number): this; - indexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; - lastIndexOf(value: string | number | Buffer, byteOffset?: number, encoding?: string): number; - entries(): IterableIterator<[number, number]>; - includes(value: string | number | Buffer, byteOffset?: number, encoding?: string): boolean; - keys(): IterableIterator; - values(): IterableIterator; -} - -/************************************************ -* * -* MODULES * -* * -************************************************/ -declare module "buffer" { - export var INSPECT_MAX_BYTES: number; - var BuffType: typeof Buffer; - var SlowBuffType: typeof SlowBuffer; - export { BuffType as Buffer, SlowBuffType as SlowBuffer }; -} - -declare module "querystring" { - export interface StringifyOptions { - encodeURIComponent?: Function; - } - - export interface ParseOptions { - maxKeys?: number; - decodeURIComponent?: Function; - } - - export function stringify(obj: T, sep?: string, eq?: string, options?: StringifyOptions): string; - export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): any; - export function parse(str: string, sep?: string, eq?: string, options?: ParseOptions): T; - export function escape(str: string): string; - export function unescape(str: string): string; -} - -declare module "events" { - export class EventEmitter extends NodeJS.EventEmitter { - static EventEmitter: EventEmitter; - static listenerCount(emitter: EventEmitter, event: string | symbol): number; // deprecated - static defaultMaxListeners: number; - - addListener(event: string | symbol, listener: Function): this; - on(event: string | symbol, listener: Function): this; - once(event: string | symbol, listener: Function): this; - prependListener(event: string | symbol, listener: Function): this; - prependOnceListener(event: string | symbol, listener: Function): this; - removeListener(event: string | symbol, listener: Function): this; - removeAllListeners(event?: string | symbol): this; - setMaxListeners(n: number): this; - getMaxListeners(): number; - listeners(event: string | symbol): Function[]; - emit(event: string | symbol, ...args: any[]): boolean; - eventNames(): (string | symbol)[]; - listenerCount(type: string | symbol): number; - } -} - -declare module "http" { - import * as events from "events"; - import * as net from "net"; - import * as stream from "stream"; - - export interface RequestOptions { - protocol?: string; - host?: string; - hostname?: string; - family?: number; - port?: number; - localAddress?: string; - socketPath?: string; - method?: string; - path?: string; - headers?: { [key: string]: any }; - auth?: string; - agent?: Agent | boolean; - } - - export interface Server extends net.Server { - setTimeout(msecs: number, callback: Function): void; - maxHeadersCount: number; - timeout: number; - listening: boolean; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ServerRequest extends IncomingMessage { - connection: net.Socket; - } - export interface ServerResponse extends stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - writeContinue(): void; - writeHead(statusCode: number, reasonPhrase?: string, headers?: any): void; - writeHead(statusCode: number, headers?: any): void; - statusCode: number; - statusMessage: string; - headersSent: boolean; - setHeader(name: string, value: string | string[]): void; - setTimeout(msecs: number, callback: Function): ServerResponse; - sendDate: boolean; - getHeader(name: string): string; - removeHeader(name: string): void; - write(chunk: any, encoding?: string): any; - addTrailers(headers: any): void; - finished: boolean; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface ClientRequest extends stream.Writable { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - write(chunk: any, encoding?: string): void; - abort(): void; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setSocketKeepAlive(enable?: boolean, initialDelay?: number): void; - - setHeader(name: string, value: string | string[]): void; - getHeader(name: string): string; - removeHeader(name: string): void; - addTrailers(headers: any): void; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - } - export interface IncomingMessage extends stream.Readable { - httpVersion: string; - httpVersionMajor: number; - httpVersionMinor: number; - connection: net.Socket; - headers: any; - rawHeaders: string[]; - trailers: any; - rawTrailers: any; - setTimeout(msecs: number, callback: Function): NodeJS.Timer; - /** - * Only valid for request obtained from http.Server. - */ - method?: string; - /** - * Only valid for request obtained from http.Server. - */ - url?: string; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusCode?: number; - /** - * Only valid for response obtained from http.ClientRequest. - */ - statusMessage?: string; - socket: net.Socket; - destroy(error?: Error): void; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ClientResponse extends IncomingMessage { } - - export interface AgentOptions { - /** - * Keep sockets around in a pool to be used by other requests in the future. Default = false - */ - keepAlive?: boolean; - /** - * When using HTTP KeepAlive, how often to send TCP KeepAlive packets over sockets being kept alive. Default = 1000. - * Only relevant if keepAlive is set to true. - */ - keepAliveMsecs?: number; - /** - * Maximum number of sockets to allow per host. Default for Node 0.10 is 5, default for Node 0.12 is Infinity - */ - maxSockets?: number; - /** - * Maximum number of sockets to leave open in a free state. Only relevant if keepAlive is set to true. Default = 256. - */ - maxFreeSockets?: number; - } - - export class Agent { - maxSockets: number; - sockets: any; - requests: any; - - constructor(opts?: AgentOptions); - - /** - * Destroy any sockets that are currently in use by the agent. - * It is usually not necessary to do this. However, if you are using an agent with KeepAlive enabled, - * then it is best to explicitly shut down the agent when you know that it will no longer be used. Otherwise, - * sockets may hang open for quite a long time before the server terminates them. - */ - destroy(): void; - } - - export var METHODS: string[]; - - export var STATUS_CODES: { - [errorCode: number]: string; - [errorCode: string]: string; - }; - export function createServer(requestListener?: (request: IncomingMessage, response: ServerResponse) => void): Server; - export function createClient(port?: number, host?: string): any; - export function request(options: RequestOptions, callback?: (res: IncomingMessage) => void): ClientRequest; - export function get(options: any, callback?: (res: IncomingMessage) => void): ClientRequest; - export var globalAgent: Agent; -} - -declare module "cluster" { - import * as child from "child_process"; - import * as events from "events"; - import * as net from "net"; - - // interfaces - export interface ClusterSettings { - execArgv?: string[]; // default: process.execArgv - exec?: string; - args?: string[]; - silent?: boolean; - stdio?: any[]; - uid?: number; - gid?: number; - } - - export interface ClusterSetupMasterSettings { - exec?: string; // default: process.argv[1] - args?: string[]; // default: process.argv.slice(2) - silent?: boolean; // default: false - stdio?: any[]; - } - - export interface Address { - address: string; - port: number; - addressType: number | "udp4" | "udp6"; // 4, 6, -1, "udp4", "udp6" - } - - export class Worker extends events.EventEmitter { - id: string; - process: child.ChildProcess; - suicide: boolean; - send(message: any, sendHandle?: any): boolean; - kill(signal?: string): void; - destroy(signal?: string): void; - disconnect(): void; - isConnected(): boolean; - isDead(): boolean; - exitedAfterDisconnect: boolean; - - /** - * events.EventEmitter - * 1. disconnect - * 2. error - * 3. exit - * 4. listening - * 5. message - * 6. online - */ - addListener(event: string, listener: Function): this; - addListener(event: "disconnect", listener: () => void): this; - addListener(event: "error", listener: (code: number, signal: string) => void): this; - addListener(event: "exit", listener: (code: number, signal: string) => void): this; - addListener(event: "listening", listener: (address: Address) => void): this; - addListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - addListener(event: "online", listener: () => void): this; - - emit(event: string, listener: Function): boolean - emit(event: "disconnect", listener: () => void): boolean - emit(event: "error", listener: (code: number, signal: string) => void): boolean - emit(event: "exit", listener: (code: number, signal: string) => void): boolean - emit(event: "listening", listener: (address: Address) => void): boolean - emit(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): boolean - emit(event: "online", listener: () => void): boolean - - on(event: string, listener: Function): this; - on(event: "disconnect", listener: () => void): this; - on(event: "error", listener: (code: number, signal: string) => void): this; - on(event: "exit", listener: (code: number, signal: string) => void): this; - on(event: "listening", listener: (address: Address) => void): this; - on(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - on(event: "online", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "disconnect", listener: () => void): this; - once(event: "error", listener: (code: number, signal: string) => void): this; - once(event: "exit", listener: (code: number, signal: string) => void): this; - once(event: "listening", listener: (address: Address) => void): this; - once(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - once(event: "online", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "disconnect", listener: () => void): this; - prependListener(event: "error", listener: (code: number, signal: string) => void): this; - prependListener(event: "exit", listener: (code: number, signal: string) => void): this; - prependListener(event: "listening", listener: (address: Address) => void): this; - prependListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependListener(event: "online", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "disconnect", listener: () => void): this; - prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; - prependOnceListener(event: "exit", listener: (code: number, signal: string) => void): this; - prependOnceListener(event: "listening", listener: (address: Address) => void): this; - prependOnceListener(event: "message", listener: (message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependOnceListener(event: "online", listener: () => void): this; - } - - export interface Cluster extends events.EventEmitter { - Worker: Worker; - disconnect(callback?: Function): void; - fork(env?: any): Worker; - isMaster: boolean; - isWorker: boolean; - // TODO: cluster.schedulingPolicy - settings: ClusterSettings; - setupMaster(settings?: ClusterSetupMasterSettings): void; - worker: Worker; - workers: { - [index: string]: Worker - }; - - /** - * events.EventEmitter - * 1. disconnect - * 2. exit - * 3. fork - * 4. listening - * 5. message - * 6. online - * 7. setup - */ - addListener(event: string, listener: Function): this; - addListener(event: "disconnect", listener: (worker: Worker) => void): this; - addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - addListener(event: "fork", listener: (worker: Worker) => void): this; - addListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - addListener(event: "online", listener: (worker: Worker) => void): this; - addListener(event: "setup", listener: (settings: any) => void): this; - - emit(event: string, listener: Function): boolean; - emit(event: "disconnect", listener: (worker: Worker) => void): boolean; - emit(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): boolean; - emit(event: "fork", listener: (worker: Worker) => void): boolean; - emit(event: "listening", listener: (worker: Worker, address: Address) => void): boolean; - emit(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): boolean; - emit(event: "online", listener: (worker: Worker) => void): boolean; - emit(event: "setup", listener: (settings: any) => void): boolean; - - on(event: string, listener: Function): this; - on(event: "disconnect", listener: (worker: Worker) => void): this; - on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - on(event: "fork", listener: (worker: Worker) => void): this; - on(event: "listening", listener: (worker: Worker, address: Address) => void): this; - on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - on(event: "online", listener: (worker: Worker) => void): this; - on(event: "setup", listener: (settings: any) => void): this; - - once(event: string, listener: Function): this; - once(event: "disconnect", listener: (worker: Worker) => void): this; - once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - once(event: "fork", listener: (worker: Worker) => void): this; - once(event: "listening", listener: (worker: Worker, address: Address) => void): this; - once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - once(event: "online", listener: (worker: Worker) => void): this; - once(event: "setup", listener: (settings: any) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "disconnect", listener: (worker: Worker) => void): this; - prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - prependListener(event: "fork", listener: (worker: Worker) => void): this; - prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependListener(event: "online", listener: (worker: Worker) => void): this; - prependListener(event: "setup", listener: (settings: any) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): this; - prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): this; - prependOnceListener(event: "fork", listener: (worker: Worker) => void): this; - prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): this; - prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): this; // the handle is a net.Socket or net.Server object, or undefined. - prependOnceListener(event: "online", listener: (worker: Worker) => void): this; - prependOnceListener(event: "setup", listener: (settings: any) => void): this; - - } - - export function disconnect(callback?: Function): void; - export function fork(env?: any): Worker; - export var isMaster: boolean; - export var isWorker: boolean; - // TODO: cluster.schedulingPolicy - export var settings: ClusterSettings; - export function setupMaster(settings?: ClusterSetupMasterSettings): void; - export var worker: Worker; - export var workers: { - [index: string]: Worker - }; - - /** - * events.EventEmitter - * 1. disconnect - * 2. exit - * 3. fork - * 4. listening - * 5. message - * 6. online - * 7. setup - */ - export function addListener(event: string, listener: Function): Cluster; - export function addListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function addListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function addListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function addListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function addListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function emit(event: string, listener: Function): boolean; - export function emit(event: "disconnect", listener: (worker: Worker) => void): boolean; - export function emit(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): boolean; - export function emit(event: "fork", listener: (worker: Worker) => void): boolean; - export function emit(event: "listening", listener: (worker: Worker, address: Address) => void): boolean; - export function emit(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): boolean; - export function emit(event: "online", listener: (worker: Worker) => void): boolean; - export function emit(event: "setup", listener: (settings: any) => void): boolean; - - export function on(event: string, listener: Function): Cluster; - export function on(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function on(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function on(event: "fork", listener: (worker: Worker) => void): Cluster; - export function on(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function on(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function on(event: "online", listener: (worker: Worker) => void): Cluster; - export function on(event: "setup", listener: (settings: any) => void): Cluster; - - export function once(event: string, listener: Function): Cluster; - export function once(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function once(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function once(event: "fork", listener: (worker: Worker) => void): Cluster; - export function once(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function once(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function once(event: "online", listener: (worker: Worker) => void): Cluster; - export function once(event: "setup", listener: (settings: any) => void): Cluster; - - export function removeListener(event: string, listener: Function): Cluster; - export function removeAllListeners(event?: string): Cluster; - export function setMaxListeners(n: number): Cluster; - export function getMaxListeners(): number; - export function listeners(event: string): Function[]; - export function listenerCount(type: string): number; - - export function prependListener(event: string, listener: Function): Cluster; - export function prependListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function prependListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function prependListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function prependListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function prependListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function prependOnceListener(event: string, listener: Function): Cluster; - export function prependOnceListener(event: "disconnect", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "exit", listener: (worker: Worker, code: number, signal: string) => void): Cluster; - export function prependOnceListener(event: "fork", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "listening", listener: (worker: Worker, address: Address) => void): Cluster; - export function prependOnceListener(event: "message", listener: (worker: Worker, message: any, handle: net.Socket | net.Server) => void): Cluster; // the handle is a net.Socket or net.Server object, or undefined. - export function prependOnceListener(event: "online", listener: (worker: Worker) => void): Cluster; - export function prependOnceListener(event: "setup", listener: (settings: any) => void): Cluster; - - export function eventNames(): string[]; -} - -declare module "zlib" { - import * as stream from "stream"; - export interface ZlibOptions { chunkSize?: number; windowBits?: number; level?: number; memLevel?: number; strategy?: number; dictionary?: any; } - - export interface Gzip extends stream.Transform { } - export interface Gunzip extends stream.Transform { } - export interface Deflate extends stream.Transform { } - export interface Inflate extends stream.Transform { } - export interface DeflateRaw extends stream.Transform { } - export interface InflateRaw extends stream.Transform { } - export interface Unzip extends stream.Transform { } - - export function createGzip(options?: ZlibOptions): Gzip; - export function createGunzip(options?: ZlibOptions): Gunzip; - export function createDeflate(options?: ZlibOptions): Deflate; - export function createInflate(options?: ZlibOptions): Inflate; - export function createDeflateRaw(options?: ZlibOptions): DeflateRaw; - export function createInflateRaw(options?: ZlibOptions): InflateRaw; - export function createUnzip(options?: ZlibOptions): Unzip; - - export function deflate(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function deflateSync(buf: Buffer, options?: ZlibOptions): any; - export function deflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function deflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function gzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function gzipSync(buf: Buffer, options?: ZlibOptions): any; - export function gunzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function gunzipSync(buf: Buffer, options?: ZlibOptions): any; - export function inflate(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function inflateSync(buf: Buffer, options?: ZlibOptions): any; - export function inflateRaw(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function inflateRawSync(buf: Buffer, options?: ZlibOptions): any; - export function unzip(buf: Buffer, callback: (error: Error, result: any) => void): void; - export function unzipSync(buf: Buffer, options?: ZlibOptions): any; - - // Constants - export var Z_NO_FLUSH: number; - export var Z_PARTIAL_FLUSH: number; - export var Z_SYNC_FLUSH: number; - export var Z_FULL_FLUSH: number; - export var Z_FINISH: number; - export var Z_BLOCK: number; - export var Z_TREES: number; - export var Z_OK: number; - export var Z_STREAM_END: number; - export var Z_NEED_DICT: number; - export var Z_ERRNO: number; - export var Z_STREAM_ERROR: number; - export var Z_DATA_ERROR: number; - export var Z_MEM_ERROR: number; - export var Z_BUF_ERROR: number; - export var Z_VERSION_ERROR: number; - export var Z_NO_COMPRESSION: number; - export var Z_BEST_SPEED: number; - export var Z_BEST_COMPRESSION: number; - export var Z_DEFAULT_COMPRESSION: number; - export var Z_FILTERED: number; - export var Z_HUFFMAN_ONLY: number; - export var Z_RLE: number; - export var Z_FIXED: number; - export var Z_DEFAULT_STRATEGY: number; - export var Z_BINARY: number; - export var Z_TEXT: number; - export var Z_ASCII: number; - export var Z_UNKNOWN: number; - export var Z_DEFLATED: number; - export var Z_NULL: number; -} - -declare module "os" { - export interface CpuInfo { - model: string; - speed: number; - times: { - user: number; - nice: number; - sys: number; - idle: number; - irq: number; - }; - } - - export interface NetworkInterfaceInfo { - address: string; - netmask: string; - family: string; - mac: string; - internal: boolean; - } - - export function hostname(): string; - export function loadavg(): number[]; - export function uptime(): number; - export function freemem(): number; - export function totalmem(): number; - export function cpus(): CpuInfo[]; - export function type(): string; - export function release(): string; - export function networkInterfaces(): { [index: string]: NetworkInterfaceInfo[] }; - export function homedir(): string; - export function userInfo(options?: { encoding: string }): { username: string, uid: number, gid: number, shell: any, homedir: string } - export var constants: { - UV_UDP_REUSEADDR: number, - errno: { - SIGHUP: number; - SIGINT: number; - SIGQUIT: number; - SIGILL: number; - SIGTRAP: number; - SIGABRT: number; - SIGIOT: number; - SIGBUS: number; - SIGFPE: number; - SIGKILL: number; - SIGUSR1: number; - SIGSEGV: number; - SIGUSR2: number; - SIGPIPE: number; - SIGALRM: number; - SIGTERM: number; - SIGCHLD: number; - SIGSTKFLT: number; - SIGCONT: number; - SIGSTOP: number; - SIGTSTP: number; - SIGTTIN: number; - SIGTTOU: number; - SIGURG: number; - SIGXCPU: number; - SIGXFSZ: number; - SIGVTALRM: number; - SIGPROF: number; - SIGWINCH: number; - SIGIO: number; - SIGPOLL: number; - SIGPWR: number; - SIGSYS: number; - SIGUNUSED: number; - }, - signals: { - E2BIG: number; - EACCES: number; - EADDRINUSE: number; - EADDRNOTAVAIL: number; - EAFNOSUPPORT: number; - EAGAIN: number; - EALREADY: number; - EBADF: number; - EBADMSG: number; - EBUSY: number; - ECANCELED: number; - ECHILD: number; - ECONNABORTED: number; - ECONNREFUSED: number; - ECONNRESET: number; - EDEADLK: number; - EDESTADDRREQ: number; - EDOM: number; - EDQUOT: number; - EEXIST: number; - EFAULT: number; - EFBIG: number; - EHOSTUNREACH: number; - EIDRM: number; - EILSEQ: number; - EINPROGRESS: number; - EINTR: number; - EINVAL: number; - EIO: number; - EISCONN: number; - EISDIR: number; - ELOOP: number; - EMFILE: number; - EMLINK: number; - EMSGSIZE: number; - EMULTIHOP: number; - ENAMETOOLONG: number; - ENETDOWN: number; - ENETRESET: number; - ENETUNREACH: number; - ENFILE: number; - ENOBUFS: number; - ENODATA: number; - ENODEV: number; - ENOENT: number; - ENOEXEC: number; - ENOLCK: number; - ENOLINK: number; - ENOMEM: number; - ENOMSG: number; - ENOPROTOOPT: number; - ENOSPC: number; - ENOSR: number; - ENOSTR: number; - ENOSYS: number; - ENOTCONN: number; - ENOTDIR: number; - ENOTEMPTY: number; - ENOTSOCK: number; - ENOTSUP: number; - ENOTTY: number; - ENXIO: number; - EOPNOTSUPP: number; - EOVERFLOW: number; - EPERM: number; - EPIPE: number; - EPROTO: number; - EPROTONOSUPPORT: number; - EPROTOTYPE: number; - ERANGE: number; - EROFS: number; - ESPIPE: number; - ESRCH: number; - ESTALE: number; - ETIME: number; - ETIMEDOUT: number; - ETXTBSY: number; - EWOULDBLOCK: number; - EXDEV: number; - }, - }; - export function arch(): string; - export function platform(): string; - export function tmpdir(): string; - export var EOL: string; - export function endianness(): "BE" | "LE"; -} - -declare module "https" { - import * as tls from "tls"; - import * as events from "events"; - import * as http from "http"; - - export interface ServerOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - crl?: any; - ciphers?: string; - honorCipherOrder?: boolean; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: any; - SNICallback?: (servername: string, cb: (err: Error, ctx: tls.SecureContext) => any) => any; - } - - export interface RequestOptions extends http.RequestOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - ciphers?: string; - rejectUnauthorized?: boolean; - secureProtocol?: string; - } - - export interface Agent extends http.Agent { } - - export interface AgentOptions extends http.AgentOptions { - pfx?: any; - key?: any; - passphrase?: string; - cert?: any; - ca?: any; - ciphers?: string; - rejectUnauthorized?: boolean; - secureProtocol?: string; - maxCachedSessions?: number; - } - - export var Agent: { - new (options?: AgentOptions): Agent; - }; - export interface Server extends tls.Server { } - export function createServer(options: ServerOptions, requestListener?: Function): Server; - export function request(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; - export function get(options: RequestOptions, callback?: (res: http.IncomingMessage) => void): http.ClientRequest; - export var globalAgent: Agent; -} - -declare module "punycode" { - export function decode(string: string): string; - export function encode(string: string): string; - export function toUnicode(domain: string): string; - export function toASCII(domain: string): string; - export var ucs2: ucs2; - interface ucs2 { - decode(string: string): number[]; - encode(codePoints: number[]): string; - } - export var version: any; -} - -declare module "repl" { - import * as stream from "stream"; - import * as readline from "readline"; - - export interface ReplOptions { - prompt?: string; - input?: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - terminal?: boolean; - eval?: Function; - useColors?: boolean; - useGlobal?: boolean; - ignoreUndefined?: boolean; - writer?: Function; - completer?: Function; - replMode?: any; - breakEvalOnSigint?: any; - } - - export interface REPLServer extends readline.ReadLine { - defineCommand(keyword: string, cmd: Function | { help: string, action: Function }): void; - displayPrompt(preserveCursor?: boolean): void - } - - export function start(options: ReplOptions): REPLServer; -} - -declare module "readline" { - import * as events from "events"; - import * as stream from "stream"; - - export interface Key { - sequence?: string; - name?: string; - ctrl?: boolean; - meta?: boolean; - shift?: boolean; - } - - export interface ReadLine extends events.EventEmitter { - setPrompt(prompt: string): void; - prompt(preserveCursor?: boolean): void; - question(query: string, callback: (answer: string) => void): void; - pause(): ReadLine; - resume(): ReadLine; - close(): void; - write(data: string | Buffer, key?: Key): void; - } - - export interface Completer { - (line: string): CompleterResult; - (line: string, callback: (err: any, result: CompleterResult) => void): any; - } - - export interface CompleterResult { - completions: string[]; - line: string; - } - - export interface ReadLineOptions { - input: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - completer?: Completer; - terminal?: boolean; - historySize?: number; - } - - export function createInterface(input: NodeJS.ReadableStream, output?: NodeJS.WritableStream, completer?: Completer, terminal?: boolean): ReadLine; - export function createInterface(options: ReadLineOptions): ReadLine; - - export function cursorTo(stream: NodeJS.WritableStream, x: number, y: number): void; - export function moveCursor(stream: NodeJS.WritableStream, dx: number | string, dy: number | string): void; - export function clearLine(stream: NodeJS.WritableStream, dir: number): void; - export function clearScreenDown(stream: NodeJS.WritableStream): void; -} - -declare module "vm" { - export interface Context { } - export interface ScriptOptions { - filename?: string; - lineOffset?: number; - columnOffset?: number; - displayErrors?: boolean; - timeout?: number; - cachedData?: Buffer; - produceCachedData?: boolean; - } - export interface RunningScriptOptions { - filename?: string; - lineOffset?: number; - columnOffset?: number; - displayErrors?: boolean; - timeout?: number; - } - export class Script { - constructor(code: string, options?: ScriptOptions); - runInContext(contextifiedSandbox: Context, options?: RunningScriptOptions): any; - runInNewContext(sandbox?: Context, options?: RunningScriptOptions): any; - runInThisContext(options?: RunningScriptOptions): any; - } - export function createContext(sandbox?: Context): Context; - export function isContext(sandbox: Context): boolean; - export function runInContext(code: string, contextifiedSandbox: Context, options?: RunningScriptOptions): any; - export function runInDebugContext(code: string): any; - export function runInNewContext(code: string, sandbox?: Context, options?: RunningScriptOptions): any; - export function runInThisContext(code: string, options?: RunningScriptOptions): any; -} - -declare module "child_process" { - import * as events from "events"; - import * as stream from "stream"; - - export interface ChildProcess extends events.EventEmitter { - stdin: stream.Writable; - stdout: stream.Readable; - stderr: stream.Readable; - stdio: [stream.Writable, stream.Readable, stream.Readable]; - pid: number; - kill(signal?: string): void; - send(message: any, sendHandle?: any): boolean; - connected: boolean; - disconnect(): void; - unref(): void; - ref(): void; - } - - export interface SpawnOptions { - cwd?: string; - env?: any; - stdio?: any; - detached?: boolean; - uid?: number; - gid?: number; - shell?: boolean | string; - } - export function spawn(command: string, args?: string[], options?: SpawnOptions): ChildProcess; - - export interface ExecOptions { - cwd?: string; - env?: any; - shell?: string; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - uid?: number; - gid?: number; - } - export interface ExecOptionsWithStringEncoding extends ExecOptions { - encoding: BufferEncoding; - } - export interface ExecOptionsWithBufferEncoding extends ExecOptions { - encoding: string; // specify `null`. - } - export function exec(command: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function exec(command: string, options: ExecOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.exec("tsc", {encoding: null as string}, (err, stdout, stderr) => {}); - export function exec(command: string, options: ExecOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function exec(command: string, options: ExecOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - - export interface ExecFileOptions { - cwd?: string; - env?: any; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - uid?: number; - gid?: number; - } - export interface ExecFileOptionsWithStringEncoding extends ExecFileOptions { - encoding: BufferEncoding; - } - export interface ExecFileOptionsWithBufferEncoding extends ExecFileOptions { - encoding: string; // specify `null`. - } - export function execFile(file: string, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.execFile("file.sh", {encoding: null as string}, (err, stdout, stderr) => {}); - export function execFile(file: string, options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function execFile(file: string, options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, args?: string[], callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithStringEncoding, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - // usage. child_process.execFile("file.sh", ["foo"], {encoding: null as string}, (err, stdout, stderr) => {}); - export function execFile(file: string, args?: string[], options?: ExecFileOptionsWithBufferEncoding, callback?: (error: Error, stdout: Buffer, stderr: Buffer) => void): ChildProcess; - export function execFile(file: string, args?: string[], options?: ExecFileOptions, callback?: (error: Error, stdout: string, stderr: string) => void): ChildProcess; - - export interface ForkOptions { - cwd?: string; - env?: any; - execPath?: string; - execArgv?: string[]; - silent?: boolean; - uid?: number; - gid?: number; - } - export function fork(modulePath: string, args?: string[], options?: ForkOptions): ChildProcess; - - export interface SpawnSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - shell?: boolean | string; - } - export interface SpawnSyncOptionsWithStringEncoding extends SpawnSyncOptions { - encoding: BufferEncoding; - } - export interface SpawnSyncOptionsWithBufferEncoding extends SpawnSyncOptions { - encoding: string; // specify `null`. - } - export interface SpawnSyncReturns { - pid: number; - output: string[]; - stdout: T; - stderr: T; - status: number; - signal: string; - error: Error; - } - export function spawnSync(command: string): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; - export function spawnSync(command: string, options?: SpawnSyncOptions): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithStringEncoding): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptionsWithBufferEncoding): SpawnSyncReturns; - export function spawnSync(command: string, args?: string[], options?: SpawnSyncOptions): SpawnSyncReturns; - - export interface ExecSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - shell?: string; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - } - export interface ExecSyncOptionsWithStringEncoding extends ExecSyncOptions { - encoding: BufferEncoding; - } - export interface ExecSyncOptionsWithBufferEncoding extends ExecSyncOptions { - encoding: string; // specify `null`. - } - export function execSync(command: string): Buffer; - export function execSync(command: string, options?: ExecSyncOptionsWithStringEncoding): string; - export function execSync(command: string, options?: ExecSyncOptionsWithBufferEncoding): Buffer; - export function execSync(command: string, options?: ExecSyncOptions): Buffer; - - export interface ExecFileSyncOptions { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - killSignal?: string; - maxBuffer?: number; - encoding?: string; - } - export interface ExecFileSyncOptionsWithStringEncoding extends ExecFileSyncOptions { - encoding: BufferEncoding; - } - export interface ExecFileSyncOptionsWithBufferEncoding extends ExecFileSyncOptions { - encoding: string; // specify `null`. - } - export function execFileSync(command: string): Buffer; - export function execFileSync(command: string, options?: ExecFileSyncOptionsWithStringEncoding): string; - export function execFileSync(command: string, options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; - export function execFileSync(command: string, options?: ExecFileSyncOptions): Buffer; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithStringEncoding): string; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptionsWithBufferEncoding): Buffer; - export function execFileSync(command: string, args?: string[], options?: ExecFileSyncOptions): Buffer; -} - -declare module "url" { - export interface Url { - href?: string; - protocol?: string; - auth?: string; - hostname?: string; - port?: string; - host?: string; - pathname?: string; - search?: string; - query?: string | any; - slashes?: boolean; - hash?: string; - path?: string; - } - - export function parse(urlStr: string, parseQueryString?: boolean, slashesDenoteHost?: boolean): Url; - export function format(url: Url): string; - export function resolve(from: string, to: string): string; -} - -declare module "dns" { - export interface MxRecord { - exchange: string, - priority: number - } - - export function lookup(domain: string, family: number, callback: (err: Error, address: string, family: number) => void): string; - export function lookup(domain: string, callback: (err: Error, address: string, family: number) => void): string; - export function resolve(domain: string, rrtype: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve4(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolve6(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveMx(domain: string, callback: (err: Error, addresses: MxRecord[]) => void): string[]; - export function resolveTxt(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveSrv(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveNs(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function resolveCname(domain: string, callback: (err: Error, addresses: string[]) => void): string[]; - export function reverse(ip: string, callback: (err: Error, domains: string[]) => void): string[]; - export function setServers(servers: string[]): void; - - //Error codes - export var NODATA: string; - export var FORMERR: string; - export var SERVFAIL: string; - export var NOTFOUND: string; - export var NOTIMP: string; - export var REFUSED: string; - export var BADQUERY: string; - export var BADNAME: string; - export var BADFAMILY: string; - export var BADRESP: string; - export var CONNREFUSED: string; - export var TIMEOUT: string; - export var EOF: string; - export var FILE: string; - export var NOMEM: string; - export var DESTRUCTION: string; - export var BADSTR: string; - export var BADFLAGS: string; - export var NONAME: string; - export var BADHINTS: string; - export var NOTINITIALIZED: string; - export var LOADIPHLPAPI: string; - export var ADDRGETNETWORKPARAMS: string; - export var CANCELLED: string; -} - -declare module "net" { - import * as stream from "stream"; - import * as events from "events"; - - export interface Socket extends stream.Duplex { - // Extended base methods - write(buffer: Buffer): boolean; - write(buffer: Buffer, cb?: Function): boolean; - write(str: string, cb?: Function): boolean; - write(str: string, encoding?: string, cb?: Function): boolean; - write(str: string, encoding?: string, fd?: string): boolean; - - connect(port: number, host?: string, connectionListener?: Function): void; - connect(path: string, connectionListener?: Function): void; - bufferSize: number; - setEncoding(encoding?: string): void; - write(data: any, encoding?: string, callback?: Function): void; - destroy(): void; - pause(): Socket; - resume(): Socket; - setTimeout(timeout: number, callback?: Function): void; - setNoDelay(noDelay?: boolean): void; - setKeepAlive(enable?: boolean, initialDelay?: number): void; - address(): { port: number; family: string; address: string; }; - unref(): void; - ref(): void; - - remoteAddress: string; - remoteFamily: string; - remotePort: number; - localAddress: string; - localPort: number; - bytesRead: number; - bytesWritten: number; - - // Extended base methods - end(): void; - end(buffer: Buffer, cb?: Function): void; - end(str: string, cb?: Function): void; - end(str: string, encoding?: string, cb?: Function): void; - end(data?: any, encoding?: string): void; - - /** - * events.EventEmitter - * 1. close - * 2. connect - * 3. data - * 4. drain - * 5. end - * 6. error - * 7. lookup - * 8. timeout - */ - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: (had_error: boolean) => void): this; - addListener(event: "connect", listener: () => void): this; - addListener(event: "data", listener: (data: Buffer) => void): this; - addListener(event: "drain", listener: () => void): this; - addListener(event: "end", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; - addListener(event: "timeout", listener: () => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close", had_error: boolean): boolean; - emit(event: "connect"): boolean; - emit(event: "data", data: Buffer): boolean; - emit(event: "drain"): boolean; - emit(event: "end"): boolean; - emit(event: "error", err: Error): boolean; - emit(event: "lookup", err: Error, address: string, family: string | number, host: string): boolean; - emit(event: "timeout"): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: (had_error: boolean) => void): this; - on(event: "connect", listener: () => void): this; - on(event: "data", listener: (data: Buffer) => void): this; - on(event: "drain", listener: () => void): this; - on(event: "end", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - on(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; - on(event: "timeout", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: (had_error: boolean) => void): this; - once(event: "connect", listener: () => void): this; - once(event: "data", listener: (data: Buffer) => void): this; - once(event: "drain", listener: () => void): this; - once(event: "end", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - once(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; - once(event: "timeout", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: (had_error: boolean) => void): this; - prependListener(event: "connect", listener: () => void): this; - prependListener(event: "data", listener: (data: Buffer) => void): this; - prependListener(event: "drain", listener: () => void): this; - prependListener(event: "end", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; - prependListener(event: "timeout", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: (had_error: boolean) => void): this; - prependOnceListener(event: "connect", listener: () => void): this; - prependOnceListener(event: "data", listener: (data: Buffer) => void): this; - prependOnceListener(event: "drain", listener: () => void): this; - prependOnceListener(event: "end", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "lookup", listener: (err: Error, address: string, family: string | number, host: string) => void): this; - prependOnceListener(event: "timeout", listener: () => void): this; - } - - export var Socket: { - new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; - }; - - export interface ListenOptions { - port?: number; - host?: string; - backlog?: number; - path?: string; - exclusive?: boolean; - } - - export interface Server extends events.EventEmitter { - listen(port: number, hostname?: string, backlog?: number, listeningListener?: Function): Server; - listen(port: number, hostname?: string, listeningListener?: Function): Server; - listen(port: number, backlog?: number, listeningListener?: Function): Server; - listen(port: number, listeningListener?: Function): Server; - listen(path: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, backlog?: number, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - listen(options: ListenOptions, listeningListener?: Function): Server; - close(callback?: Function): Server; - address(): { port: number; family: string; address: string; }; - getConnections(cb: (error: Error, count: number) => void): void; - ref(): Server; - unref(): Server; - maxConnections: number; - connections: number; - - /** - * events.EventEmitter - * 1. close - * 2. connection - * 3. error - * 4. listening - */ - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "connection", listener: (socket: Socket) => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "listening", listener: () => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "connection", socket: Socket): boolean; - emit(event: "error", err: Error): boolean; - emit(event: "listening"): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "connection", listener: (socket: Socket) => void): this; - on(event: "error", listener: (err: Error) => void): this; - on(event: "listening", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "connection", listener: (socket: Socket) => void): this; - once(event: "error", listener: (err: Error) => void): this; - once(event: "listening", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "connection", listener: (socket: Socket) => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "listening", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "connection", listener: (socket: Socket) => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "listening", listener: () => void): this; - } - export function createServer(connectionListener?: (socket: Socket) => void): Server; - export function createServer(options?: { allowHalfOpen?: boolean; }, connectionListener?: (socket: Socket) => void): Server; - export function connect(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function connect(port: number, host?: string, connectionListener?: Function): Socket; - export function connect(path: string, connectionListener?: Function): Socket; - export function createConnection(options: { port: number, host?: string, localAddress?: string, localPort?: string, family?: number, allowHalfOpen?: boolean; }, connectionListener?: Function): Socket; - export function createConnection(port: number, host?: string, connectionListener?: Function): Socket; - export function createConnection(path: string, connectionListener?: Function): Socket; - export function isIP(input: string): number; - export function isIPv4(input: string): boolean; - export function isIPv6(input: string): boolean; -} - -declare module "dgram" { - import * as events from "events"; - - interface RemoteInfo { - address: string; - family: string; - port: number; - } - - interface AddressInfo { - address: string; - family: string; - port: number; - } - - interface BindOptions { - port: number; - address?: string; - exclusive?: boolean; - } - - interface SocketOptions { - type: "udp4" | "udp6"; - reuseAddr?: boolean; - } - - export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - export function createSocket(options: SocketOptions, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - - export interface Socket extends events.EventEmitter { - send(msg: Buffer | String | any[], port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - send(msg: Buffer | String | any[], offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - bind(port?: number, address?: string, callback?: () => void): void; - bind(options: BindOptions, callback?: Function): void; - close(callback?: any): void; - address(): AddressInfo; - setBroadcast(flag: boolean): void; - setTTL(ttl: number): void; - setMulticastTTL(ttl: number): void; - setMulticastLoopback(flag: boolean): void; - addMembership(multicastAddress: string, multicastInterface?: string): void; - dropMembership(multicastAddress: string, multicastInterface?: string): void; - ref(): void; - unref(): void; - - /** - * events.EventEmitter - * 1. close - * 2. error - * 3. listening - * 4. message - **/ - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "listening", listener: () => void): this; - addListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "error", err: Error): boolean; - emit(event: "listening"): boolean; - emit(event: "message", msg: string, rinfo: AddressInfo): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - on(event: "listening", listener: () => void): this; - on(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - once(event: "listening", listener: () => void): this; - once(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "listening", listener: () => void): this; - prependListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "listening", listener: () => void): this; - prependOnceListener(event: "message", listener: (msg: string, rinfo: AddressInfo) => void): this; - } -} - -declare module "fs" { - import * as stream from "stream"; - import * as events from "events"; - - interface Stats { - isFile(): boolean; - isDirectory(): boolean; - isBlockDevice(): boolean; - isCharacterDevice(): boolean; - isSymbolicLink(): boolean; - isFIFO(): boolean; - isSocket(): boolean; - dev: number; - ino: number; - mode: number; - nlink: number; - uid: number; - gid: number; - rdev: number; - size: number; - blksize: number; - blocks: number; - atime: Date; - mtime: Date; - ctime: Date; - birthtime: Date; - } - - interface FSWatcher extends events.EventEmitter { - close(): void; - - /** - * events.EventEmitter - * 1. change - * 2. error - */ - addListener(event: string, listener: Function): this; - addListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - addListener(event: "error", listener: (code: number, signal: string) => void): this; - - on(event: string, listener: Function): this; - on(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - on(event: "error", listener: (code: number, signal: string) => void): this; - - once(event: string, listener: Function): this; - once(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - once(event: "error", listener: (code: number, signal: string) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - prependListener(event: "error", listener: (code: number, signal: string) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "change", listener: (eventType: string, filename: string | Buffer) => void): this; - prependOnceListener(event: "error", listener: (code: number, signal: string) => void): this; - } - - export interface ReadStream extends stream.Readable { - close(): void; - destroy(): void; - - /** - * events.EventEmitter - * 1. open - * 2. close - */ - addListener(event: string, listener: Function): this; - addListener(event: "open", listener: (fd: number) => void): this; - addListener(event: "close", listener: () => void): this; - - on(event: string, listener: Function): this; - on(event: "open", listener: (fd: number) => void): this; - on(event: "close", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "open", listener: (fd: number) => void): this; - once(event: "close", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "open", listener: (fd: number) => void): this; - prependListener(event: "close", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; - prependOnceListener(event: "close", listener: () => void): this; - } - - export interface WriteStream extends stream.Writable { - close(): void; - bytesWritten: number; - path: string | Buffer; - - /** - * events.EventEmitter - * 1. open - * 2. close - */ - addListener(event: string, listener: Function): this; - addListener(event: "open", listener: (fd: number) => void): this; - addListener(event: "close", listener: () => void): this; - - on(event: string, listener: Function): this; - on(event: "open", listener: (fd: number) => void): this; - on(event: "close", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "open", listener: (fd: number) => void): this; - once(event: "close", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "open", listener: (fd: number) => void): this; - prependListener(event: "close", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "open", listener: (fd: number) => void): this; - prependOnceListener(event: "close", listener: () => void): this; - } - - /** - * Asynchronous rename. - * @param oldPath - * @param newPath - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rename(oldPath: string, newPath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /** - * Synchronous rename - * @param oldPath - * @param newPath - */ - export function renameSync(oldPath: string, newPath: string): void; - export function truncate(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncate(path: string | Buffer, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncateSync(path: string | Buffer, len?: number): void; - export function ftruncate(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncate(fd: number, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function ftruncateSync(fd: number, len?: number): void; - export function chown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chownSync(path: string | Buffer, uid: number, gid: number): void; - export function fchown(fd: number, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchownSync(fd: number, uid: number, gid: number): void; - export function lchown(path: string | Buffer, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchownSync(path: string | Buffer, uid: number, gid: number): void; - export function chmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmodSync(path: string | Buffer, mode: number): void; - export function chmodSync(path: string | Buffer, mode: string): void; - export function fchmod(fd: number, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmod(fd: number, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fchmodSync(fd: number, mode: number): void; - export function fchmodSync(fd: number, mode: string): void; - export function lchmod(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmod(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmodSync(path: string | Buffer, mode: number): void; - export function lchmodSync(path: string | Buffer, mode: string): void; - export function stat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function lstat(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function fstat(fd: number, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function statSync(path: string | Buffer): Stats; - export function lstatSync(path: string | Buffer): Stats; - export function fstatSync(fd: number): Stats; - export function link(srcpath: string | Buffer, dstpath: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function linkSync(srcpath: string | Buffer, dstpath: string | Buffer): void; - export function symlink(srcpath: string | Buffer, dstpath: string | Buffer, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function symlinkSync(srcpath: string | Buffer, dstpath: string | Buffer, type?: string): void; - export function readlink(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; - export function readlinkSync(path: string | Buffer): string; - export function realpath(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpath(path: string | Buffer, cache: { [path: string]: string }, callback: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpathSync(path: string | Buffer, cache?: { [path: string]: string }): string; - /* - * Asynchronous unlink - deletes the file specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function unlink(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous unlink - deletes the file specified in {path} - * - * @param path - */ - export function unlinkSync(path: string | Buffer): void; - /* - * Asynchronous rmdir - removes the directory specified in {path} - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function rmdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous rmdir - removes the directory specified in {path} - * - * @param path - */ - export function rmdirSync(path: string | Buffer): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Asynchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdir(path: string | Buffer, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string | Buffer, mode?: number): void; - /* - * Synchronous mkdir - creates the directory specified in {path}. Parameter {mode} defaults to 0777. - * - * @param path - * @param mode - * @param callback No arguments other than a possible exception are given to the completion callback. - */ - export function mkdirSync(path: string | Buffer, mode?: string): void; - /* - * Asynchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. - * - * @param prefix - * @param callback The created folder path is passed as a string to the callback's second parameter. - */ - export function mkdtemp(prefix: string, callback?: (err: NodeJS.ErrnoException, folder: string) => void): void; - /* - * Synchronous mkdtemp - Creates a unique temporary directory. Generates six random characters to be appended behind a required prefix to create a unique temporary directory. - * - * @param prefix - * @returns Returns the created folder path. - */ - export function mkdtempSync(prefix: string): string; - export function readdir(path: string | Buffer, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; - export function readdirSync(path: string | Buffer): string[]; - export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function closeSync(fd: number): void; - export function open(path: string | Buffer, flags: string | number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; - export function open(path: string | Buffer, flags: string | number, mode: number, callback: (err: NodeJS.ErrnoException, fd: number) => void): void; - export function openSync(path: string | Buffer, flags: string | number, mode?: number): number; - export function utimes(path: string | Buffer, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimes(path: string | Buffer, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimesSync(path: string | Buffer, atime: number, mtime: number): void; - export function utimesSync(path: string | Buffer, atime: Date, mtime: Date): void; - export function futimes(fd: number, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimes(fd: number, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function futimesSync(fd: number, atime: number, mtime: number): void; - export function futimesSync(fd: number, atime: Date, mtime: Date): void; - export function fsync(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function fsyncSync(fd: number): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function write(fd: number, buffer: Buffer, offset: number, length: number, callback?: (err: NodeJS.ErrnoException, written: number, buffer: Buffer) => void): void; - export function write(fd: number, data: any, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function write(fd: number, data: any, offset: number, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function write(fd: number, data: any, offset: number, encoding: string, callback?: (err: NodeJS.ErrnoException, written: number, str: string) => void): void; - export function writeSync(fd: number, buffer: Buffer, offset: number, length: number, position?: number): number; - export function writeSync(fd: number, data: any, position?: number, enconding?: string): number; - export function read(fd: number, buffer: Buffer, offset: number, length: number, position: number, callback?: (err: NodeJS.ErrnoException, bytesRead: number, buffer: Buffer) => void): void; - export function readSync(fd: number, buffer: Buffer, offset: number, length: number, position: number): number; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, encoding: string, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { encoding: string; flag?: string; }, callback: (err: NodeJS.ErrnoException, data: string) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFile returns a string; otherwise it returns a Buffer. - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, options: { flag?: string; }, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Asynchronous readFile - Asynchronously reads the entire contents of a file. - * - * @param fileName - * @param callback - The callback is passed two arguments (err, data), where data is the contents of the file. - */ - export function readFile(filename: string, callback: (err: NodeJS.ErrnoException, data: Buffer) => void): void; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param encoding - */ - export function readFileSync(filename: string, encoding: string): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options: { encoding: string; flag?: string; }): string; - /* - * Synchronous readFile - Synchronously reads the entire contents of a file. - * - * @param fileName - * @param options An object with optional {encoding} and {flag} properties. If {encoding} is specified, readFileSync returns a string; otherwise it returns a Buffer. - */ - export function readFileSync(filename: string, options?: { flag?: string; }): Buffer; - export function writeFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function writeFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: number; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, options: { encoding?: string; mode?: string; flag?: string; }, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFile(filename: string, data: any, callback?: (err: NodeJS.ErrnoException) => void): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: number; flag?: string; }): void; - export function appendFileSync(filename: string, data: any, options?: { encoding?: string; mode?: string; flag?: string; }): void; - export function watchFile(filename: string, listener: (curr: Stats, prev: Stats) => void): void; - export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: (curr: Stats, prev: Stats) => void): void; - export function unwatchFile(filename: string, listener?: (curr: Stats, prev: Stats) => void): void; - export function watch(filename: string, listener?: (event: string, filename: string) => any): FSWatcher; - export function watch(filename: string, encoding: string, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; - export function watch(filename: string, options: { persistent?: boolean; recursive?: boolean; encoding?: string }, listener?: (event: string, filename: string | Buffer) => any): FSWatcher; - export function exists(path: string | Buffer, callback?: (exists: boolean) => void): void; - export function existsSync(path: string | Buffer): boolean; - - export namespace constants { - // File Access Constants - - /** Constant for fs.access(). File is visible to the calling process. */ - export const F_OK: number; - - /** Constant for fs.access(). File can be read by the calling process. */ - export const R_OK: number; - - /** Constant for fs.access(). File can be written by the calling process. */ - export const W_OK: number; - - /** Constant for fs.access(). File can be executed by the calling process. */ - export const X_OK: number; - - // File Open Constants - - /** Constant for fs.open(). Flag indicating to open a file for read-only access. */ - export const O_RDONLY: number; - - /** Constant for fs.open(). Flag indicating to open a file for write-only access. */ - export const O_WRONLY: number; - - /** Constant for fs.open(). Flag indicating to open a file for read-write access. */ - export const O_RDWR: number; - - /** Constant for fs.open(). Flag indicating to create the file if it does not already exist. */ - export const O_CREAT: number; - - /** Constant for fs.open(). Flag indicating that opening a file should fail if the O_CREAT flag is set and the file already exists. */ - export const O_EXCL: number; - - /** Constant for fs.open(). Flag indicating that if path identifies a terminal device, opening the path shall not cause that terminal to become the controlling terminal for the process (if the process does not already have one). */ - export const O_NOCTTY: number; - - /** Constant for fs.open(). Flag indicating that if the file exists and is a regular file, and the file is opened successfully for write access, its length shall be truncated to zero. */ - export const O_TRUNC: number; - - /** Constant for fs.open(). Flag indicating that data will be appended to the end of the file. */ - export const O_APPEND: number; - - /** Constant for fs.open(). Flag indicating that the open should fail if the path is not a directory. */ - export const O_DIRECTORY: number; - - /** Constant for fs.open(). Flag indicating reading accesses to the file system will no longer result in an update to the atime information associated with the file. This flag is available on Linux operating systems only. */ - export const O_NOATIME: number; - - /** Constant for fs.open(). Flag indicating that the open should fail if the path is a symbolic link. */ - export const O_NOFOLLOW: number; - - /** Constant for fs.open(). Flag indicating that the file is opened for synchronous I/O. */ - export const O_SYNC: number; - - /** Constant for fs.open(). Flag indicating to open the symbolic link itself rather than the resource it is pointing to. */ - export const O_SYMLINK: number; - - /** Constant for fs.open(). When set, an attempt will be made to minimize caching effects of file I/O. */ - export const O_DIRECT: number; - - /** Constant for fs.open(). Flag indicating to open the file in nonblocking mode when possible. */ - export const O_NONBLOCK: number; - - // File Type Constants - - /** Constant for fs.Stats mode property for determining a file's type. Bit mask used to extract the file type code. */ - export const S_IFMT: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a regular file. */ - export const S_IFREG: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a directory. */ - export const S_IFDIR: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a character-oriented device file. */ - export const S_IFCHR: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a block-oriented device file. */ - export const S_IFBLK: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a FIFO/pipe. */ - export const S_IFIFO: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a symbolic link. */ - export const S_IFLNK: number; - - /** Constant for fs.Stats mode property for determining a file's type. File type constant for a socket. */ - export const S_IFSOCK: number; - - // File Mode Constants - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by owner. */ - export const S_IRWXU: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by owner. */ - export const S_IRUSR: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by owner. */ - export const S_IWUSR: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by owner. */ - export const S_IXUSR: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by group. */ - export const S_IRWXG: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by group. */ - export const S_IRGRP: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by group. */ - export const S_IWGRP: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by group. */ - export const S_IXGRP: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable, writable and executable by others. */ - export const S_IRWXO: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating readable by others. */ - export const S_IROTH: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating writable by others. */ - export const S_IWOTH: number; - - /** Constant for fs.Stats mode property for determining access permissions for a file. File mode indicating executable by others. */ - export const S_IXOTH: number; - } - - /** Tests a user's permissions for the file specified by path. */ - export function access(path: string | Buffer, callback: (err: NodeJS.ErrnoException) => void): void; - export function access(path: string | Buffer, mode: number, callback: (err: NodeJS.ErrnoException) => void): void; - /** Synchronous version of fs.access. This throws if any accessibility checks fail, and does nothing otherwise. */ - export function accessSync(path: string | Buffer, mode?: number): void; - export function createReadStream(path: string | Buffer, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - autoClose?: boolean; - start?: number; - end?: number; - }): ReadStream; - export function createWriteStream(path: string | Buffer, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - autoClose?: boolean; - start?: number; - }): WriteStream; - export function fdatasync(fd: number, callback: Function): void; - export function fdatasyncSync(fd: number): void; -} - -declare module "path" { - - /** - * A parsed path object generated by path.parse() or consumed by path.format(). - */ - export interface ParsedPath { - /** - * The root of the path such as '/' or 'c:\' - */ - root: string; - /** - * The full directory path such as '/home/user/dir' or 'c:\path\dir' - */ - dir: string; - /** - * The file name including extension (if any) such as 'index.html' - */ - base: string; - /** - * The file extension (if any) such as '.html' - */ - ext: string; - /** - * The file name without extension (if any) such as 'index' - */ - name: string; - } - - /** - * Normalize a string path, reducing '..' and '.' parts. - * When multiple slashes are found, they're replaced by a single one; when the path contains a trailing slash, it is preserved. On Windows backslashes are used. - * - * @param p string path to normalize. - */ - export function normalize(p: string): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: any[]): string; - /** - * Join all arguments together and normalize the resulting path. - * Arguments must be strings. In v0.8, non-string arguments were silently ignored. In v0.10 and up, an exception is thrown. - * - * @param paths string paths to join. - */ - export function join(...paths: string[]): string; - /** - * The right-most parameter is considered {to}. Other parameters are considered an array of {from}. - * - * Starting from leftmost {from} paramter, resolves {to} to an absolute path. - * - * If {to} isn't already absolute, {from} arguments are prepended in right to left order, until an absolute path is found. If after using all {from} paths still no absolute path is found, the current working directory is used as well. The resulting path is normalized, and trailing slashes are removed unless the path gets resolved to the root directory. - * - * @param pathSegments string paths to join. Non-string arguments are ignored. - */ - export function resolve(...pathSegments: any[]): string; - /** - * Determines whether {path} is an absolute path. An absolute path will always resolve to the same location, regardless of the working directory. - * - * @param path path to test. - */ - export function isAbsolute(path: string): boolean; - /** - * Solve the relative path from {from} to {to}. - * At times we have two absolute paths, and we need to derive the relative path from one to the other. This is actually the reverse transform of path.resolve. - * - * @param from - * @param to - */ - export function relative(from: string, to: string): string; - /** - * Return the directory name of a path. Similar to the Unix dirname command. - * - * @param p the path to evaluate. - */ - export function dirname(p: string): string; - /** - * Return the last portion of a path. Similar to the Unix basename command. - * Often used to extract the file name from a fully qualified path. - * - * @param p the path to evaluate. - * @param ext optionally, an extension to remove from the result. - */ - export function basename(p: string, ext?: string): string; - /** - * Return the extension of the path, from the last '.' to end of string in the last portion of the path. - * If there is no '.' in the last portion of the path or the first character of it is '.', then it returns an empty string - * - * @param p the path to evaluate. - */ - export function extname(p: string): string; - /** - * The platform-specific file separator. '\\' or '/'. - */ - export var sep: string; - /** - * The platform-specific file delimiter. ';' or ':'. - */ - export var delimiter: string; - /** - * Returns an object from a path string - the opposite of format(). - * - * @param pathString path to evaluate. - */ - export function parse(pathString: string): ParsedPath; - /** - * Returns a path string from an object - the opposite of parse(). - * - * @param pathString path to evaluate. - */ - export function format(pathObject: ParsedPath): string; - - export module posix { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } - - export module win32 { - export function normalize(p: string): string; - export function join(...paths: any[]): string; - export function resolve(...pathSegments: any[]): string; - export function isAbsolute(p: string): boolean; - export function relative(from: string, to: string): string; - export function dirname(p: string): string; - export function basename(p: string, ext?: string): string; - export function extname(p: string): string; - export var sep: string; - export var delimiter: string; - export function parse(p: string): ParsedPath; - export function format(pP: ParsedPath): string; - } -} - -declare module "string_decoder" { - export interface NodeStringDecoder { - write(buffer: Buffer): string; - end(buffer?: Buffer): string; - } - export var StringDecoder: { - new (encoding?: string): NodeStringDecoder; - }; -} - -declare module "tls" { - import * as crypto from "crypto"; - import * as net from "net"; - import * as stream from "stream"; - - var CLIENT_RENEG_LIMIT: number; - var CLIENT_RENEG_WINDOW: number; - - export interface Certificate { - /** - * Country code. - */ - C: string; - /** - * Street. - */ - ST: string; - /** - * Locality. - */ - L: string; - /** - * Organization. - */ - O: string; - /** - * Organizational unit. - */ - OU: string; - /** - * Common name. - */ - CN: string; - } - - export interface CipherNameAndProtocol { - /** - * The cipher name. - */ - name: string; - /** - * SSL/TLS protocol version. - */ - version: string; - } - - export class TLSSocket extends stream.Duplex { - /** - * Construct a new tls.TLSSocket object from an existing TCP socket. - */ - constructor(socket:net.Socket, options?: { - /** - * An optional TLS context object from tls.createSecureContext() - */ - secureContext?: SecureContext, - /** - * If true the TLS socket will be instantiated in server-mode. - * Defaults to false. - */ - isServer?: boolean, - /** - * An optional net.Server instance. - */ - server?: net.Server, - /** - * If true the server will request a certificate from clients that - * connect and attempt to verify that certificate. Defaults to - * false. - */ - requestCert?: boolean, - /** - * If true the server will reject any connection which is not - * authorized with the list of supplied CAs. This option only has an - * effect if requestCert is true. Defaults to false. - */ - rejectUnauthorized?: boolean, - /** - * An array of strings or a Buffer naming possible NPN protocols. - * (Protocols should be ordered by their priority.) - */ - NPNProtocols?: string[] | Buffer, - /** - * An array of strings or a Buffer naming possible ALPN protocols. - * (Protocols should be ordered by their priority.) When the server - * receives both NPN and ALPN extensions from the client, ALPN takes - * precedence over NPN and the server does not send an NPN extension - * to the client. - */ - ALPNProtocols?: string[] | Buffer, - /** - * SNICallback(servername, cb) A function that will be - * called if the client supports SNI TLS extension. Two arguments - * will be passed when called: servername and cb. SNICallback should - * invoke cb(null, ctx), where ctx is a SecureContext instance. - * (tls.createSecureContext(...) can be used to get a proper - * SecureContext.) If SNICallback wasn't provided the default callback - * with high-level API will be used (see below). - */ - SNICallback?: Function, - /** - * An optional Buffer instance containing a TLS session. - */ - session?: Buffer, - /** - * If true, specifies that the OCSP status request extension will be - * added to the client hello and an 'OCSPResponse' event will be - * emitted on the socket before establishing a secure communication - */ - requestOCSP?: boolean - }); - /** - * Returns the bound address, the address family name and port of the underlying socket as reported by - * the operating system. - * @returns {any} - An object with three properties, e.g. { port: 12346, family: 'IPv4', address: '127.0.0.1' }. - */ - address(): { port: number; family: string; address: string }; - /** - * A boolean that is true if the peer certificate was signed by one of the specified CAs, otherwise false. - */ - authorized: boolean; - /** - * The reason why the peer's certificate has not been verified. - * This property becomes available only when tlsSocket.authorized === false. - */ - authorizationError: Error; - /** - * Static boolean value, always true. - * May be used to distinguish TLS sockets from regular ones. - */ - encrypted: boolean; - /** - * Returns an object representing the cipher name and the SSL/TLS protocol version of the current connection. - * @returns {CipherNameAndProtocol} - Returns an object representing the cipher name - * and the SSL/TLS protocol version of the current connection. - */ - getCipher(): CipherNameAndProtocol; - /** - * Returns an object representing the peer's certificate. - * The returned object has some properties corresponding to the field of the certificate. - * If detailed argument is true the full chain with issuer property will be returned, - * if false only the top certificate without issuer property. - * If the peer does not provide a certificate, it returns null or an empty object. - * @param {boolean} detailed - If true; the full chain with issuer property will be returned. - * @returns {any} - An object representing the peer's certificate. - */ - getPeerCertificate(detailed?: boolean): { - subject: Certificate; - issuerInfo: Certificate; - issuer: Certificate; - raw: any; - valid_from: string; - valid_to: string; - fingerprint: string; - serialNumber: string; - }; - /** - * Could be used to speed up handshake establishment when reconnecting to the server. - * @returns {any} - ASN.1 encoded TLS session or undefined if none was negotiated. - */ - getSession(): any; - /** - * NOTE: Works only with client TLS sockets. - * Useful only for debugging, for session reuse provide session option to tls.connect(). - * @returns {any} - TLS session ticket or undefined if none was negotiated. - */ - getTLSTicket(): any; - /** - * The string representation of the local IP address. - */ - localAddress: string; - /** - * The numeric representation of the local port. - */ - localPort: string; - /** - * The string representation of the remote IP address. - * For example, '74.125.127.100' or '2001:4860:a005::68'. - */ - remoteAddress: string; - /** - * The string representation of the remote IP family. 'IPv4' or 'IPv6'. - */ - remoteFamily: string; - /** - * The numeric representation of the remote port. For example, 443. - */ - remotePort: number; - /** - * Initiate TLS renegotiation process. - * - * NOTE: Can be used to request peer's certificate after the secure connection has been established. - * ANOTHER NOTE: When running as the server, socket will be destroyed with an error after handshakeTimeout timeout. - * @param {TlsOptions} options - The options may contain the following fields: rejectUnauthorized, - * requestCert (See tls.createServer() for details). - * @param {Function} callback - callback(err) will be executed with null as err, once the renegotiation - * is successfully completed. - */ - renegotiate(options: TlsOptions, callback: (err: Error) => any): any; - /** - * Set maximum TLS fragment size (default and maximum value is: 16384, minimum is: 512). - * Smaller fragment size decreases buffering latency on the client: large fragments are buffered by - * the TLS layer until the entire fragment is received and its integrity is verified; - * large fragments can span multiple roundtrips, and their processing can be delayed due to packet - * loss or reordering. However, smaller fragments add extra TLS framing bytes and CPU overhead, - * which may decrease overall server throughput. - * @param {number} size - TLS fragment size (default and maximum value is: 16384, minimum is: 512). - * @returns {boolean} - Returns true on success, false otherwise. - */ - setMaxSendFragment(size: number): boolean; - - /** - * events.EventEmitter - * 1. OCSPResponse - * 2. secureConnect - **/ - addListener(event: string, listener: Function): this; - addListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; - addListener(event: "secureConnect", listener: () => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "OCSPResponse", response: Buffer): boolean; - emit(event: "secureConnect"): boolean; - - on(event: string, listener: Function): this; - on(event: "OCSPResponse", listener: (response: Buffer) => void): this; - on(event: "secureConnect", listener: () => void): this; - - once(event: string, listener: Function): this; - once(event: "OCSPResponse", listener: (response: Buffer) => void): this; - once(event: "secureConnect", listener: () => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; - prependListener(event: "secureConnect", listener: () => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "OCSPResponse", listener: (response: Buffer) => void): this; - prependOnceListener(event: "secureConnect", listener: () => void): this; - } - - export interface TlsOptions { - host?: string; - port?: number; - pfx?: string | Buffer[]; - key?: string | string[] | Buffer | any[]; - passphrase?: string; - cert?: string | string[] | Buffer | Buffer[]; - ca?: string | string[] | Buffer | Buffer[]; - crl?: string | string[]; - ciphers?: string; - honorCipherOrder?: boolean; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: string[] | Buffer; - SNICallback?: (servername: string, cb: (err: Error, ctx: SecureContext) => any) => any; - ecdhCurve?: string; - dhparam?: string | Buffer; - handshakeTimeout?: number; - ALPNProtocols?: string[] | Buffer; - sessionTimeout?: number; - ticketKeys?: any; - sessionIdContext?: string; - secureProtocol?: string; - } - - export interface ConnectionOptions { - host?: string; - port?: number; - socket?: net.Socket; - pfx?: string | Buffer - key?: string | string[] | Buffer | Buffer[]; - passphrase?: string; - cert?: string | string[] | Buffer | Buffer[]; - ca?: string | Buffer | (string | Buffer)[]; - rejectUnauthorized?: boolean; - NPNProtocols?: (string | Buffer)[]; - servername?: string; - path?: string; - ALPNProtocols?: (string | Buffer)[]; - checkServerIdentity?: (servername: string, cert: string | Buffer | (string | Buffer)[]) => any; - secureProtocol?: string; - secureContext?: Object; - session?: Buffer; - minDHSize?: number; - } - - export interface Server extends net.Server { - close(): Server; - address(): { port: number; family: string; address: string; }; - addContext(hostName: string, credentials: { - key: string; - cert: string; - ca: string; - }): void; - maxConnections: number; - connections: number; - - /** - * events.EventEmitter - * 1. tlsClientError - * 2. newSession - * 3. OCSPRequest - * 4. resumeSession - * 5. secureConnection - **/ - addListener(event: string, listener: Function): this; - addListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; - addListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this; - addListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this; - addListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this; - addListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "tlsClientError", err: Error, tlsSocket: TLSSocket): boolean; - emit(event: "newSession", sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void): boolean; - emit(event: "OCSPRequest", certificate: Buffer, issuer: Buffer, callback: Function): boolean; - emit(event: "resumeSession", sessionId: any, callback: (err: Error, sessionData: any) => void): boolean; - emit(event: "secureConnection", tlsSocket: TLSSocket): boolean; - - on(event: string, listener: Function): this; - on(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; - on(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this; - on(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this; - on(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this; - on(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; - - once(event: string, listener: Function): this; - once(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; - once(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this; - once(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this; - once(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this; - once(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; - prependListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this; - prependListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this; - prependListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this; - prependListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "tlsClientError", listener: (err: Error, tlsSocket: TLSSocket) => void): this; - prependOnceListener(event: "newSession", listener: (sessionId: any, sessionData: any, callback: (err: Error, resp: Buffer) => void) => void): this; - prependOnceListener(event: "OCSPRequest", listener: (certificate: Buffer, issuer: Buffer, callback: Function) => void): this; - prependOnceListener(event: "resumeSession", listener: (sessionId: any, callback: (err: Error, sessionData: any) => void) => void): this; - prependOnceListener(event: "secureConnection", listener: (tlsSocket: TLSSocket) => void): this; - } - - export interface ClearTextStream extends stream.Duplex { - authorized: boolean; - authorizationError: Error; - getPeerCertificate(): any; - getCipher: { - name: string; - version: string; - }; - address: { - port: number; - family: string; - address: string; - }; - remoteAddress: string; - remotePort: number; - } - - export interface SecurePair { - encrypted: any; - cleartext: any; - } - - export interface SecureContextOptions { - pfx?: string | Buffer; - key?: string | Buffer; - passphrase?: string; - cert?: string | Buffer; - ca?: string | Buffer; - crl?: string | string[] - ciphers?: string; - honorCipherOrder?: boolean; - } - - export interface SecureContext { - context: any; - } - - export function createServer(options: TlsOptions, secureConnectionListener?: (cleartextStream: ClearTextStream) => void): Server; - export function connect(options: ConnectionOptions, secureConnectionListener?: () => void): ClearTextStream; - export function connect(port: number, host?: string, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; - export function connect(port: number, options?: ConnectionOptions, secureConnectListener?: () => void): ClearTextStream; - export function createSecurePair(credentials?: crypto.Credentials, isServer?: boolean, requestCert?: boolean, rejectUnauthorized?: boolean): SecurePair; - export function createSecureContext(details: SecureContextOptions): SecureContext; -} - -declare module "crypto" { - export interface Certificate { - exportChallenge(spkac: string | Buffer): Buffer; - exportPublicKey(spkac: string | Buffer): Buffer; - verifySpkac(spkac: Buffer): boolean; - } - export var Certificate: { - new (): Certificate; - (): Certificate; - } - - export var fips: boolean; - - export interface CredentialDetails { - pfx: string; - key: string; - passphrase: string; - cert: string; - ca: string | string[]; - crl: string | string[]; - ciphers: string; - } - export interface Credentials { context?: any; } - export function createCredentials(details: CredentialDetails): Credentials; - export function createHash(algorithm: string): Hash; - export function createHmac(algorithm: string, key: string | Buffer): Hmac; - - type Utf8AsciiLatin1Encoding = "utf8" | "ascii" | "latin1"; - type HexBase64Latin1Encoding = "latin1" | "hex" | "base64"; - type Utf8AsciiBinaryEncoding = "utf8" | "ascii" | "binary"; - type HexBase64BinaryEncoding = "binary" | "base64" | "hex"; - type ECDHKeyFormat = "compressed" | "uncompressed" | "hybrid"; - - export interface Hash extends NodeJS.ReadWriteStream { - update(data: string | Buffer): Hash; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hash; - digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; - } - export interface Hmac extends NodeJS.ReadWriteStream { - update(data: string | Buffer): Hmac; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Hmac; - digest(): Buffer; - digest(encoding: HexBase64Latin1Encoding): string; - } - export function createCipher(algorithm: string, password: any): Cipher; - export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; - export interface Cipher extends NodeJS.ReadWriteStream { - update(data: Buffer): Buffer; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding): Buffer; - update(data: Buffer, input_encoding: any, output_encoding: HexBase64BinaryEncoding): string; - update(data: string, input_encoding: Utf8AsciiBinaryEncoding, output_encoding: HexBase64BinaryEncoding): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding?: boolean): void; - getAuthTag(): Buffer; - setAAD(buffer: Buffer): void; - } - export function createDecipher(algorithm: string, password: any): Decipher; - export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; - export interface Decipher extends NodeJS.ReadWriteStream { - update(data: Buffer): Buffer; - update(data: string, input_encoding: HexBase64BinaryEncoding): Buffer; - update(data: Buffer, input_encoding: any, output_encoding: Utf8AsciiBinaryEncoding): string; - update(data: string, input_encoding: HexBase64BinaryEncoding, output_encoding: Utf8AsciiBinaryEncoding): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding?: boolean): void; - setAuthTag(tag: Buffer): void; - setAAD(buffer: Buffer): void; - } - export function createSign(algorithm: string): Signer; - export interface Signer extends NodeJS.WritableStream { - update(data: string | Buffer): Signer; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Signer; - sign(private_key: string | { key: string; passphrase: string }): Buffer; - sign(private_key: string | { key: string; passphrase: string }, output_format: HexBase64Latin1Encoding): string; - } - export function createVerify(algorith: string): Verify; - export interface Verify extends NodeJS.WritableStream { - update(data: string | Buffer): Verify; - update(data: string | Buffer, input_encoding: Utf8AsciiLatin1Encoding): Verify; - verify(object: string, signature: Buffer): boolean; - verify(object: string, signature: string, signature_format: HexBase64Latin1Encoding): boolean; - } - export function createDiffieHellman(prime_length: number, generator?: number): DiffieHellman; - export function createDiffieHellman(prime: Buffer): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: number | Buffer): DiffieHellman; - export function createDiffieHellman(prime: string, prime_encoding: HexBase64Latin1Encoding, generator: string, generator_encoding: HexBase64Latin1Encoding): DiffieHellman; - export interface DiffieHellman { - generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding): string; - computeSecret(other_public_key: Buffer): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; - getPrime(): Buffer; - getPrime(encoding: HexBase64Latin1Encoding): string; - getGenerator(): Buffer; - getGenerator(encoding: HexBase64Latin1Encoding): string; - getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding): string; - getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; - setPublicKey(public_key: Buffer): void; - setPublicKey(public_key: string, encoding: string): void; - setPrivateKey(private_key: Buffer): void; - setPrivateKey(private_key: string, encoding: string): void; - verifyError: number; - } - export function getDiffieHellman(group_name: string): DiffieHellman; - export function pbkdf2(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2Sync(password: string | Buffer, salt: string | Buffer, iterations: number, keylen: number, digest: string): Buffer; - export function randomBytes(size: number): Buffer; - export function randomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; - export function pseudoRandomBytes(size: number): Buffer; - export function pseudoRandomBytes(size: number, callback: (err: Error, buf: Buffer) => void): void; - export interface RsaPublicKey { - key: string; - padding?: number; - } - export interface RsaPrivateKey { - key: string; - passphrase?: string, - padding?: number; - } - export function publicEncrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer - export function privateDecrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer - export function privateEncrypt(private_key: string | RsaPrivateKey, buffer: Buffer): Buffer - export function publicDecrypt(public_key: string | RsaPublicKey, buffer: Buffer): Buffer - export function getCiphers(): string[]; - export function getCurves(): string[]; - export function getHashes(): string[]; - export interface ECDH { - generateKeys(): Buffer; - generateKeys(encoding: HexBase64Latin1Encoding): string; - generateKeys(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; - computeSecret(other_public_key: Buffer): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding): Buffer; - computeSecret(other_public_key: string, input_encoding: HexBase64Latin1Encoding, output_encoding: HexBase64Latin1Encoding): string; - getPrivateKey(): Buffer; - getPrivateKey(encoding: HexBase64Latin1Encoding): string; - getPublicKey(): Buffer; - getPublicKey(encoding: HexBase64Latin1Encoding): string; - getPublicKey(encoding: HexBase64Latin1Encoding, format: ECDHKeyFormat): string; - setPrivateKey(private_key: Buffer): void; - setPrivateKey(private_key: string, encoding: HexBase64Latin1Encoding): void; - } - export function createECDH(curve_name: string): ECDH; - export function timingSafeEqual(a: Buffer, b: Buffer): boolean; - export var DEFAULT_ENCODING: string; -} - -declare module "stream" { - import * as events from "events"; - - class internal extends events.EventEmitter { - pipe(destination: T, options?: { end?: boolean; }): T; - } - namespace internal { - - export class Stream extends internal { } - - export interface ReadableOptions { - highWaterMark?: number; - encoding?: string; - objectMode?: boolean; - read?: (size?: number) => any; - } - - export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { - readable: boolean; - constructor(opts?: ReadableOptions); - protected _read(size: number): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): Readable; - resume(): Readable; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: any): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - - /** - * Event emitter - * The defined events on documents including: - * 1. close - * 2. data - * 3. end - * 4. readable - * 5. error - **/ - addListener(event: string, listener: Function): this; - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "data", listener: (chunk: Buffer | string) => void): this; - addListener(event: "end", listener: () => void): this; - addListener(event: "readable", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "data", chunk: Buffer | string): boolean; - emit(event: "end"): boolean; - emit(event: "readable"): boolean; - emit(event: "error", err: Error): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "data", listener: (chunk: Buffer | string) => void): this; - on(event: "end", listener: () => void): this; - on(event: "readable", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "data", listener: (chunk: Buffer | string) => void): this; - once(event: "end", listener: () => void): this; - once(event: "readable", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "data", listener: (chunk: Buffer | string) => void): this; - prependListener(event: "end", listener: () => void): this; - prependListener(event: "readable", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "data", listener: (chunk: Buffer | string) => void): this; - prependOnceListener(event: "end", listener: () => void): this; - prependOnceListener(event: "readable", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - - removeListener(event: string, listener: Function): this; - removeListener(event: "close", listener: () => void): this; - removeListener(event: "data", listener: (chunk: Buffer | string) => void): this; - removeListener(event: "end", listener: () => void): this; - removeListener(event: "readable", listener: () => void): this; - removeListener(event: "error", listener: (err: Error) => void): this; - } - - export interface WritableOptions { - highWaterMark?: number; - decodeStrings?: boolean; - objectMode?: boolean; - write?: (chunk: string | Buffer, encoding: string, callback: Function) => any; - writev?: (chunks: { chunk: string | Buffer, encoding: string }[], callback: Function) => any; - } - - export class Writable extends events.EventEmitter implements NodeJS.WritableStream { - writable: boolean; - constructor(opts?: WritableOptions); - protected _write(chunk: any, encoding: string, callback: Function): void; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - - /** - * Event emitter - * The defined events on documents including: - * 1. close - * 2. drain - * 3. error - * 4. finish - * 5. pipe - * 6. unpipe - **/ - addListener(event: string, listener: Function): this; - addListener(event: "close", listener: () => void): this; - addListener(event: "drain", listener: () => void): this; - addListener(event: "error", listener: (err: Error) => void): this; - addListener(event: "finish", listener: () => void): this; - addListener(event: "pipe", listener: (src: Readable) => void): this; - addListener(event: "unpipe", listener: (src: Readable) => void): this; - - emit(event: string, ...args: any[]): boolean; - emit(event: "close"): boolean; - emit(event: "drain", chunk: Buffer | string): boolean; - emit(event: "error", err: Error): boolean; - emit(event: "finish"): boolean; - emit(event: "pipe", src: Readable): boolean; - emit(event: "unpipe", src: Readable): boolean; - - on(event: string, listener: Function): this; - on(event: "close", listener: () => void): this; - on(event: "drain", listener: () => void): this; - on(event: "error", listener: (err: Error) => void): this; - on(event: "finish", listener: () => void): this; - on(event: "pipe", listener: (src: Readable) => void): this; - on(event: "unpipe", listener: (src: Readable) => void): this; - - once(event: string, listener: Function): this; - once(event: "close", listener: () => void): this; - once(event: "drain", listener: () => void): this; - once(event: "error", listener: (err: Error) => void): this; - once(event: "finish", listener: () => void): this; - once(event: "pipe", listener: (src: Readable) => void): this; - once(event: "unpipe", listener: (src: Readable) => void): this; - - prependListener(event: string, listener: Function): this; - prependListener(event: "close", listener: () => void): this; - prependListener(event: "drain", listener: () => void): this; - prependListener(event: "error", listener: (err: Error) => void): this; - prependListener(event: "finish", listener: () => void): this; - prependListener(event: "pipe", listener: (src: Readable) => void): this; - prependListener(event: "unpipe", listener: (src: Readable) => void): this; - - prependOnceListener(event: string, listener: Function): this; - prependOnceListener(event: "close", listener: () => void): this; - prependOnceListener(event: "drain", listener: () => void): this; - prependOnceListener(event: "error", listener: (err: Error) => void): this; - prependOnceListener(event: "finish", listener: () => void): this; - prependOnceListener(event: "pipe", listener: (src: Readable) => void): this; - prependOnceListener(event: "unpipe", listener: (src: Readable) => void): this; - - removeListener(event: string, listener: Function): this; - removeListener(event: "close", listener: () => void): this; - removeListener(event: "drain", listener: () => void): this; - removeListener(event: "error", listener: (err: Error) => void): this; - removeListener(event: "finish", listener: () => void): this; - removeListener(event: "pipe", listener: (src: Readable) => void): this; - removeListener(event: "unpipe", listener: (src: Readable) => void): this; - } - - export interface DuplexOptions extends ReadableOptions, WritableOptions { - allowHalfOpen?: boolean; - readableObjectMode?: boolean; - writableObjectMode?: boolean; - } - - // Note: Duplex extends both Readable and Writable. - export class Duplex extends Readable implements NodeJS.ReadWriteStream { - // Readable - pause(): Duplex; - resume(): Duplex; - // Writeable - writable: boolean; - constructor(opts?: DuplexOptions); - protected _write(chunk: any, encoding: string, callback: Function): void; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - } - - export interface TransformOptions extends DuplexOptions { - transform?: (chunk: string | Buffer, encoding: string, callback: Function) => any; - flush?: (callback: Function) => any; - } - - // Note: Transform lacks the _read and _write methods of Readable/Writable. - export class Transform extends events.EventEmitter implements NodeJS.ReadWriteStream { - readable: boolean; - writable: boolean; - constructor(opts?: TransformOptions); - protected _transform(chunk: any, encoding: string, callback: Function): void; - protected _flush(callback: Function): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): Transform; - resume(): Transform; - pipe(destination: T, options?: { end?: boolean; }): T; - unpipe(destination?: T): void; - unshift(chunk: any): void; - wrap(oldStream: NodeJS.ReadableStream): NodeJS.ReadableStream; - push(chunk: any, encoding?: string): boolean; - write(chunk: any, cb?: Function): boolean; - write(chunk: any, encoding?: string, cb?: Function): boolean; - end(): void; - end(chunk: any, cb?: Function): void; - end(chunk: any, encoding?: string, cb?: Function): void; - } - - export class PassThrough extends Transform { } - } - - export = internal; -} - -declare module "util" { - export interface InspectOptions { - showHidden?: boolean; - depth?: number; - colors?: boolean; - customInspect?: boolean; - } - - export function format(format: any, ...param: any[]): string; - export function debug(string: string): void; - export function error(...param: any[]): void; - export function puts(...param: any[]): void; - export function print(...param: any[]): void; - export function log(string: string): void; - export function inspect(object: any, showHidden?: boolean, depth?: number, color?: boolean): string; - export function inspect(object: any, options: InspectOptions): string; - export function isArray(object: any): boolean; - export function isRegExp(object: any): boolean; - export function isDate(object: any): boolean; - export function isError(object: any): boolean; - export function inherits(constructor: any, superConstructor: any): void; - export function debuglog(key: string): (msg: string, ...param: any[]) => void; - export function isBoolean(object: any): boolean; - export function isBuffer(object: any): boolean; - export function isFunction(object: any): boolean; - export function isNull(object: any): boolean; - export function isNullOrUndefined(object: any): boolean; - export function isNumber(object: any): boolean; - export function isObject(object: any): boolean; - export function isPrimitive(object: any): boolean; - export function isString(object: any): boolean; - export function isSymbol(object: any): boolean; - export function isUndefined(object: any): boolean; - export function deprecate(fn: Function, message: string): Function; -} - -declare module "assert" { - function internal(value: any, message?: string): void; - namespace internal { - export class AssertionError implements Error { - name: string; - message: string; - actual: any; - expected: any; - operator: string; - generatedMessage: boolean; - - constructor(options?: { - message?: string; actual?: any; expected?: any; - operator?: string; stackStartFunction?: Function - }); - } - - export function fail(actual: any, expected: any, message: string, operator: string): void; - export function ok(value: any, message?: string): void; - export function equal(actual: any, expected: any, message?: string): void; - export function notEqual(actual: any, expected: any, message?: string): void; - export function deepEqual(actual: any, expected: any, message?: string): void; - export function notDeepEqual(acutal: any, expected: any, message?: string): void; - export function strictEqual(actual: any, expected: any, message?: string): void; - export function notStrictEqual(actual: any, expected: any, message?: string): void; - export function deepStrictEqual(actual: any, expected: any, message?: string): void; - export function notDeepStrictEqual(actual: any, expected: any, message?: string): void; - export var throws: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export var doesNotThrow: { - (block: Function, message?: string): void; - (block: Function, error: Function, message?: string): void; - (block: Function, error: RegExp, message?: string): void; - (block: Function, error: (err: any) => boolean, message?: string): void; - }; - - export function ifError(value: any): void; - } - - export = internal; -} - -declare module "tty" { - import * as net from "net"; - - export function isatty(fd: number): boolean; - export interface ReadStream extends net.Socket { - isRaw: boolean; - setRawMode(mode: boolean): void; - isTTY: boolean; - } - export interface WriteStream extends net.Socket { - columns: number; - rows: number; - isTTY: boolean; - } -} - -declare module "domain" { - import * as events from "events"; - - export class Domain extends events.EventEmitter implements NodeJS.Domain { - run(fn: Function): void; - add(emitter: events.EventEmitter): void; - remove(emitter: events.EventEmitter): void; - bind(cb: (err: Error, data: any) => any): any; - intercept(cb: (data: any) => any): any; - dispose(): void; - members: any[]; - enter(): void; - exit(): void; - } - - export function create(): Domain; -} - -declare module "constants" { - export var E2BIG: number; - export var EACCES: number; - export var EADDRINUSE: number; - export var EADDRNOTAVAIL: number; - export var EAFNOSUPPORT: number; - export var EAGAIN: number; - export var EALREADY: number; - export var EBADF: number; - export var EBADMSG: number; - export var EBUSY: number; - export var ECANCELED: number; - export var ECHILD: number; - export var ECONNABORTED: number; - export var ECONNREFUSED: number; - export var ECONNRESET: number; - export var EDEADLK: number; - export var EDESTADDRREQ: number; - export var EDOM: number; - export var EEXIST: number; - export var EFAULT: number; - export var EFBIG: number; - export var EHOSTUNREACH: number; - export var EIDRM: number; - export var EILSEQ: number; - export var EINPROGRESS: number; - export var EINTR: number; - export var EINVAL: number; - export var EIO: number; - export var EISCONN: number; - export var EISDIR: number; - export var ELOOP: number; - export var EMFILE: number; - export var EMLINK: number; - export var EMSGSIZE: number; - export var ENAMETOOLONG: number; - export var ENETDOWN: number; - export var ENETRESET: number; - export var ENETUNREACH: number; - export var ENFILE: number; - export var ENOBUFS: number; - export var ENODATA: number; - export var ENODEV: number; - export var ENOENT: number; - export var ENOEXEC: number; - export var ENOLCK: number; - export var ENOLINK: number; - export var ENOMEM: number; - export var ENOMSG: number; - export var ENOPROTOOPT: number; - export var ENOSPC: number; - export var ENOSR: number; - export var ENOSTR: number; - export var ENOSYS: number; - export var ENOTCONN: number; - export var ENOTDIR: number; - export var ENOTEMPTY: number; - export var ENOTSOCK: number; - export var ENOTSUP: number; - export var ENOTTY: number; - export var ENXIO: number; - export var EOPNOTSUPP: number; - export var EOVERFLOW: number; - export var EPERM: number; - export var EPIPE: number; - export var EPROTO: number; - export var EPROTONOSUPPORT: number; - export var EPROTOTYPE: number; - export var ERANGE: number; - export var EROFS: number; - export var ESPIPE: number; - export var ESRCH: number; - export var ETIME: number; - export var ETIMEDOUT: number; - export var ETXTBSY: number; - export var EWOULDBLOCK: number; - export var EXDEV: number; - export var WSAEINTR: number; - export var WSAEBADF: number; - export var WSAEACCES: number; - export var WSAEFAULT: number; - export var WSAEINVAL: number; - export var WSAEMFILE: number; - export var WSAEWOULDBLOCK: number; - export var WSAEINPROGRESS: number; - export var WSAEALREADY: number; - export var WSAENOTSOCK: number; - export var WSAEDESTADDRREQ: number; - export var WSAEMSGSIZE: number; - export var WSAEPROTOTYPE: number; - export var WSAENOPROTOOPT: number; - export var WSAEPROTONOSUPPORT: number; - export var WSAESOCKTNOSUPPORT: number; - export var WSAEOPNOTSUPP: number; - export var WSAEPFNOSUPPORT: number; - export var WSAEAFNOSUPPORT: number; - export var WSAEADDRINUSE: number; - export var WSAEADDRNOTAVAIL: number; - export var WSAENETDOWN: number; - export var WSAENETUNREACH: number; - export var WSAENETRESET: number; - export var WSAECONNABORTED: number; - export var WSAECONNRESET: number; - export var WSAENOBUFS: number; - export var WSAEISCONN: number; - export var WSAENOTCONN: number; - export var WSAESHUTDOWN: number; - export var WSAETOOMANYREFS: number; - export var WSAETIMEDOUT: number; - export var WSAECONNREFUSED: number; - export var WSAELOOP: number; - export var WSAENAMETOOLONG: number; - export var WSAEHOSTDOWN: number; - export var WSAEHOSTUNREACH: number; - export var WSAENOTEMPTY: number; - export var WSAEPROCLIM: number; - export var WSAEUSERS: number; - export var WSAEDQUOT: number; - export var WSAESTALE: number; - export var WSAEREMOTE: number; - export var WSASYSNOTREADY: number; - export var WSAVERNOTSUPPORTED: number; - export var WSANOTINITIALISED: number; - export var WSAEDISCON: number; - export var WSAENOMORE: number; - export var WSAECANCELLED: number; - export var WSAEINVALIDPROCTABLE: number; - export var WSAEINVALIDPROVIDER: number; - export var WSAEPROVIDERFAILEDINIT: number; - export var WSASYSCALLFAILURE: number; - export var WSASERVICE_NOT_FOUND: number; - export var WSATYPE_NOT_FOUND: number; - export var WSA_E_NO_MORE: number; - export var WSA_E_CANCELLED: number; - export var WSAEREFUSED: number; - export var SIGHUP: number; - export var SIGINT: number; - export var SIGILL: number; - export var SIGABRT: number; - export var SIGFPE: number; - export var SIGKILL: number; - export var SIGSEGV: number; - export var SIGTERM: number; - export var SIGBREAK: number; - export var SIGWINCH: number; - export var SSL_OP_ALL: number; - export var SSL_OP_ALLOW_UNSAFE_LEGACY_RENEGOTIATION: number; - export var SSL_OP_CIPHER_SERVER_PREFERENCE: number; - export var SSL_OP_CISCO_ANYCONNECT: number; - export var SSL_OP_COOKIE_EXCHANGE: number; - export var SSL_OP_CRYPTOPRO_TLSEXT_BUG: number; - export var SSL_OP_DONT_INSERT_EMPTY_FRAGMENTS: number; - export var SSL_OP_EPHEMERAL_RSA: number; - export var SSL_OP_LEGACY_SERVER_CONNECT: number; - export var SSL_OP_MICROSOFT_BIG_SSLV3_BUFFER: number; - export var SSL_OP_MICROSOFT_SESS_ID_BUG: number; - export var SSL_OP_MSIE_SSLV2_RSA_PADDING: number; - export var SSL_OP_NETSCAPE_CA_DN_BUG: number; - export var SSL_OP_NETSCAPE_CHALLENGE_BUG: number; - export var SSL_OP_NETSCAPE_DEMO_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NETSCAPE_REUSE_CIPHER_CHANGE_BUG: number; - export var SSL_OP_NO_COMPRESSION: number; - export var SSL_OP_NO_QUERY_MTU: number; - export var SSL_OP_NO_SESSION_RESUMPTION_ON_RENEGOTIATION: number; - export var SSL_OP_NO_SSLv2: number; - export var SSL_OP_NO_SSLv3: number; - export var SSL_OP_NO_TICKET: number; - export var SSL_OP_NO_TLSv1: number; - export var SSL_OP_NO_TLSv1_1: number; - export var SSL_OP_NO_TLSv1_2: number; - export var SSL_OP_PKCS1_CHECK_1: number; - export var SSL_OP_PKCS1_CHECK_2: number; - export var SSL_OP_SINGLE_DH_USE: number; - export var SSL_OP_SINGLE_ECDH_USE: number; - export var SSL_OP_SSLEAY_080_CLIENT_DH_BUG: number; - export var SSL_OP_SSLREF2_REUSE_CERT_TYPE_BUG: number; - export var SSL_OP_TLS_BLOCK_PADDING_BUG: number; - export var SSL_OP_TLS_D5_BUG: number; - export var SSL_OP_TLS_ROLLBACK_BUG: number; - export var ENGINE_METHOD_DSA: number; - export var ENGINE_METHOD_DH: number; - export var ENGINE_METHOD_RAND: number; - export var ENGINE_METHOD_ECDH: number; - export var ENGINE_METHOD_ECDSA: number; - export var ENGINE_METHOD_CIPHERS: number; - export var ENGINE_METHOD_DIGESTS: number; - export var ENGINE_METHOD_STORE: number; - export var ENGINE_METHOD_PKEY_METHS: number; - export var ENGINE_METHOD_PKEY_ASN1_METHS: number; - export var ENGINE_METHOD_ALL: number; - export var ENGINE_METHOD_NONE: number; - export var DH_CHECK_P_NOT_SAFE_PRIME: number; - export var DH_CHECK_P_NOT_PRIME: number; - export var DH_UNABLE_TO_CHECK_GENERATOR: number; - export var DH_NOT_SUITABLE_GENERATOR: number; - export var NPN_ENABLED: number; - export var RSA_PKCS1_PADDING: number; - export var RSA_SSLV23_PADDING: number; - export var RSA_NO_PADDING: number; - export var RSA_PKCS1_OAEP_PADDING: number; - export var RSA_X931_PADDING: number; - export var RSA_PKCS1_PSS_PADDING: number; - export var POINT_CONVERSION_COMPRESSED: number; - export var POINT_CONVERSION_UNCOMPRESSED: number; - export var POINT_CONVERSION_HYBRID: number; - export var O_RDONLY: number; - export var O_WRONLY: number; - export var O_RDWR: number; - export var S_IFMT: number; - export var S_IFREG: number; - export var S_IFDIR: number; - export var S_IFCHR: number; - export var S_IFBLK: number; - export var S_IFIFO: number; - export var S_IFSOCK: number; - export var S_IRWXU: number; - export var S_IRUSR: number; - export var S_IWUSR: number; - export var S_IXUSR: number; - export var S_IRWXG: number; - export var S_IRGRP: number; - export var S_IWGRP: number; - export var S_IXGRP: number; - export var S_IRWXO: number; - export var S_IROTH: number; - export var S_IWOTH: number; - export var S_IXOTH: number; - export var S_IFLNK: number; - export var O_CREAT: number; - export var O_EXCL: number; - export var O_NOCTTY: number; - export var O_DIRECTORY: number; - export var O_NOATIME: number; - export var O_NOFOLLOW: number; - export var O_SYNC: number; - export var O_SYMLINK: number; - export var O_DIRECT: number; - export var O_NONBLOCK: number; - export var O_TRUNC: number; - export var O_APPEND: number; - export var F_OK: number; - export var R_OK: number; - export var W_OK: number; - export var X_OK: number; - export var UV_UDP_REUSEADDR: number; - export var SIGQUIT: number; - export var SIGTRAP: number; - export var SIGIOT: number; - export var SIGBUS: number; - export var SIGUSR1: number; - export var SIGUSR2: number; - export var SIGPIPE: number; - export var SIGALRM: number; - export var SIGCHLD: number; - export var SIGSTKFLT: number; - export var SIGCONT: number; - export var SIGSTOP: number; - export var SIGTSTP: number; - export var SIGTTIN: number; - export var SIGTTOU: number; - export var SIGURG: number; - export var SIGXCPU: number; - export var SIGXFSZ: number; - export var SIGVTALRM: number; - export var SIGPROF: number; - export var SIGIO: number; - export var SIGPOLL: number; - export var SIGPWR: number; - export var SIGSYS: number; - export var SIGUNUSED: number; - export var defaultCoreCipherList: string; - export var defaultCipherList: string; - export var ENGINE_METHOD_RSA: number; - export var ALPN_ENABLED: number; -} - -declare module "process" { - export = process; -} - -declare module "v8" { - interface HeapSpaceInfo { - space_name: string; - space_size: number; - space_used_size: number; - space_available_size: number; - physical_space_size: number; - } - export function getHeapStatistics(): { total_heap_size: number, total_heap_size_executable: number, total_physical_size: number, total_avaialble_size: number, used_heap_size: number, heap_size_limit: number }; - export function getHeapSpaceStatistics(): HeapSpaceInfo[]; - export function setFlagsFromString(flags: string): void; -} - -declare module "timers" { - export function setTimeout(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; - export function clearTimeout(timeoutId: NodeJS.Timer): void; - export function setInterval(callback: (...args: any[]) => void, ms: number, ...args: any[]): NodeJS.Timer; - export function clearInterval(intervalId: NodeJS.Timer): void; - export function setImmediate(callback: (...args: any[]) => void, ...args: any[]): any; - export function clearImmediate(immediateId: any): void; -} - -declare module "console" { - export = console; -} diff --git a/typings/globals/node/typings.json b/typings/globals/node/typings.json deleted file mode 100644 index 2dc6c29..0000000 --- a/typings/globals/node/typings.json +++ /dev/null @@ -1,8 +0,0 @@ -{ - "resolution": "main", - "tree": { - "src": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/988a48ab2cfff3243868d70d836332a118d9f060/node/node.d.ts", - "raw": "registry:dt/node#6.0.0+20161019125345", - "typings": "https://raw.githubusercontent.com/DefinitelyTyped/DefinitelyTyped/988a48ab2cfff3243868d70d836332a118d9f060/node/node.d.ts" - } -} diff --git a/typings/index.d.ts b/typings/index.d.ts deleted file mode 100644 index ae5424d..0000000 --- a/typings/index.d.ts +++ /dev/null @@ -1 +0,0 @@ -/// \ No newline at end of file From b7e9f047fd1379a95c98aca05be542a68ddd6a53 Mon Sep 17 00:00:00 2001 From: radswiat Date: Tue, 11 Apr 2017 00:11:09 +0100 Subject: [PATCH 2/3] Finilize new version --- .babelrc | 3 +- .gitignore | 5 +- .npmignore | 2 +- README.md | 87 ++- demo/dist/index-bundle.js | 94 +++ demo/package.json | 18 + demo/src/index.html | 10 + demo/src/main.css | 3 + demo/src/main.js | 11 + demo/webpack.conf.js | 53 +- dist/WebpackAutoInjectVersion.js | 984 ++++++++++++++++++++++++ dist/index-bundle.js | 472 ------------ package.json | 73 +- src/components/auto-inc-version.ts | 92 --- src/components/auto-increase-version.js | 92 +++ src/components/inject-as-comment.js | 59 ++ src/components/inject-as-comment.ts | 59 -- src/components/inject-by-tag.js | 36 + src/components/inject-by-tag.ts | 37 - src/config.js | 36 +- src/core/log.js | 7 +- src/core/utils.js | 46 +- src/main.js | 78 +- tools/webpack.conf.js | 11 +- 24 files changed, 1537 insertions(+), 831 deletions(-) create mode 100644 demo/dist/index-bundle.js create mode 100644 demo/src/index.html create mode 100644 demo/src/main.css create mode 100644 demo/src/main.js create mode 100644 dist/WebpackAutoInjectVersion.js delete mode 100644 dist/index-bundle.js delete mode 100644 src/components/auto-inc-version.ts create mode 100644 src/components/auto-increase-version.js create mode 100644 src/components/inject-as-comment.js delete mode 100644 src/components/inject-as-comment.ts create mode 100644 src/components/inject-by-tag.js delete mode 100644 src/components/inject-by-tag.ts diff --git a/.babelrc b/.babelrc index ca0e475..0b5b17c 100644 --- a/.babelrc +++ b/.babelrc @@ -9,7 +9,8 @@ "root": ["./src/"], "alias": { "config": "./config", - "core": "./core" + "core": "./core", + "components": "./components" } }], "transform-runtime" diff --git a/.gitignore b/.gitignore index e51945e..6bdf374 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,4 @@ -.idea -node_modules +.idea/ +node_modules/ +demo/node_modules/ npm-debug* diff --git a/.npmignore b/.npmignore index c5123e0..7922729 100644 --- a/.npmignore +++ b/.npmignore @@ -1,2 +1,2 @@ npm-debug* -.idea \ No newline at end of file +.idea/ \ No newline at end of file diff --git a/README.md b/README.md index e32ed5a..b18c225 100644 --- a/README.md +++ b/README.md @@ -1,16 +1,24 @@ # Auto inject version - Webpack plugin -## Add version to bundle automatically +Adds version from package.json into every single file as top comment block. -## What +### Install + +```console +$ npm install webpack-auto-inject-version --save-dev +``` + +# What it gives you Auto Inject Version (AIV) can: - inject version from package.json into every bundle file as a comment ( at the top ) -- inject version from package.json into any place in your HTML by special tag <{version}> -- inject version from package.json into any place in CSS/JS file by special tag <{version}> -- auto increase version by --major, --minor, --patch and then inject as chosen +- inject version from package.json into any place in your HTML by special tag `[AIV]{version}[/AIV]` +- inject version from package.json into any place in CSS/JS file by special tag `[AIV]{version}[/AIV]` +- auto increase package.json version by --env.major, --env.minor, --env.patch passed into webpack -## Desc +## Example +Please take a look into `demo/` folder. + +## Inject example AIV can inject version number for all your bundle files (css,js,html).

-Example js: ```js // [AIV] Build version: 1.0.10 /******/ (function(modules) { // webpackBootstrap @@ -25,29 +33,21 @@ Example html: ``` -AIV can also auto inject your version number into html by using special code ( <{version}> ).

-Example: -```html -My awesome project | <{version}> -``` - -
- -## Install - -```console -$ npm install webpack-auto-inject-version --save-dev -``` -
- -## Usage +# How to configure +In webpack.conf.js ( or any name of webpack conf file ) ```js var WebpackAutoInject = require('webpack-auto-inject-version'); module.exports = { plugins: [ - new WebpackAutoInject(options) + new WebpackAutoInject({ + // options + // example: + components: { + AutoIncreaseVersion: false + } + }) ] } ``` @@ -56,11 +56,11 @@ module.exports = { ## Options -### autoIncrease +### components.AutoIncreaseVersion Auto increase package.json number.
This option requires extra argument to be sent to webpack build.
It happens before anything else to make sure that your new version is injected into your files.
-Arguments: --major --minor --patch

+Arguments: --env.major --env.minor --env.patch


@@ -68,39 +68,38 @@ Example for package.json run type, npm run start => ( 1.2.10 to 2.0.0 ) ```json "version" : "1.2.10", "scripts": { - "start": "webpack --major" + "start": "webpack --env.major" } ``` Default: true
-### injectByTag +### components.InjectByTag Inject version number into your file
Version will replace the <{version}> tag.
```html -My awesome project | <{version}> +My awesome project | [AIV]{version}[/AIV] ``` ```js -var version = '<{version}>'; +var version = '[AIV]{version}[/AIV]'; ``` Default: true
- -### injectByTagFileRegex -Regex against file name. If match, injectByTag will try to find version tag and replace it. -Only html files: /^(.){1,}\.html$/
-Only js files: ^(.){1,}\.js$
-Any file: (.){1,}
-Default: /^index\.html$/ - - -
- - -### injectAsComment +### components.InjectAsComment This will inject your version as a comment into any css,js,html file.
-Default: true \ No newline at end of file +Default: true + +# Development advice +Demo has been created to simplify the testing of the webpack-plugin, +if you would like to work on this webpack plugin you should: +* clone the repo +* npm install on ./ & ./demo +* npm start on ./ +* and then you can test your code by demo/ npm start + + + diff --git a/demo/dist/index-bundle.js b/demo/dist/index-bundle.js new file mode 100644 index 0000000..e8a36be --- /dev/null +++ b/demo/dist/index-bundle.js @@ -0,0 +1,94 @@ +// [AIV] Build version: 0.2.12 + /******/ (function(modules) { // webpackBootstrap +/******/ // The module cache +/******/ var installedModules = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) +/******/ return installedModules[moduleId].exports; +/******/ +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ i: moduleId, +/******/ l: false, +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); +/******/ +/******/ // Flag the module as loaded +/******/ module.l = true; +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/******/ +/******/ // expose the modules object (__webpack_modules__) +/******/ __webpack_require__.m = modules; +/******/ +/******/ // expose the module cache +/******/ __webpack_require__.c = installedModules; +/******/ +/******/ // identity function for calling harmony imports with the correct context +/******/ __webpack_require__.i = function(value) { return value; }; +/******/ +/******/ // define getter function for harmony exports +/******/ __webpack_require__.d = function(exports, name, getter) { +/******/ if(!__webpack_require__.o(exports, name)) { +/******/ Object.defineProperty(exports, name, { +/******/ configurable: false, +/******/ enumerable: true, +/******/ get: getter +/******/ }); +/******/ } +/******/ }; +/******/ +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = function(module) { +/******/ var getter = module && module.__esModule ? +/******/ function getDefault() { return module['default']; } : +/******/ function getModuleExports() { return module; }; +/******/ __webpack_require__.d(getter, 'a', getter); +/******/ return getter; +/******/ }; +/******/ +/******/ // Object.prototype.hasOwnProperty.call +/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; +/******/ +/******/ // __webpack_public_path__ +/******/ __webpack_require__.p = ""; +/******/ +/******/ // Load entry module and return exports +/******/ return __webpack_require__(__webpack_require__.s = 1); +/******/ }) +/************************************************************************/ +/******/ ([ +/* 0 */ +/***/ (function(module, exports) { + +module.exports = "TitleMy awesome project | 0.2.12>" + +/***/ }), +/* 1 */ +/***/ (function(module, exports, __webpack_require__) { + +var html = __webpack_require__(0); + +/** + * Sample code + * @type {number} + */ +var myVariable = 5; +var test = function(val) { + return val * val; +}; +test(myVariable); + + +/***/ }) +/******/ ]); \ No newline at end of file diff --git a/demo/package.json b/demo/package.json index e69de29..91a3f26 100644 --- a/demo/package.json +++ b/demo/package.json @@ -0,0 +1,18 @@ +{ + "name": "example-using-inject", + "version": "0.13.4", + "description": "This is an example how to use webpack-auto-inject-version plugin in webpack", + "scripts": { + "start": "webpack --config ./webpack.conf.js", + "patch": "webpack --config ./webpack.conf.js --env.patch", + "minor": "webpack --config ./webpack.conf.js --env.minor", + "major": "webpack --config ./webpack.conf.js --env.major" + }, + "author": "Radoslaw Swiat", + "license": "ISC", + "devDependencies": { + "html-minify-loader": "^1.1.0", + "raw-loader": "^0.5.1", + "webpack": "^2.3.3" + } +} diff --git a/demo/src/index.html b/demo/src/index.html new file mode 100644 index 0000000..698f986 --- /dev/null +++ b/demo/src/index.html @@ -0,0 +1,10 @@ + + + + + Title + + + My awesome project | [AIV]{version}[/AIV]> + + \ No newline at end of file diff --git a/demo/src/main.css b/demo/src/main.css new file mode 100644 index 0000000..2be538b --- /dev/null +++ b/demo/src/main.css @@ -0,0 +1,3 @@ +body { + backgroun: red; +} \ No newline at end of file diff --git a/demo/src/main.js b/demo/src/main.js new file mode 100644 index 0000000..3cfac81 --- /dev/null +++ b/demo/src/main.js @@ -0,0 +1,11 @@ +var html = require('./index.html'); + +/** + * Sample code + * @type {number} + */ +var myVariable = 5; +var test = function(val) { + return val * val; +}; +test(myVariable); diff --git a/demo/webpack.conf.js b/demo/webpack.conf.js index 659c8c8..625c844 100644 --- a/demo/webpack.conf.js +++ b/demo/webpack.conf.js @@ -1,3 +1,50 @@ -/** - * Created by 608234548 on 10/04/2017. - */ +var path = require('path'); +// Require WebpackAutoInject from npm installed modules ( prefered ) +// var WebpackAutoInject = require('webpack-auto-inject-version').default; +// Require WebpackAutoInject from dist - dev purpose only ( do not use the below line ) +var WebpackAutoInject = require('../dist/WebpackAutoInjectVersion').default; + +module.exports = { + entry: { + index: './src/main.js' + }, + resolve: { + extensions: ['.js', '.html'] + }, + output: { + filename: '[name]-bundle.js', + path: path.resolve(process.cwd(), 'dist') + }, + module: { + loaders: [ + { + test: /\.js$/, + include: [ + path.resolve('src') + ] + }, + { + test: /\.json$/, + loader: 'json-loader' + }, + { + test: /\.txt$/, + loader: 'raw-loader' + }, + { + test: /\.html$/, + loader: 'raw-loader!html-minify-loader' + } + ] + }, + plugins: [ + new WebpackAutoInject({ + PACKAGE_JSON_PATH: '../package.json', + components: { + AutoIncreaseVersion: true, + InjectAsComment: true, + InjectByTag: true + } + }) + ] +}; diff --git a/dist/WebpackAutoInjectVersion.js b/dist/WebpackAutoInjectVersion.js new file mode 100644 index 0000000..5afb4bb --- /dev/null +++ b/dist/WebpackAutoInjectVersion.js @@ -0,0 +1,984 @@ +(function webpackUniversalModuleDefinition(root, factory) { + if(typeof exports === 'object' && typeof module === 'object') + module.exports = factory(require("babel-runtime/helpers/classCallCheck"), require("babel-runtime/helpers/createClass"), require("chalk"), require("path"), require("babel-runtime/core-js/promise"), require("fs"), require("os"), require("babel-runtime/helpers/asyncToGenerator"), require("babel-runtime/regenerator"), require("lodash"), require("babel-runtime/core-js/json/stringify"), require("optimist"), require("semver")); + else if(typeof define === 'function' && define.amd) + define(["babel-runtime/helpers/classCallCheck", "babel-runtime/helpers/createClass", "chalk", "path", "babel-runtime/core-js/promise", "fs", "os", "babel-runtime/helpers/asyncToGenerator", "babel-runtime/regenerator", "lodash", "babel-runtime/core-js/json/stringify", "optimist", "semver"], factory); + else { + var a = typeof exports === 'object' ? factory(require("babel-runtime/helpers/classCallCheck"), require("babel-runtime/helpers/createClass"), require("chalk"), require("path"), require("babel-runtime/core-js/promise"), require("fs"), require("os"), require("babel-runtime/helpers/asyncToGenerator"), require("babel-runtime/regenerator"), require("lodash"), require("babel-runtime/core-js/json/stringify"), require("optimist"), require("semver")) : factory(root["babel-runtime/helpers/classCallCheck"], root["babel-runtime/helpers/createClass"], root["chalk"], root["path"], root["babel-runtime/core-js/promise"], root["fs"], root["os"], root["babel-runtime/helpers/asyncToGenerator"], root["babel-runtime/regenerator"], root["lodash"], root["babel-runtime/core-js/json/stringify"], root["optimist"], root["semver"]); + for(var i in a) (typeof exports === 'object' ? exports : root)[i] = a[i]; + } +})(this, function(__WEBPACK_EXTERNAL_MODULE_0__, __WEBPACK_EXTERNAL_MODULE_1__, __WEBPACK_EXTERNAL_MODULE_2__, __WEBPACK_EXTERNAL_MODULE_5__, __WEBPACK_EXTERNAL_MODULE_6__, __WEBPACK_EXTERNAL_MODULE_7__, __WEBPACK_EXTERNAL_MODULE_9__, __WEBPACK_EXTERNAL_MODULE_13__, __WEBPACK_EXTERNAL_MODULE_14__, __WEBPACK_EXTERNAL_MODULE_15__, __WEBPACK_EXTERNAL_MODULE_17__, __WEBPACK_EXTERNAL_MODULE_18__, __WEBPACK_EXTERNAL_MODULE_19__) { +return /******/ (function(modules) { // webpackBootstrap +/******/ // The module cache +/******/ var installedModules = {}; +/******/ +/******/ // The require function +/******/ function __webpack_require__(moduleId) { +/******/ +/******/ // Check if module is in cache +/******/ if(installedModules[moduleId]) +/******/ return installedModules[moduleId].exports; +/******/ +/******/ // Create a new module (and put it into the cache) +/******/ var module = installedModules[moduleId] = { +/******/ i: moduleId, +/******/ l: false, +/******/ exports: {} +/******/ }; +/******/ +/******/ // Execute the module function +/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); +/******/ +/******/ // Flag the module as loaded +/******/ module.l = true; +/******/ +/******/ // Return the exports of the module +/******/ return module.exports; +/******/ } +/******/ +/******/ +/******/ // expose the modules object (__webpack_modules__) +/******/ __webpack_require__.m = modules; +/******/ +/******/ // expose the module cache +/******/ __webpack_require__.c = installedModules; +/******/ +/******/ // identity function for calling harmony imports with the correct context +/******/ __webpack_require__.i = function(value) { return value; }; +/******/ +/******/ // define getter function for harmony exports +/******/ __webpack_require__.d = function(exports, name, getter) { +/******/ if(!__webpack_require__.o(exports, name)) { +/******/ Object.defineProperty(exports, name, { +/******/ configurable: false, +/******/ enumerable: true, +/******/ get: getter +/******/ }); +/******/ } +/******/ }; +/******/ +/******/ // getDefaultExport function for compatibility with non-harmony modules +/******/ __webpack_require__.n = function(module) { +/******/ var getter = module && module.__esModule ? +/******/ function getDefault() { return module['default']; } : +/******/ function getModuleExports() { return module; }; +/******/ __webpack_require__.d(getter, 'a', getter); +/******/ return getter; +/******/ }; +/******/ +/******/ // Object.prototype.hasOwnProperty.call +/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; +/******/ +/******/ // __webpack_public_path__ +/******/ __webpack_require__.p = ""; +/******/ +/******/ // Load entry module and return exports +/******/ return __webpack_require__(__webpack_require__.s = 16); +/******/ }) +/************************************************************************/ +/******/ ([ +/* 0 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/helpers/classCallCheck"); + +/***/ }), +/* 1 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/helpers/createClass"); + +/***/ }), +/* 2 */ +/***/ (function(module, exports) { + +module.exports = require("chalk"); + +/***/ }), +/* 3 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); +exports.default = { + PACKAGE_JSON_PATH: './package.json', + components: { + AutoIncreaseVersion: true, + InjectAsComment: true, + InjectByTag: true + }, + componentsOptions: { + InjectByTag: { + fileRegex: /\.+/ + } + }, + LOGS_TEXT: { + AIS_START: 'Auto inject version started' + } +}; + +/***/ }), +/* 4 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _config = __webpack_require__(3); + +var _config2 = _interopRequireDefault(_config); + +var _chalk = __webpack_require__(2); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _utils = __webpack_require__(8); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var endOfLine = __webpack_require__(9).EOL; + +var Log = function () { + // default 1 + + function Log() { + (0, _classCallCheck3.default)(this, Log); + this.logLevel = 3; + + this.getLogLevel(); + } + + (0, _createClass3.default)(Log, [{ + key: 'getLogLevel', + value: function getLogLevel() { + if ((0, _utils.isArgv)('aiv-log-full')) { + this.logLevel = 3; + } else if ((0, _utils.isArgv)('aiv-log-none')) { + this.logLevel = 0; + } + } + + /** + * Get console log head + * @returns {string} + */ + + }, { + key: 'getHead', + value: function getHead() { + return endOfLine + _chalk2.default.bgYellow.black('[AIV] : '); + } + + /** + * Get log text by ID from config file + */ + + }, { + key: 'getText', + value: function getText(id) { + return _config2.default.LOGS_TEXT[id]; + } + + /** + * Call any type + * @param type + * @param msg + */ + + }, { + key: 'call', + value: function call(type, msgId) { + if (typeof this[type] === 'function') { + this[type](this.getText(msgId)); + } + } + }, { + key: 'error', + value: function error(msg) { + if (this.logLevel < 3) return; + console.log(this.getHead() + ' ' + _chalk2.default.red('error') + ' : ' + msg); + } + }, { + key: 'info', + value: function info(msg) { + if (!this.logLevel) return; + console.log(this.getHead() + ' ' + _chalk2.default.blue('info') + ' : ' + msg); + } + }, { + key: 'warn', + value: function warn(msg) { + if (!this.logLevel) return; + console.log(this.getHead() + ' ' + _chalk2.default.yellow('warn') + ' : ' + msg); + } + }]); + return Log; +}(); + +exports.default = new Log(); + +/***/ }), +/* 5 */ +/***/ (function(module, exports) { + +module.exports = require("path"); + +/***/ }), +/* 6 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/core-js/promise"); + +/***/ }), +/* 7 */ +/***/ (function(module, exports) { + +module.exports = require("fs"); + +/***/ }), +/* 8 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); +exports.isArgv = isArgv; +exports.merge = merge; +var argv = __webpack_require__(18).argv; + +/** + * Get argv from webpack env[argv] + * Since webpack 2.0 we have to pass args by the env + * example: + * - webpack --config ./webpack.conf.js --env.patch + * @param arg + * @returns {boolean} + */ +function isArgv(arg) { + return Boolean(argv.env[arg]); +} + +/** + * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 + * @param obj1 + * @param obj2 + * @returns obj3 a new object based on obj1 and obj2 + */ +function merge(obj1, obj2) { + var obj3 = {}; + for (var attrname in obj1) { + obj3[attrname] = obj1[attrname]; + } + for (var attrname in obj2) { + obj3[attrname] = obj2[attrname]; + } + return obj3; +} + +/***/ }), +/* 9 */ +/***/ (function(module, exports) { + +module.exports = require("os"); + +/***/ }), +/* 10 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _stringify = __webpack_require__(17); + +var _stringify2 = _interopRequireDefault(_stringify); + +var _promise = __webpack_require__(6); + +var _promise2 = _interopRequireDefault(_promise); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _semver = __webpack_require__(19); + +var _semver2 = _interopRequireDefault(_semver); + +var _config = __webpack_require__(3); + +var _config2 = _interopRequireDefault(_config); + +var _path = __webpack_require__(5); + +var _path2 = _interopRequireDefault(_path); + +var _fs = __webpack_require__(7); + +var _fs2 = _interopRequireDefault(_fs); + +var _utils = __webpack_require__(8); + +var _chalk = __webpack_require__(2); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _log = __webpack_require__(4); + +var _log2 = _interopRequireDefault(_log); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var AutoIncreaseVersion = function () { + function AutoIncreaseVersion(context) { + (0, _classCallCheck3.default)(this, AutoIncreaseVersion); + + this.context = context; + } + + (0, _createClass3.default)(AutoIncreaseVersion, [{ + key: 'apply', + value: function apply() { + var _this = this; + + return new _promise2.default(function (resolve, reject) { + _this.resolve = resolve; + _this.reject = reject; + _this.start(); + }); + } + + /** + * Start version increase + * - decide scenario: major, minor, patch + */ + + }, { + key: 'start', + value: function start() { + this.packageFile = this.openPackageFile(); + if ((0, _utils.isArgv)('major')) { + this.major(); + } else if ((0, _utils.isArgv)('minor')) { + this.minor(); + } else if ((0, _utils.isArgv)('patch')) { + this.patch(); + } else { + this.reject(); + } + } + + /** + * Open package file + * @returns {any} + */ + + }, { + key: 'openPackageFile', + value: function openPackageFile() { + return JSON.parse(_fs2.default.readFileSync(_path2.default.resolve(this.context.config.PACKAGE_JSON_PATH), 'utf8')); + } + + /** + * Close & save package file + * @param newVersion + */ + + }, { + key: 'closePackageFile', + value: function closePackageFile(newVersion) { + var _this2 = this; + + this.packageFile.version = newVersion; + _fs2.default.writeFile(_path2.default.resolve(this.context.config.PACKAGE_JSON_PATH), (0, _stringify2.default)(this.packageFile, null, 4), function (err) { + if (err) { + _this2.reject(err);return console.log(err); + } + _log2.default.info('autoIncVersion : new version : ' + newVersion); + _log2.default.info('package.json updated!'); + _this2.context.version = newVersion; + _this2.resolve(); + }); + } + + /** + * Increase major + */ + + }, { + key: 'major', + value: function major() { + var newVersion = _semver2.default.inc(this.packageFile.version, 'major'); + this.closePackageFile(newVersion); + } + + /** + * Increase minor + */ + + }, { + key: 'minor', + value: function minor() { + var newVersion = _semver2.default.inc(this.packageFile.version, 'minor'); + this.closePackageFile(newVersion); + } + + /** + * Increase patch + */ + + }, { + key: 'patch', + value: function patch() { + var newVersion = _semver2.default.inc(this.packageFile.version, 'patch'); + this.closePackageFile(newVersion); + } + }]); + return AutoIncreaseVersion; +}(); + +AutoIncreaseVersion.componentName = 'AutoIncreaseVersion'; +exports.default = AutoIncreaseVersion; + +/***/ }), +/* 11 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _promise = __webpack_require__(6); + +var _promise2 = _interopRequireDefault(_promise); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _chalk = __webpack_require__(2); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _path = __webpack_require__(5); + +var _path2 = _interopRequireDefault(_path); + +var _config = __webpack_require__(3); + +var _config2 = _interopRequireDefault(_config); + +var _log = __webpack_require__(4); + +var _log2 = _interopRequireDefault(_log); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var endOfLine = __webpack_require__(9).EOL; + +/** + * Inject version number into HTML + * - done by parsing html file, + * > replace: <{version}> + */ + +var InjectAsComment = function () { + function InjectAsComment(context) { + (0, _classCallCheck3.default)(this, InjectAsComment); + + this.context = context; + } + + (0, _createClass3.default)(InjectAsComment, [{ + key: 'apply', + value: function apply() { + var _this = this; + + this.context.compiler.plugin('emit', function (compilation, cb) { + for (var basename in compilation.assets) { + var ext = _path2.default.extname(basename); + var asset = compilation.assets[basename]; + switch (ext) { + case '.js': + _this.injectIntoJs(asset); + break; + case '.html': + _this.injectIntoHtml(asset); + break; + case '.css': + _this.injectIntoCss(asset); + break; + case 'default': + break; + } + _log2.default.info('InjectAsComment : match : ' + basename + ' : injected : ' + _this.context.version); + } + cb(); + }); + return new _promise2.default(function (resolve, reject) { + resolve(); + }); + } + }, { + key: 'injectIntoCss', + value: function injectIntoCss(asset) { + var modAsset = '/** [' + _config2.default.SHORT + '] Build version: ' + this.context.version + ' **/ ' + endOfLine + ' ' + asset.source() + ' '; + asset.source = function () { + return modAsset; + }; + } + }, { + key: 'injectIntoHtml', + value: function injectIntoHtml(asset) { + var modAsset = ' ' + endOfLine + ' ' + asset.source() + ' '; + asset.source = function () { + return modAsset; + }; + } + }, { + key: 'injectIntoJs', + value: function injectIntoJs(asset) { + var modAsset = '// [' + _config2.default.SHORT + '] Build version: ' + this.context.version + ' ' + endOfLine + ' ' + asset.source() + ' '; + asset.source = function () { + return modAsset; + }; + } + }]); + return InjectAsComment; +}(); + +InjectAsComment.componentName = 'InjectAsComment'; +exports.default = InjectAsComment; + +/***/ }), +/* 12 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _promise = __webpack_require__(6); + +var _promise2 = _interopRequireDefault(_promise); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _log = __webpack_require__(4); + +var _log2 = _interopRequireDefault(_log); + +var _chalk = __webpack_require__(2); + +var _chalk2 = _interopRequireDefault(_chalk); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +/** + * Inject version number into HTML + * - done by parsing html file, + * > replace: <{version}> + */ +var InjectByTag = function () { + function InjectByTag(context) { + (0, _classCallCheck3.default)(this, InjectByTag); + + this.context = context; + } + + (0, _createClass3.default)(InjectByTag, [{ + key: 'apply', + value: function apply() { + var _this = this; + + console.log('------------------- INJECT BY TAG! ------------------'); + this.context.compiler.plugin('emit', function (compilation, cb) { + console.log('------------------- INJECT BY TAG! APPLY! ------------------'); + console.log(compilation.assets); + // for every output file + for (var basename in compilation.assets) { + console.log(_chalk2.default.green.bold('=================')); + console.log(basename); + // only if match regex + console.log(basename + ' is: ' + _this.context.config.componentsOptions.InjectByTag.fileRegex.test(basename)); + if (_this.context.config.componentsOptions.InjectByTag.fileRegex.test(basename)) { + (function () { + var replaced = 0; + var asset = compilation.assets[basename]; + var modFile = asset.source().replace(/(\[AIV\]{version}\[\/AIV\])/g, function () { + console.log('replace?!'); + replaced++; + return _this.context.version; + }); + asset.source = function () { + return modFile; + }; + _log2.default.info('InjectByTag : match : ' + basename + ' : replaced : ' + replaced); + })(); + } + } + cb(); + }); + return new _promise2.default(function (resolve, reject) { + resolve(); + }); + } + }]); + return InjectByTag; +}(); + +InjectByTag.componentName = 'InjectByTag'; +exports.default = InjectByTag; + +/***/ }), +/* 13 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/helpers/asyncToGenerator"); + +/***/ }), +/* 14 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/regenerator"); + +/***/ }), +/* 15 */ +/***/ (function(module, exports) { + +module.exports = require("lodash"); + +/***/ }), +/* 16 */ +/***/ (function(module, exports, __webpack_require__) { + +"use strict"; + + +Object.defineProperty(exports, "__esModule", { + value: true +}); + +var _regenerator = __webpack_require__(14); + +var _regenerator2 = _interopRequireDefault(_regenerator); + +var _asyncToGenerator2 = __webpack_require__(13); + +var _asyncToGenerator3 = _interopRequireDefault(_asyncToGenerator2); + +var _classCallCheck2 = __webpack_require__(0); + +var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); + +var _createClass2 = __webpack_require__(1); + +var _createClass3 = _interopRequireDefault(_createClass2); + +var _chalk = __webpack_require__(2); + +var _chalk2 = _interopRequireDefault(_chalk); + +var _fs = __webpack_require__(7); + +var _fs2 = _interopRequireDefault(_fs); + +var _path = __webpack_require__(5); + +var _path2 = _interopRequireDefault(_path); + +var _config = __webpack_require__(3); + +var _config2 = _interopRequireDefault(_config); + +var _log = __webpack_require__(4); + +var _log2 = _interopRequireDefault(_log); + +var _lodash = __webpack_require__(15); + +var _autoIncreaseVersion = __webpack_require__(10); + +var _autoIncreaseVersion2 = _interopRequireDefault(_autoIncreaseVersion); + +var _injectAsComment = __webpack_require__(11); + +var _injectAsComment2 = _interopRequireDefault(_injectAsComment); + +var _injectByTag = __webpack_require__(12); + +var _injectByTag2 = _interopRequireDefault(_injectByTag); + +function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } + +var WebpackAutoInject = function () { + + /** + * Constructor, + * called on webpack config load + * @param userConfig - config from the webpack config file + */ + function WebpackAutoInject(userConfig) { + (0, _classCallCheck3.default)(this, WebpackAutoInject); + + this.setConfig(userConfig); + var packageFile = JSON.parse(_fs2.default.readFileSync(_path2.default.resolve(this.config.PACKAGE_JSON_PATH), 'utf8')); + this.version = packageFile.version; + _log2.default.call('info', 'AIS_START'); + this.executeNoneWebpackComponents(); + } + + (0, _createClass3.default)(WebpackAutoInject, [{ + key: 'setConfig', + value: function setConfig(userConfig) { + this.config = (0, _lodash.merge)(_config2.default, userConfig); + + // lets convert all components names to lowercase - to prevent issues + this.config.components = (0, _lodash.transform)(this.config.components, function (result, val, key) { + result[key.toLowerCase()] = val; + }); + + this.config = (0, _lodash.merge)(this.config, WebpackAutoInject.protectedConfig); + } + + /** + * Webpack apply call, + * when webpack is initialized and + * plugin has been called by webpack + * @param compiler + */ + + }, { + key: 'apply', + value: function () { + var _ref = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee(compiler) { + return _regenerator2.default.wrap(function _callee$(_context) { + while (1) { + switch (_context.prev = _context.next) { + case 0: + this.compiler = compiler; + _context.next = 3; + return this.executeWebpackComponents(); + + case 3: + case 'end': + return _context.stop(); + } + } + }, _callee, this); + })); + + function apply(_x) { + return _ref.apply(this, arguments); + } + + return apply; + }() + + /** + * Execute none webpack components + * - runs as soon as possible, + * > without waiting for webpack init + */ + + }, { + key: 'executeNoneWebpackComponents', + value: function () { + var _ref2 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee2() { + return _regenerator2.default.wrap(function _callee2$(_context2) { + while (1) { + switch (_context2.prev = _context2.next) { + case 0: + _context2.next = 2; + return this.executeComponent([_autoIncreaseVersion2.default]); + + case 2: + case 'end': + return _context2.stop(); + } + } + }, _callee2, this); + })); + + function executeNoneWebpackComponents() { + return _ref2.apply(this, arguments); + } + + return executeNoneWebpackComponents; + }() + + /** + * Execute webpack components + * - runs when webpack is initialized + * and plugins is called by webpack + */ + + }, { + key: 'executeWebpackComponents', + value: function () { + var _ref3 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee3() { + return _regenerator2.default.wrap(function _callee3$(_context3) { + while (1) { + switch (_context3.prev = _context3.next) { + case 0: + _context3.next = 2; + return this.executeComponent([_injectAsComment2.default, _injectByTag2.default]); + + case 2: + case 'end': + return _context3.stop(); + } + } + }, _callee3, this); + })); + + function executeWebpackComponents() { + return _ref3.apply(this, arguments); + } + + return executeWebpackComponents; + }() + + /** + * Execute components, + * - general layer for comp execution + * - used for both, webpack and non webpack comp + */ + + }, { + key: 'executeComponent', + value: function () { + var _ref4 = (0, _asyncToGenerator3.default)(_regenerator2.default.mark(function _callee4(components) { + var ComponentClass, inst; + return _regenerator2.default.wrap(function _callee4$(_context4) { + while (1) { + switch (_context4.prev = _context4.next) { + case 0: + if (components.length) { + _context4.next = 2; + break; + } + + return _context4.abrupt('return'); + + case 2: + + // take first component class + ComponentClass = components.shift(); + + // if component is disabled, call next component + + if (this.config.components[ComponentClass.componentName.toLowerCase()]) { + _context4.next = 7; + break; + } + + _context4.next = 6; + return this.executeComponent(components); + + case 6: + return _context4.abrupt('return'); + + case 7: + + // execute component + inst = new ComponentClass(this); + + // await for apply to finish + + _context4.next = 10; + return inst.apply(); + + case 10: + _context4.next = 12; + return this.executeComponent(components); + + case 12: + case 'end': + return _context4.stop(); + } + } + }, _callee4, this); + })); + + function executeComponent(_x2) { + return _ref4.apply(this, arguments); + } + + return executeComponent; + }() + }]); + return WebpackAutoInject; +}(); + +// import sub components + + +WebpackAutoInject.protectedConfig = { + NAME: 'Auto Inject Version', + SHORT: 'AIV' +}; +exports.default = WebpackAutoInject; + +/***/ }), +/* 17 */ +/***/ (function(module, exports) { + +module.exports = require("babel-runtime/core-js/json/stringify"); + +/***/ }), +/* 18 */ +/***/ (function(module, exports) { + +module.exports = require("optimist"); + +/***/ }), +/* 19 */ +/***/ (function(module, exports) { + +module.exports = require("semver"); + +/***/ }) +/******/ ]); +}); \ No newline at end of file diff --git a/dist/index-bundle.js b/dist/index-bundle.js deleted file mode 100644 index 7fb9f9f..0000000 --- a/dist/index-bundle.js +++ /dev/null @@ -1,472 +0,0 @@ -/******/ (function(modules) { // webpackBootstrap -/******/ // The module cache -/******/ var installedModules = {}; -/******/ -/******/ // The require function -/******/ function __webpack_require__(moduleId) { -/******/ -/******/ // Check if module is in cache -/******/ if(installedModules[moduleId]) -/******/ return installedModules[moduleId].exports; -/******/ -/******/ // Create a new module (and put it into the cache) -/******/ var module = installedModules[moduleId] = { -/******/ i: moduleId, -/******/ l: false, -/******/ exports: {} -/******/ }; -/******/ -/******/ // Execute the module function -/******/ modules[moduleId].call(module.exports, module, module.exports, __webpack_require__); -/******/ -/******/ // Flag the module as loaded -/******/ module.l = true; -/******/ -/******/ // Return the exports of the module -/******/ return module.exports; -/******/ } -/******/ -/******/ -/******/ // expose the modules object (__webpack_modules__) -/******/ __webpack_require__.m = modules; -/******/ -/******/ // expose the module cache -/******/ __webpack_require__.c = installedModules; -/******/ -/******/ // identity function for calling harmony imports with the correct context -/******/ __webpack_require__.i = function(value) { return value; }; -/******/ -/******/ // define getter function for harmony exports -/******/ __webpack_require__.d = function(exports, name, getter) { -/******/ if(!__webpack_require__.o(exports, name)) { -/******/ Object.defineProperty(exports, name, { -/******/ configurable: false, -/******/ enumerable: true, -/******/ get: getter -/******/ }); -/******/ } -/******/ }; -/******/ -/******/ // getDefaultExport function for compatibility with non-harmony modules -/******/ __webpack_require__.n = function(module) { -/******/ var getter = module && module.__esModule ? -/******/ function getDefault() { return module['default']; } : -/******/ function getModuleExports() { return module; }; -/******/ __webpack_require__.d(getter, 'a', getter); -/******/ return getter; -/******/ }; -/******/ -/******/ // Object.prototype.hasOwnProperty.call -/******/ __webpack_require__.o = function(object, property) { return Object.prototype.hasOwnProperty.call(object, property); }; -/******/ -/******/ // __webpack_public_path__ -/******/ __webpack_require__.p = ""; -/******/ -/******/ // Load entry module and return exports -/******/ return __webpack_require__(__webpack_require__.s = 11); -/******/ }) -/************************************************************************/ -/******/ ([ -/* 0 */ -/***/ (function(module, exports) { - -module.exports = require("babel-runtime/helpers/classCallCheck"); - -/***/ }), -/* 1 */ -/***/ (function(module, exports) { - -module.exports = require("babel-runtime/helpers/createClass"); - -/***/ }), -/* 2 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -module.exports = { - NAME: 'Auto Inject Version', - SHORT: 'AIV', - PATH_PACKAGE: './package.json', - NON_WEBPACK_COMPONENTS: [{ - option: 'autoIncrease', - path: './components/auto-inc-version' - }], - WEBPACK_COMPONENTS: [{ - option: 'injectByTag', - path: './components/inject-by-tag' - }, { - option: 'injectAsComment', - path: './components/inject-as-comment' - }], - LOGS_TEXT: { - AIS_START: 'Auto inject version started' - } -}; - -/***/ }), -/* 3 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -var _classCallCheck2 = __webpack_require__(0); - -var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); - -var _createClass2 = __webpack_require__(1); - -var _createClass3 = _interopRequireDefault(_createClass2); - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -var Utils = function () { - function Utils() { - (0, _classCallCheck3.default)(this, Utils); - } - - (0, _createClass3.default)(Utils, null, [{ - key: 'isArgv', - value: function isArgv(arg) { - return Boolean(process.argv.find(function (item) { - return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; - })); - } - - /** - * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 - * @param obj1 - * @param obj2 - * @returns obj3 a new object based on obj1 and obj2 - */ - - }, { - key: 'merge', - value: function merge(obj1, obj2) { - var obj3 = {}; - for (var attrname in obj1) { - obj3[attrname] = obj1[attrname]; - } - for (var attrname in obj2) { - obj3[attrname] = obj2[attrname]; - } - return obj3; - } - }]); - return Utils; -}(); - -module.exports = Utils; - -/***/ }), -/* 4 */ -/***/ (function(module, exports) { - -module.exports = require("chalk"); - -/***/ }), -/* 5 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); - -var _classCallCheck2 = __webpack_require__(0); - -var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); - -var _createClass2 = __webpack_require__(1); - -var _createClass3 = _interopRequireDefault(_createClass2); - -var _chalk = __webpack_require__(4); - -var _chalk2 = _interopRequireDefault(_chalk); - -var _fs = __webpack_require__(8); - -var _fs2 = _interopRequireDefault(_fs); - -var _path = __webpack_require__(10); - -var _path2 = _interopRequireDefault(_path); - -var _config = __webpack_require__(2); - -var _config2 = _interopRequireDefault(_config); - -var _utils = __webpack_require__(3); - -var _utils2 = _interopRequireDefault(_utils); - -var _log = __webpack_require__(6); - -var _log2 = _interopRequireDefault(_log); - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -var WebpackAutoInject = function () { - - /** - * Constructor, - * called on webpack config load - * @param options - */ - function WebpackAutoInject(options) { - (0, _classCallCheck3.default)(this, WebpackAutoInject); - - this.options = _utils2.default.merge(WebpackAutoInject.options, options); - var packageFile = JSON.parse(_fs2.default.readFileSync(_path2.default.normalize(_config2.default.PATH_PACKAGE), 'utf8')); - this.version = packageFile.version; - _log2.default.call('info', 'AIS_START'); - this.executeNoneWebpackComponents(); - } - - /** - * Webpack apply call, - * when webpack is initialized and - * plugin has been called by webpack - * @param compiler - */ - - - /** - * Default options - */ - - - (0, _createClass3.default)(WebpackAutoInject, [{ - key: 'apply', - value: function apply(compiler) { - this.compiler = compiler; - this.executeWebpackComponents(); - } - - /** - * Execute none webpack components - * - runs as soon as possible, - * > without waiting for webpack init - */ - - }, { - key: 'executeNoneWebpackComponents', - value: function executeNoneWebpackComponents() { - this.executeComponents(_config2.default.NON_WEBPACK_COMPONENTS, function () {}); - } - - /** - * Execute webpack components - * - runs when webpack is initialized - * and plugins is called by webpack - */ - - }, { - key: 'executeWebpackComponents', - value: function executeWebpackComponents() { - this.executeComponents(_config2.default.WEBPACK_COMPONENTS, function () {}); - } - - /** - * Execute components, - * - general layer for comp execution - * - used for both, webpack and non webpack comp - */ - - }, { - key: 'executeComponents', - value: function executeComponents(components, done) { - var _this = this; - - // no more components, - // finish - if (!components.length) { - done();return; - } - - // take first component - var comp = components.shift(); - - // if component is disabled, call next component - if (!this.options[comp.option]) { - this.executeComponents(components, done); - return; - } - - // execute component - var inst = new (!(function webpackMissingModule() { var e = new Error("Cannot find module \".\""); e.code = 'MODULE_NOT_FOUND'; throw e; }()))(this); - inst.apply().then(function () { - _this.executeComponents(components, done); - }, function (err) { - _this.executeComponents(components, done); - }); - } - }]); - return WebpackAutoInject; -}(); - -WebpackAutoInject.options = { - autoIncrease: true, - injectAsComment: true, - injectByTag: true, - injectByTagFileRegex: /^index\.html$/ -}; -exports.default = WebpackAutoInject; - -/***/ }), -/* 6 */ -/***/ (function(module, exports, __webpack_require__) { - -"use strict"; - - -Object.defineProperty(exports, "__esModule", { - value: true -}); - -var _classCallCheck2 = __webpack_require__(0); - -var _classCallCheck3 = _interopRequireDefault(_classCallCheck2); - -var _createClass2 = __webpack_require__(1); - -var _createClass3 = _interopRequireDefault(_createClass2); - -var _config = __webpack_require__(2); - -var _config2 = _interopRequireDefault(_config); - -var _chalk = __webpack_require__(4); - -var _chalk2 = _interopRequireDefault(_chalk); - -var _utils = __webpack_require__(3); - -var _utils2 = _interopRequireDefault(_utils); - -function _interopRequireDefault(obj) { return obj && obj.__esModule ? obj : { default: obj }; } - -var endOfLine = __webpack_require__(9).EOL; - -var Log = function () { - // default 1 - - function Log() { - (0, _classCallCheck3.default)(this, Log); - this.logLevel = 3; - - this.getLogLevel(); - } - - (0, _createClass3.default)(Log, [{ - key: 'getLogLevel', - value: function getLogLevel() { - if (u.isArgv('aiv-log-full')) { - this.logLevel = 3; - } else if (u.isArgv('aiv-log-none')) { - this.logLevel = 0; - } - } - - /** - * Get console log head - * @returns {string} - */ - - }, { - key: 'getHead', - value: function getHead() { - return endOfLine + _chalk2.default.bgYellow.black('[AIV] : '); - } - - /** - * Get log text by ID from config file - */ - - }, { - key: 'getText', - value: function getText(id) { - return _config2.default.LOGS_TEXT[id]; - } - - /** - * Call any type - * @param type - * @param msg - */ - - }, { - key: 'call', - value: function call(type, msgId) { - if (typeof this[type] === 'function') { - this[type](this.getText(msgId)); - } - } - }, { - key: 'error', - value: function error(msg) { - if (this.logLevel < 3) return; - console.log(this.getHead() + ' ' + _chalk2.default.red('error') + ' : ' + msg); - } - }, { - key: 'info', - value: function info(msg) { - if (!this.logLevel) return; - console.log(this.getHead() + ' ' + _chalk2.default.blue('info') + ' : ' + msg); - } - }, { - key: 'warn', - value: function warn(msg) { - if (!this.logLevel) return; - console.log(this.getHead() + ' ' + _chalk2.default.yellow('warn') + ' : ' + msg); - } - }]); - return Log; -}(); - -exports.default = new Log(); - -/***/ }), -/* 7 */ -/***/ (function(module, exports) { - -function webpackEmptyContext(req) { - throw new Error("Cannot find module '" + req + "'."); -} -webpackEmptyContext.keys = function() { return []; }; -webpackEmptyContext.resolve = webpackEmptyContext; -module.exports = webpackEmptyContext; -webpackEmptyContext.id = 7; - -/***/ }), -/* 8 */ -/***/ (function(module, exports) { - -module.exports = require("fs"); - -/***/ }), -/* 9 */ -/***/ (function(module, exports) { - -module.exports = require("os"); - -/***/ }), -/* 10 */ -/***/ (function(module, exports) { - -module.exports = require("path"); - -/***/ }), -/* 11 */ -/***/ (function(module, exports, __webpack_require__) { - -module.exports = __webpack_require__(5); - - -/***/ }) -/******/ ]); \ No newline at end of file diff --git a/package.json b/package.json index 8e89285..85d6a2c 100644 --- a/package.json +++ b/package.json @@ -1,36 +1,39 @@ { - "name": "webpack-auto-inject-version", - "version": "0.2.0", - "repository": "radswiat/webpack-auto-inject-version", - "description": "Webpack plugin for auto inject version from package.json", - "main": "dist/main.js", - "scripts": { - "start": "babel-node tools/compile.js" - }, - "author": "Radoslaw Swiat", - "license": "ISC", - "devDependencies": { - "babel-cli": "^6.10.1", - "babel-core": "^6.24.1", - "babel-eslint": "^6.0.0", - "babel-loader": "^6.2.4", - "babel-plugin-module-resolver": "^2.4.0", - "babel-plugin-transform-runtime": "^6.12.0", - "babel-preset-es2015": "^6.6.0", - "babel-preset-node5": "^11.0.1", - "babel-preset-react": "^6.5.0", - "babel-preset-stage-2": "^6.22.0", - "eslint": "^2.7.0", - "eslint-config-airbnb": "^6.2.0", - "eslint-loader": "^1.5.0", - "eslint-plugin-babel": "^3.2.0", - "gutil": "^1.6.4", - "webpack": "^2.3.3", - "webpack-node-externals": "^1.5.4" - }, - "dependencies": { - "bluebird": "^3.4.6", - "semver": "^5.3.0", - "chalk": "^1.1.3" - } -} + "name": "webpack-auto-inject-version", + "version": "0.5.0", + "repository": "radswiat/webpack-auto-inject-version", + "description": "Webpack plugin for auto inject version from package.json", + "main": "dist/WebpackAutoInjectVersion.js", + "scripts": { + "start": "babel-node tools/compile.js" + }, + "author": "Radoslaw Swiat", + "license": "ISC", + "devDependencies": { + "babel-cli": "^6.10.1", + "babel-core": "^6.24.1", + "babel-eslint": "^6.0.0", + "babel-loader": "^6.2.4", + "babel-plugin-module-resolver": "^2.4.0", + "babel-plugin-transform-runtime": "^6.12.0", + "babel-preset-es2015": "^6.6.0", + "babel-preset-node5": "^11.0.1", + "babel-preset-react": "^6.5.0", + "babel-preset-stage-2": "^6.22.0", + "eslint": "^2.7.0", + "eslint-config-airbnb": "^6.2.0", + "eslint-loader": "^1.5.0", + "eslint-plugin-babel": "^3.2.0", + "gutil": "^1.6.4", + "webpack": "^2.3.3", + "webpack-node-externals": "^1.5.4" + }, + "dependencies": { + "bluebird": "^3.4.6", + "chalk": "^1.1.3", + "lodash": "^4.17.4", + "minimist": "^1.2.0", + "optimist": "^0.6.1", + "semver": "^5.3.0" + } +} \ No newline at end of file diff --git a/src/components/auto-inc-version.ts b/src/components/auto-inc-version.ts deleted file mode 100644 index 7f7fa49..0000000 --- a/src/components/auto-inc-version.ts +++ /dev/null @@ -1,92 +0,0 @@ -const semver = require('semver'); -const config = require('../config'); -const path = require('path'); -const fs = require('fs'); -const u = require('../core/utils'); -const chalk = require('chalk'); -const Promise = require('bluebird'); -const log = require('../core/log'); - -class IncVersion{ - - private packageFile; - private resolve; - private reject; - - constructor(private context) {} - - public apply() { - return new Promise((resolve, reject) => { - this.resolve = resolve; - this.reject = reject; - this.start(); - }); - } - - /** - * Start version increase - * - decide scenario: major, minor, patch - */ - private start() { - this.packageFile = this.openPackageFile(); - if( u.isArgv('major') ) { - this.major(); - } - else if( u.isArgv('minor') ) { - this.minor(); - }else if( u.isArgv('patch') ) { - this.patch(); - }else { - this.reject(); - } - } - - /** - * Open package file - * @returns {any} - */ - private openPackageFile() { - return JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); - } - - /** - * Close & save package file - * @param newVersion - */ - private closePackageFile(newVersion) { - this.packageFile.version = newVersion; - fs.writeFile(path.normalize(config.PATH_PACKAGE), JSON.stringify(this.packageFile, null, 4), (err) => { - if(err) {this.reject(err); return console.log(err);} - log.info(`autoIncVersion : new version : ${newVersion}`) - log.info('package.json updated!'); - this.context.version = newVersion; - this.resolve(); - }); - } - - /** - * Increase major - */ - private major() { - let newVersion = semver.inc(this.packageFile.version, 'major'); - this.closePackageFile(newVersion); - } - - /** - * Increase minor - */ - private minor() { - let newVersion = semver.inc(this.packageFile.version, 'minor'); - this.closePackageFile(newVersion); - } - - /** - * Increase patch - */ - private patch() { - let newVersion = semver.inc(this.packageFile.version, 'patch'); - this.closePackageFile(newVersion); - } -} - -module.exports = IncVersion; \ No newline at end of file diff --git a/src/components/auto-increase-version.js b/src/components/auto-increase-version.js new file mode 100644 index 0000000..e48dc25 --- /dev/null +++ b/src/components/auto-increase-version.js @@ -0,0 +1,92 @@ +import semver from 'semver'; +import config from 'config'; +import path from 'path'; +import fs from 'fs'; +import { isArgv } from 'core/utils'; +import chalk from 'chalk'; +import log from 'core/log'; + +export default class AutoIncreaseVersion{ + + static componentName = 'AutoIncreaseVersion'; + + constructor(context) { + this.context = context; + } + + apply() { + return new Promise((resolve, reject) => { + this.resolve = resolve; + this.reject = reject; + this.start(); + }); + } + + /** + * Start version increase + * - decide scenario: major, minor, patch + */ + start() { + this.packageFile = this.openPackageFile(); + if( isArgv('major') ) { + this.major(); + } + else if( isArgv('minor') ) { + this.minor(); + }else if( isArgv('patch') ) { + this.patch(); + }else { + this.reject(); + } + } + + /** + * Open package file + * @returns {any} + */ + openPackageFile() { + return JSON.parse(fs.readFileSync(path.resolve(this.context.config.PACKAGE_JSON_PATH), 'utf8')); + } + + /** + * Close & save package file + * @param newVersion + */ + closePackageFile(newVersion) { + this.packageFile.version = newVersion; + fs.writeFile( + path.resolve(this.context.config.PACKAGE_JSON_PATH), + JSON.stringify(this.packageFile, null, 4 + ), (err) => { + if(err) {this.reject(err); return console.log(err);} + log.info(`autoIncVersion : new version : ${newVersion}`); + log.info('package.json updated!'); + this.context.version = newVersion; + this.resolve(); + }); + } + + /** + * Increase major + */ + major() { + let newVersion = semver.inc(this.packageFile.version, 'major'); + this.closePackageFile(newVersion); + } + + /** + * Increase minor + */ + minor() { + let newVersion = semver.inc(this.packageFile.version, 'minor'); + this.closePackageFile(newVersion); + } + + /** + * Increase patch + */ + patch() { + let newVersion = semver.inc(this.packageFile.version, 'patch'); + this.closePackageFile(newVersion); + } +} diff --git a/src/components/inject-as-comment.js b/src/components/inject-as-comment.js new file mode 100644 index 0000000..fc27560 --- /dev/null +++ b/src/components/inject-as-comment.js @@ -0,0 +1,59 @@ +import chalk from 'chalk'; +import path from 'path'; +import config from 'config'; +import log from 'core/log'; + +const endOfLine = require('os').EOL; + +/** + * Inject version number into HTML + * - done by parsing html file, + * > replace: <{version}> + */ +export default class InjectAsComment{ + + static componentName = 'InjectAsComment'; + + constructor(context) { + this.context = context; + } + + apply() { + this.context.compiler.plugin('emit', (compilation, cb) => { + for ( var basename in compilation.assets ) { + let ext = path.extname(basename); + let asset = compilation.assets[basename]; + switch(ext) { + case '.js' : + this.injectIntoJs(asset); + break; + case '.html' : + this.injectIntoHtml(asset); + break; + case '.css' : + this.injectIntoCss(asset); + break; + case 'default': break; + } + log.info(`InjectAsComment : match : ${basename} : injected : ${this.context.version}`); + } + cb(); + }); + return new Promise((resolve, reject) => { resolve(); }) + } + + injectIntoCss(asset) { + let modAsset = `/** [${config.SHORT}] Build version: ${this.context.version} **/ ${endOfLine} ${asset.source()} `; + asset.source = () => modAsset; + } + + injectIntoHtml(asset) { + let modAsset = ` ${endOfLine} ${asset.source()} `; + asset.source = () => modAsset; + } + + injectIntoJs(asset) { + let modAsset = `// [${config.SHORT}] Build version: ${this.context.version} ${endOfLine} ${asset.source()} `; + asset.source = () => modAsset; + } +} diff --git a/src/components/inject-as-comment.ts b/src/components/inject-as-comment.ts deleted file mode 100644 index d1908a5..0000000 --- a/src/components/inject-as-comment.ts +++ /dev/null @@ -1,59 +0,0 @@ -/// -const chalk = require('chalk'); -const path = require('path'); -const endOfLine = require('os').EOL; -const config = require('../config'); -const log = require('../core/log'); - -'use strict'; - -/** - * Inject version number into HTML - * - done by parsing html file, - * > replace: <{version}> - */ -class InjectAsComment{ - - constructor(private context) {} - - apply() { - this.context.compiler.plugin('emit', (compilation, cb) => { - for ( var basename in compilation.assets ) { - let ext = path.extname(basename); - let asset = compilation.assets[basename]; - switch(ext) { - case '.js' : - this.injectIntoJs(asset); - break; - case '.html' : - this.injectIntoHtml(asset); - break; - case '.css' : - this.injectIntoCss(asset); - break; - case 'default': break; - } - log.info(`InjectAsComment : match : ${basename} : injected : ${this.context.version}`); - } - cb(); - }); - return new Promise((resolve, reject) => { resolve(); }) - } - - injectIntoCss(asset) { - let modAsset = `/** [${config.SHORT}] Build version: ${this.context.version} **/ ${endOfLine} ${asset.source()} `; - asset.source = () => modAsset; - } - - injectIntoHtml(asset) { - let modAsset = ` ${endOfLine} ${asset.source()} `; - asset.source = () => modAsset; - } - - injectIntoJs(asset) { - let modAsset = `// [${config.SHORT}] Build version: ${this.context.version} ${endOfLine} ${asset.source()} `; - asset.source = () => modAsset; - } -} - -module.exports = InjectAsComment; \ No newline at end of file diff --git a/src/components/inject-by-tag.js b/src/components/inject-by-tag.js new file mode 100644 index 0000000..07e8e76 --- /dev/null +++ b/src/components/inject-by-tag.js @@ -0,0 +1,36 @@ +import log from 'core/log'; +import chalk from 'chalk'; +/** + * Inject version number into HTML + * - done by parsing html file, + * > replace: <{version}> + */ +export default class InjectByTag{ + + static componentName = 'InjectByTag'; + + constructor(context) { + this.context = context; + } + + apply() { + this.context.compiler.plugin('emit', (compilation, cb) => { + // for every output file + for ( let basename in compilation.assets ) { + // only if match regex + if(this.context.config.componentsOptions.InjectByTag.fileRegex.test(basename)) { + let replaced = 0; + let asset = compilation.assets[basename]; + let modFile = asset.source().replace(/(\[AIV\]{version}\[\/AIV\])/g, () => { + replaced++; + return this.context.version; + }); + asset.source = () => modFile; + log.info(`InjectByTag : match : ${basename} : replaced : ${replaced}`); + } + } + cb(); + }); + return new Promise((resolve, reject) => { resolve(); }) + } +} \ No newline at end of file diff --git a/src/components/inject-by-tag.ts b/src/components/inject-by-tag.ts deleted file mode 100644 index 8643461..0000000 --- a/src/components/inject-by-tag.ts +++ /dev/null @@ -1,37 +0,0 @@ -/// -const log = require('../core/log'); - -'use strict'; - -/** - * Inject version number into HTML - * - done by parsing html file, - * > replace: <{version}> - */ -class InjectByTag{ - - constructor(private context) {} - - apply() { - this.context.compiler.plugin('emit', (compilation, cb) => { - // for every output file - for ( var basename in compilation.assets ) { - // only if match regex - if(this.context.options.injectByTagFileRegex.test(basename)) { - let replaced = 0; - let asset = compilation.assets[basename]; - let modFile = asset.source().replace(/(\<\{version\}\>)/g, () => { - replaced++; - return this.context.version; - }); - asset.source = () => modFile; - log.info(`InjectByTag : match : ${basename} : replaced : ${replaced}`); - } - } - cb(); - }); - return new Promise((resolve, reject) => { resolve(); }) - } -} - -module.exports = InjectByTag; \ No newline at end of file diff --git a/src/config.js b/src/config.js index d2cd36b..8da763a 100644 --- a/src/config.js +++ b/src/config.js @@ -1,24 +1,16 @@ -module.exports = { - NAME : 'Auto Inject Version', - SHORT : 'AIV', - PATH_PACKAGE : './package.json', - NON_WEBPACK_COMPONENTS : [ - { - option : 'autoIncrease', - path : './components/auto-inc-version' +export default { + PACKAGE_JSON_PATH: './package.json', + components: { + AutoIncreaseVersion: true, + InjectAsComment: true, + InjectByTag: true + }, + componentsOptions: { + InjectByTag: { + fileRegex: /\.+/ } - ], - WEBPACK_COMPONENTS : [ - { - option : 'injectByTag', - path : './components/inject-by-tag' - }, - { - option : 'injectAsComment', - path : './components/inject-as-comment' - } - ], - LOGS_TEXT : { - AIS_START : 'Auto inject version started' + }, + LOGS_TEXT: { + AIS_START: 'Auto inject version started' } -} \ No newline at end of file +}; diff --git a/src/core/log.js b/src/core/log.js index 7926ba1..75b87bf 100644 --- a/src/core/log.js +++ b/src/core/log.js @@ -1,9 +1,8 @@ import config from 'config'; import chalk from 'chalk'; -import utils from 'core/utils'; +import { isArgv } from 'core/utils'; const endOfLine = require('os').EOL; - class Log{ logLevel = 3; // default 1 @@ -13,9 +12,9 @@ class Log{ } getLogLevel() { - if(u.isArgv('aiv-log-full')){ + if(isArgv('aiv-log-full')){ this.logLevel = 3; - }else if(u.isArgv('aiv-log-none')) { + }else if(isArgv('aiv-log-none')) { this.logLevel = 0; } } diff --git a/src/core/utils.js b/src/core/utils.js index 7c5f80c..4d158ad 100644 --- a/src/core/utils.js +++ b/src/core/utils.js @@ -1,24 +1,28 @@ -class Utils{ - - static isArgv(arg) { - return Boolean(process.argv.find(function(item) { - return item.substr(0, 2) === '--' && item.indexOf(arg) > -1; - })); - } - - /** - * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 - * @param obj1 - * @param obj2 - * @returns obj3 a new object based on obj1 and obj2 - */ - static merge(obj1,obj2){ - var obj3 = {}; - for (var attrname in obj1) { obj3[attrname] = obj1[attrname]; } - for (var attrname in obj2) { obj3[attrname] = obj2[attrname]; } - return obj3; - } +let argv = require('optimist').argv; +/** + * Get argv from webpack env[argv] + * Since webpack 2.0 we have to pass args by the env + * example: + * - webpack --config ./webpack.conf.js --env.patch + * @param arg + * @returns {boolean} + */ +export function isArgv(arg) { + return Boolean(argv.env[arg]); } -module.exports = Utils; \ No newline at end of file +/** + * Overwrites obj1's values with obj2's and adds obj2's if non existent in obj1 + * @param obj1 + * @param obj2 + * @returns obj3 a new object based on obj1 and obj2 + */ +export function merge(obj1,obj2){ + var obj3 = {}; + for (var attrname in obj1) { obj3[attrname] = obj1[attrname]; } + for (var attrname in obj2) { obj3[attrname] = obj2[attrname]; } + return obj3; +} + + diff --git a/src/main.js b/src/main.js index 24e910f..0153dcd 100644 --- a/src/main.js +++ b/src/main.js @@ -2,43 +2,56 @@ import chalk from 'chalk'; import fs from 'fs'; import path from 'path'; import config from 'config'; -import u from 'core/utils'; import log from 'core/log'; +import { merge, transform } from 'lodash'; + +// import sub components +import AutoIncreaseVersion from 'components/auto-increase-version'; +import InjectAsComment from 'components/inject-as-comment'; +import InjectByTag from 'components/inject-by-tag'; export default class WebpackAutoInject{ - /** - * Default options - */ - static options = { - autoIncrease: true, - injectAsComment: true, - injectByTag: true, - injectByTagFileRegex: /^index\.html$/ + static protectedConfig = { + NAME: 'Auto Inject Version', + SHORT: 'AIV', }; /** * Constructor, * called on webpack config load - * @param options + * @param userConfig - config from the webpack config file */ - constructor(options) { - this.options = u.merge(WebpackAutoInject.options, options); - let packageFile = JSON.parse(fs.readFileSync(path.normalize(config.PATH_PACKAGE), 'utf8')); + constructor(userConfig) { + this.setConfig(userConfig); + let packageFile = JSON.parse( + fs.readFileSync(path.resolve(this.config.PACKAGE_JSON_PATH), 'utf8') + ); this.version = packageFile.version; log.call('info', 'AIS_START'); this.executeNoneWebpackComponents(); } + setConfig(userConfig) { + this.config = merge(config, userConfig); + + // lets convert all components names to lowercase - to prevent issues + this.config.components = transform(this.config.components, function (result, val, key) { + result[key.toLowerCase()] = val; + }); + + this.config = merge(this.config, WebpackAutoInject.protectedConfig); + } + /** * Webpack apply call, * when webpack is initialized and * plugin has been called by webpack * @param compiler */ - apply(compiler) { + async apply(compiler) { this.compiler = compiler; - this.executeWebpackComponents(); + await this.executeWebpackComponents(); } /** @@ -46,9 +59,8 @@ export default class WebpackAutoInject{ * - runs as soon as possible, * > without waiting for webpack init */ - executeNoneWebpackComponents() { - this.executeComponents(config.NON_WEBPACK_COMPONENTS, () => { - }); + async executeNoneWebpackComponents() { + await this.executeComponent([AutoIncreaseVersion]); } /** @@ -56,9 +68,8 @@ export default class WebpackAutoInject{ * - runs when webpack is initialized * and plugins is called by webpack */ - executeWebpackComponents() { - this.executeComponents(config.WEBPACK_COMPONENTS, () => { - }); + async executeWebpackComponents() { + await this.executeComponent([InjectAsComment, InjectByTag]); } /** @@ -66,25 +77,30 @@ export default class WebpackAutoInject{ * - general layer for comp execution * - used for both, webpack and non webpack comp */ - executeComponents(components, done) { + async executeComponent(components) { // no more components, // finish - if(!components.length) { done(); return;} + if(!components.length) { + return; + } - // take first component - let comp = components.shift(); + // take first component class + let ComponentClass = components.shift(); // if component is disabled, call next component - if(!this.options[comp.option]) { - this.executeComponents(components, done); + if (!this.config.components[ComponentClass.componentName.toLowerCase()]) { + await this.executeComponent(components); return; } // execute component - let inst = new (require(comp.path))(this); - inst.apply().then(() => { - this.executeComponents(components, done); - }, (err) => {this.executeComponents(components, done);}) + let inst = new ComponentClass(this); + + // await for apply to finish + await inst.apply(); + + // call next tick + await this.executeComponent(components); } } \ No newline at end of file diff --git a/tools/webpack.conf.js b/tools/webpack.conf.js index ce0433f..1442415 100644 --- a/tools/webpack.conf.js +++ b/tools/webpack.conf.js @@ -5,17 +5,14 @@ import nodeExternals from 'webpack-node-externals'; export default { target: 'node', externals: [nodeExternals()], - entry: { - index: [ - './src/main.js' - ] - }, + entry: './src/main.js', resolve: { extensions: ['.js'] }, output: { - filename: '[name]-bundle.js', - path: path.resolve(process.cwd(), 'dist') + filename: 'WebpackAutoInjectVersion.js', + path: path.resolve(process.cwd(), 'dist'), + libraryTarget: 'umd' }, module: { // rules: [ From a158b4075c702adbb7e350831ca30e8dae2ce29e Mon Sep 17 00:00:00 2001 From: radswiat Date: Tue, 11 Apr 2017 00:15:51 +0100 Subject: [PATCH 3/3] Remove console logs --- demo/dist/index-bundle.js | 4 ++-- demo/webpack.conf.js | 2 +- dist/WebpackAutoInjectVersion.js | 7 ------- package.json | 2 +- 4 files changed, 4 insertions(+), 11 deletions(-) diff --git a/demo/dist/index-bundle.js b/demo/dist/index-bundle.js index e8a36be..4cc4449 100644 --- a/demo/dist/index-bundle.js +++ b/demo/dist/index-bundle.js @@ -1,4 +1,4 @@ -// [AIV] Build version: 0.2.12 +// [AIV] Build version: 0.5.1 /******/ (function(modules) { // webpackBootstrap /******/ // The module cache /******/ var installedModules = {}; @@ -71,7 +71,7 @@ /* 0 */ /***/ (function(module, exports) { -module.exports = "TitleMy awesome project | 0.2.12>" +module.exports = "TitleMy awesome project | 0.5.1>" /***/ }), /* 1 */ diff --git a/demo/webpack.conf.js b/demo/webpack.conf.js index 625c844..bdc05fc 100644 --- a/demo/webpack.conf.js +++ b/demo/webpack.conf.js @@ -1,5 +1,5 @@ var path = require('path'); -// Require WebpackAutoInject from npm installed modules ( prefered ) +// Require WebpackAutoInject from npm installed modules ( preferred ) // var WebpackAutoInject = require('webpack-auto-inject-version').default; // Require WebpackAutoInject from dist - dev purpose only ( do not use the below line ) var WebpackAutoInject = require('../dist/WebpackAutoInjectVersion').default; diff --git a/dist/WebpackAutoInjectVersion.js b/dist/WebpackAutoInjectVersion.js index 5afb4bb..5b82468 100644 --- a/dist/WebpackAutoInjectVersion.js +++ b/dist/WebpackAutoInjectVersion.js @@ -632,22 +632,15 @@ var InjectByTag = function () { value: function apply() { var _this = this; - console.log('------------------- INJECT BY TAG! ------------------'); this.context.compiler.plugin('emit', function (compilation, cb) { - console.log('------------------- INJECT BY TAG! APPLY! ------------------'); - console.log(compilation.assets); // for every output file for (var basename in compilation.assets) { - console.log(_chalk2.default.green.bold('=================')); - console.log(basename); // only if match regex - console.log(basename + ' is: ' + _this.context.config.componentsOptions.InjectByTag.fileRegex.test(basename)); if (_this.context.config.componentsOptions.InjectByTag.fileRegex.test(basename)) { (function () { var replaced = 0; var asset = compilation.assets[basename]; var modFile = asset.source().replace(/(\[AIV\]{version}\[\/AIV\])/g, function () { - console.log('replace?!'); replaced++; return _this.context.version; }); diff --git a/package.json b/package.json index 85d6a2c..5899c6f 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "webpack-auto-inject-version", - "version": "0.5.0", + "version": "0.5.1", "repository": "radswiat/webpack-auto-inject-version", "description": "Webpack plugin for auto inject version from package.json", "main": "dist/WebpackAutoInjectVersion.js",