diff --git a/.gitattributes b/.gitattributes new file mode 100644 index 0000000..eba1110 --- /dev/null +++ b/.gitattributes @@ -0,0 +1,2 @@ +# Auto detect text files and perform LF normalization +* text=auto \ No newline at end of file diff --git a/.gitignore b/.gitignore index 858e8b4..ca35e46 100644 --- a/.gitignore +++ b/.gitignore @@ -1,20 +1,7 @@ -## Ignore files and folders created by the OS - -# Windows -$RECYCLE.BIN/ -Thumbs.db - -# OSX -.DS_STORE/ - -## Ignore files and folders created by the IDE +## Ignore package folders -.vs/ -.ntvs_analysis.dat -bin/ -obj/ -dist/ +**/node_modules/ -## Ignore package folders +## Ignore build artifacts -node_modules/ \ No newline at end of file +/lib/ \ No newline at end of file diff --git a/.npmignore b/.npmignore new file mode 100644 index 0000000..084f97a --- /dev/null +++ b/.npmignore @@ -0,0 +1,16 @@ +## Ignore source files + +/src/ + +## Ignore example files + +/example/ + +## Ignore config files + +/.git/ +/.vscode/ +.gitattributes +.gitignore +.npmignore +tsconfig.json diff --git a/.vscode/settings.json b/.vscode/settings.json new file mode 100644 index 0000000..832574e --- /dev/null +++ b/.vscode/settings.json @@ -0,0 +1,18 @@ +// Place your settings in this file to overwrite default and user settings. +{ + // Configure glob patterns for excluding files and folders. + "files.exclude": { + ".vscode": true, + ".gitattributes": true, + ".gitignore": true, + ".npmignore": true, + "lib": true, + "**/node_modules": true + }, + + // When enabled, will trim trailing whitespace when you save a file. + "files.trimTrailingWhitespace": true, + + // Use the TypeScript version specified in package.json. + "typescript.tsdk": "./node_modules/typescript/lib" +} \ No newline at end of file diff --git a/.vscode/tasks.json b/.vscode/tasks.json new file mode 100644 index 0000000..926b1dd --- /dev/null +++ b/.vscode/tasks.json @@ -0,0 +1,10 @@ +{ + // See https://go.microsoft.com/fwlink/?LinkId=733558 + // for the documentation about the tasks.json format + "version": "0.1.0", + "command": "tsc", + "isShellCommand": true, + "args": ["-p", "."], + "showOutput": "silent", + "problemMatcher": "$tsc" +} \ No newline at end of file diff --git a/LICENSE b/LICENSE deleted file mode 100644 index 2b940db..0000000 --- a/LICENSE +++ /dev/null @@ -1,21 +0,0 @@ -The MIT License (MIT) - -Copyright (c) 2016 Thomas Darling - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. diff --git a/README.md b/README.md index 4419362..af54afa 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,145 @@ -# gulp-dependents +gulp-dependents +=============== Gulp plugin that tracks dependencies between files and adds any files that depend -on the files currently in the stream, thus enabling incremental build of `less`, -`scss` and `sass` files, with extensibility points to support other file types. +on the files currently in the stream, thus enabling incremental build of `pcss`, +`less`, `scss` and `sass` files, with extensibility points to support other file +types. -See `readme.md` in the `gulp-dependents` folder for more info. \ No newline at end of file +## Problem +Gulp makes it easy to build all your files, but as the code base grows, so does +the build time, significantly slowing down your workflow. The solution is +incremental building - i.e. to rebuild only the files that have actually changed. +Unfortunately Gulp is agnostic about the depenencies between your files, making +it hard to incrementally build files that depend on other files - it doesn't know, +that when a dependency changes, so does the files that depend on it. + +## Solution +This plugin tracks the dependencies of all the files that pass trough it, building +and maintaining an in-memory dependency tree describing the dependencies between +the files. For each file that passes through, it will add any files that directly +or indirectly depend on that file to the stream, thus ensuring that they will also +be rebuild. Combined with e.g. the [gulp-cached](https://www.npmjs.com/package/gulp-cached) +plugin, or the "since last run" option in Gulp 4, this enables fast and reliable +incremental builds. + +## Usage +This example shows how the plugin may be used to watch and incrementally build +`less` files. The `gulp-cached` plugin will pass all files through on the first +run, thus allowing `gulp-dependents` to set up the initial dependency graph. On +subsequent runs, only changed files will be passed through, and `gulp-dependents` +will then ensure that any dependent files are also pulled into the stream. + +```javascript + +var gulp = require('gulp'), + less = require('gulp-less'), + cached = require('gulp-cached'), + dependents = require('gulp-dependents'); + +gulp.task('watch', function() { + gulp.watch('src/**/*.less', ['build']); +}); + +gulp.task('build', function() { + return gulp + .src('src/**/*.less') + .pipe(cached('less')) + .pipe(dependents()) + .pipe(less()) + .pipe(gulp.dest('dist')) +}); + +``` + +Note that `gulp-cached` and `gulp-changed` have different behavior - `gulp-changed` +will *not* nessesarily pass all files through on first run. Instead, it compares the +timestamps of the source and destination files, and only pass through those that appear +to be different. This means, that you must clean your output folder every time your +watch task starts, as this plugin needs to process all files at least once, in order to +determine the initial dependency tree - it won't know a file depends on another, +until it has parsed its dependency statements at least once. + +## Support and limitations +Out of the box, this plugin supports `pcss`, `less`, `scss` and `sass` files, including +things like comma-separated path lists, import statements spanning multiple lines +and `url(...)` paths. For `sass`, which is the indent-based variant of the `scss` +syntax, support is limited to single-line statements. Also note, that due to the +way tracking is implemented, it is currently not be possible to support dependency +statements with glob patterns, referencing e.g. all files in a folder. + +## Configuration +For the file types supported out of the box, there's generally no need to +configure anything, but should the need arise, a parser configuration may be +passed to the plugin function. Note that the options are merged into the +default configuration, so if you only wish to override e.g. the `basePaths` +option for `scss` files, then simply specify only that property. + +The parser will apply each `RegExp` or `function` in the `parserSteps` array in +sequence, such that the first receives all the file content and may e.g. extract +whole dependency statements, and the second one may then extract the paths from +those statements. This design enables parsing of complex statements that e.g. +list multiple, comma-separated file paths. It also enables the use of externa +parsers, by specifying a function, which simply invokes the external parser to +get the dependency paths. + +```javascript + +// The parser configuration, in which keys represents file name +// extensions, including the dot, and values represent the config +// to use when parsing the file type. +var config = { + + ".scss": { + + // The sequence of RegExps and/or functions to use when parsing + // dependency paths from a source file. Each RegExp must have the + // 'gm' modifier and at least one capture group. Each function must + // accept a string and return an array of captured strings. The + // strings captured by each RegExp or function will be passed + // to the next, thus iteratively reducing the file content to an + // array of dependency file paths. + parserSteps: [ + + // PLEASE NOTE: + // The parser steps shown here are only meant as an example to + // illustrate the concept of the matching pipeline. + // The default config used for scss files is pure RegExp and + // reliably supports the full syntax of scss import statements. + + // Match the import statements and capture the text + // between '@import' and ';'. + /^\s*@import\s+(.+?);/gm, + + // Split the captured text on ',' to get each path. + function (text) { return text.split(","); }, + + // Match the balanced quotes and capture only the file path. + /"([^"]+)"|'([^']+)'/m + ], + + // The file name prefixes to try when looking for dependency + // files, if the syntax does not require them to be specified in + // dependency statements. This could be e.g. '_', which is often + // used as a naming convention for mixin files. + prefixes: ['_'], + + // The file name postfixes to try when looking for dependency + // files, if the syntax does not require them to be specified in + // dependency statements. This could be e.g. file name extensions. + postfixes: ['.scss', '.sass'], + + // The additional base paths to try when looking for dependency + // files referenced using relative paths. + basePaths: [], + } +}; + +// Pass the config object to the plugin function. +.pipe(dependents(config)) + +// You can also pass a second config argument to enable logging. +.pipe(dependents(config, { logDependents: true })) + +``` + +Enjoy, and please report any issues in the issue tracker :-) \ No newline at end of file diff --git a/examples/gulp-dependents-with-gulp-version-3/gulpfile.js b/example/gulp-3/gulpfile.js similarity index 80% rename from examples/gulp-dependents-with-gulp-version-3/gulpfile.js rename to example/gulp-3/gulpfile.js index 53bdbf8..ee0ae26 100644 --- a/examples/gulp-dependents-with-gulp-version-3/gulpfile.js +++ b/example/gulp-3/gulpfile.js @@ -1,19 +1,19 @@ var gulp = require("gulp"); var cached = require("gulp-cached"); -var dependents = require("../../gulp-dependents"); +var dependents = require("../../"); var debug = require("gulp-debug"); -// The parser configuration, in which keys represents file name +// The parser configuration, in which keys represents file name // extensions, including the dot, and values represent the config // to use when parsing the file type. var config = { ".scss": { - // The sequence of RegExps and/or functions to use when parsing + // The sequence of RegExps and/or functions to use when parsing // dependency paths from a source file. Each RegExp must have the // 'gm' modifier and at least one capture group. Each function must - // accept a string and return an array of captured strings. The + // accept a string and return an array of captured strings. The // strings captured by each RegExp or function will be passed // to the next, thus iteratively reducing the file content to an // array of dependency file paths. @@ -25,52 +25,53 @@ var config = // for scss files is pure RegExp and reliably supports the // full syntax for import statements. - // Match the import statements and capture the text + // Match the import statements and capture the text // between "@import" and ";". /^\s*@import\s+(.+?);/gm, - // Split the captured text on "," to get each path. + // Split the captured text on "," to get each path. function (text) { return text.split(","); }, // Match the balanced quotes and capture only the file path. /"([^"]+)"|'([^']+)'/gm ], - + // The file name prefixes to try when looking for dependency // files, if the syntax does not require them to be specified in // dependency statements. This could be e.g. '_', which is often // used as a naming convention for mixin files. prefixes: ["_"], - + // The file name postfixes to try when looking for dependency // files, if the syntax does not require them to be specified in // dependency statements. This could be e.g. file name extensions. postfixes: [".scss"], - + // The additional base paths to try when looking for dependency // files referenced using relative paths. - basePaths: [], + basePaths: ["source"], } }; -gulp.task("watch.styles", function () { - - return gulp.watch('styles/**/*.scss', ['build.styles']); -}); - -gulp.task("build.styles", function () { +gulp.task("build", function () +{ return gulp // Get all source files. - .src("styles/**/*.scss") - + .src("source/**/*.scss") + // On first run, this will pass through all files. // On subsequent runs, only changed files will be passed through. .pipe(cached("scss")) // Add any dependent files to the stream. - .pipe(dependents(config, { logDependents: true, logDependencyMap: true })) + .pipe(dependents(config, { logDependents: true, logDependencyMap: false })) // For debugging, just output the name of each file we're about to build. - .pipe(debug({ title: "[build.styles]" })); + .pipe(debug({ title: "[build]" })); +}); + +gulp.task("watch", function () +{ + return gulp.watch('source/**/*.scss', ['build']); }); \ No newline at end of file diff --git a/examples/gulp-dependents-with-gulp-version-3/package.json b/example/gulp-3/package.json similarity index 100% rename from examples/gulp-dependents-with-gulp-version-3/package.json rename to example/gulp-3/package.json diff --git a/examples/gulp-dependents-with-gulp-version-4/styles/styles.scss b/example/gulp-3/source/app/styles.scss similarity index 79% rename from examples/gulp-dependents-with-gulp-version-4/styles/styles.scss rename to example/gulp-3/source/app/styles.scss index e0ea01e..924287d 100644 --- a/examples/gulp-dependents-with-gulp-version-4/styles/styles.scss +++ b/example/gulp-3/source/app/styles.scss @@ -1,4 +1,4 @@ -@import "mixin"; +@import "lib/mixin"; html, body { diff --git a/examples/gulp-dependents-with-gulp-version-3/styles/mixin.scss b/example/gulp-3/source/lib/mixin.scss similarity index 100% rename from examples/gulp-dependents-with-gulp-version-3/styles/mixin.scss rename to example/gulp-3/source/lib/mixin.scss diff --git a/examples/gulp-dependents-with-gulp-version-4/gulpfile.js b/example/gulp-4/gulpfile.js similarity index 78% rename from examples/gulp-dependents-with-gulp-version-4/gulpfile.js rename to example/gulp-4/gulpfile.js index 13aa39a..5d215a0 100644 --- a/examples/gulp-dependents-with-gulp-version-4/gulpfile.js +++ b/example/gulp-4/gulpfile.js @@ -1,72 +1,72 @@ var gulp = require("gulp"); -var dependents = require("../../gulp-dependents"); +var dependents = require("../../"); var debug = require("gulp-debug"); -// The parser configuration, in which keys represents file name +// The parser configuration, in which keys represents file name // extensions, including the dot, and values represent the config // to use when parsing the file type. var config = { ".scss": - { - // The sequence of RegExps and/or functions to use when parsing + { + // The sequence of RegExps and/or functions to use when parsing // dependency paths from a source file. Each RegExp must have the // 'gm' modifier and at least one capture group. Each function must - // accept a string and return an array of captured strings. The + // accept a string and return an array of captured strings. The // strings captured by each RegExp or function will be passed // to the next, thus iteratively reducing the file content to an // array of dependency file paths. parserSteps: - [ + [ // Please note: // The parser steps shown here are only meant to illustrate // the concept of a matching pipeline. The actual config used // for scss files is pure RegExp and reliably supports the // full syntax for import statements. - // Match the import statements and capture the text + // Match the import statements and capture the text // between "@import" and ";". /^\s*@import\s+(.+?);/gm, - // Split the captured text on "," to get each path. + // Split the captured text on "," to get each path. function (text) { return text.split(","); }, // Match the balanced quotes and capture only the file path. /"([^"]+)"|'([^']+)'/gm ], - + // The file name prefixes to try when looking for dependency // files, if the syntax does not require them to be specified in // dependency statements. This could be e.g. '_', which is often // used as a naming convention for mixin files. prefixes: ["_"], - + // The file name postfixes to try when looking for dependency // files, if the syntax does not require them to be specified in // dependency statements. This could be e.g. file name extensions. postfixes: [".scss"], - + // The additional base paths to try when looking for dependency // files referenced using relative paths. - basePaths: [], + basePaths: ["source"], } }; -gulp.task("watch.styles", function () -{ - gulp.watch("styles/**/*.scss", gulp.series("build.styles")); -}); - -gulp.task("build.styles", function () +gulp.task("build", function () { return gulp // Get all source files. - .src("styles/**/*.scss", { since: gulp.lastRun('build.styles') }) - + .src("source/**/*.scss", { since: gulp.lastRun('build') }) + // Add any dependent files to the stream. - .pipe(dependents(config, { logDependents: true, logDependencyMap: true })) + .pipe(dependents(config, { logDependents: true, logDependencyMap: false })) // For debugging, just output the name of each file we're about to build. - .pipe(debug({ title: "[build.styles]" })); + .pipe(debug({ title: "[build]" })); +}); + +gulp.task("watch", function () +{ + gulp.watch("source/**/*.scss", gulp.series("build")); }); \ No newline at end of file diff --git a/examples/gulp-dependents-with-gulp-version-4/package.json b/example/gulp-4/package.json similarity index 89% rename from examples/gulp-dependents-with-gulp-version-4/package.json rename to example/gulp-4/package.json index 8082388..0cca104 100644 --- a/examples/gulp-dependents-with-gulp-version-4/package.json +++ b/example/gulp-4/package.json @@ -19,7 +19,9 @@ "type": "git", "url": "https://github.com/thomas-darling/gulp-dependents.git" }, - "dependencies": { }, + "dependencies": { + "gulp": "git://github.com/gulpjs/gulp.git#4.0" + }, "devDependencies": { "gulp": "git://github.com/gulpjs/gulp.git#4.0", "gulp-debug": "2.1.2" diff --git a/examples/gulp-dependents-with-gulp-version-3/styles/styles.scss b/example/gulp-4/source/app/styles.scss similarity index 79% rename from examples/gulp-dependents-with-gulp-version-3/styles/styles.scss rename to example/gulp-4/source/app/styles.scss index e0ea01e..924287d 100644 --- a/examples/gulp-dependents-with-gulp-version-3/styles/styles.scss +++ b/example/gulp-4/source/app/styles.scss @@ -1,4 +1,4 @@ -@import "mixin"; +@import "lib/mixin"; html, body { diff --git a/examples/gulp-dependents-with-gulp-version-4/styles/mixin.scss b/example/gulp-4/source/lib/mixin.scss similarity index 100% rename from examples/gulp-dependents-with-gulp-version-4/styles/mixin.scss rename to example/gulp-4/source/lib/mixin.scss diff --git a/examples/gulp-dependents-with-gulp-version-3/gulp-dependents-with-gulp-version-3.njsproj b/examples/gulp-dependents-with-gulp-version-3/gulp-dependents-with-gulp-version-3.njsproj deleted file mode 100644 index 6c54a52..0000000 --- a/examples/gulp-dependents-with-gulp-version-3/gulp-dependents-with-gulp-version-3.njsproj +++ /dev/null @@ -1,89 +0,0 @@ - - - - 11.0 - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - gulp-dependents-with-gulp-version-3 - gulp-dependent-examples - - - - Debug - 2.0 - 072c4309-9caa-44cb-ad9e-b6286f5c0e82 - - - - - False - - - . - . - v4.0 - {3AF33F2E-1136-4D97-BBB7-1795711AC8B8};{9092AA53-FB77-4645-B42D-1CCCA6BD08BD} - ProjectFiles - true - CommonJS - true - false - - - true - - - true - - - - - - - - - - - - - - - - - - - - False - True - 0 - / - http://localhost:48022/ - False - True - http://localhost:1337 - False - - - - - - - CurrentPage - True - False - False - False - - - - - - - - - False - False - - - - - \ No newline at end of file diff --git a/examples/gulp-dependents-with-gulp-version-4/gulp-dependents-with-gulp-version-4.njsproj b/examples/gulp-dependents-with-gulp-version-4/gulp-dependents-with-gulp-version-4.njsproj deleted file mode 100644 index 497c7fd..0000000 --- a/examples/gulp-dependents-with-gulp-version-4/gulp-dependents-with-gulp-version-4.njsproj +++ /dev/null @@ -1,89 +0,0 @@ - - - - 11.0 - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - gulp-dependents-with-gulp-version-4 - gulp-dependent-examples - - - - Debug - 2.0 - 68bb77c2-aab6-4973-b2d3-8d8507fead99 - - - - - False - - - . - . - v4.0 - {3AF33F2E-1136-4D97-BBB7-1795711AC8B8};{9092AA53-FB77-4645-B42D-1CCCA6BD08BD} - ProjectFiles - true - CommonJS - true - false - - - true - - - true - - - - - - - - - - - - - - - - - - - - False - True - 0 - / - http://localhost:48022/ - False - True - http://localhost:1337 - False - - - - - - - CurrentPage - True - False - False - False - - - - - - - - - False - False - - - - - \ No newline at end of file diff --git a/gulp-dependents.sln b/gulp-dependents.sln deleted file mode 100644 index 289625e..0000000 --- a/gulp-dependents.sln +++ /dev/null @@ -1,40 +0,0 @@ - -Microsoft Visual Studio Solution File, Format Version 12.00 -# Visual Studio 14 -VisualStudioVersion = 14.0.24720.0 -MinimumVisualStudioVersion = 10.0.40219.1 -Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "gulp-dependents", "gulp-dependents\gulp-dependents.njsproj", "{B1433A41-7DAB-4C43-9A3B-CF16ACA21EB6}" -EndProject -Project("{2150E333-8FDC-42A3-9474-1A3956D46DE8}") = "examples", "examples", "{EAA05BDE-F757-48DA-9923-029E28D2F4A2}" -EndProject -Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "gulp-dependents-with-gulp-version-4", "examples\gulp-dependents-with-gulp-version-4\gulp-dependents-with-gulp-version-4.njsproj", "{68BB77C2-AAB6-4973-B2D3-8D8507FEAD99}" -EndProject -Project("{9092AA53-FB77-4645-B42D-1CCCA6BD08BD}") = "gulp-dependents-with-gulp-version-3", "examples\gulp-dependents-with-gulp-version-3\gulp-dependents-with-gulp-version-3.njsproj", "{072C4309-9CAA-44CB-AD9E-B6286F5C0E82}" -EndProject -Global - GlobalSection(SolutionConfigurationPlatforms) = preSolution - Debug|Any CPU = Debug|Any CPU - Release|Any CPU = Release|Any CPU - EndGlobalSection - GlobalSection(ProjectConfigurationPlatforms) = postSolution - {B1433A41-7DAB-4C43-9A3B-CF16ACA21EB6}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {B1433A41-7DAB-4C43-9A3B-CF16ACA21EB6}.Debug|Any CPU.Build.0 = Debug|Any CPU - {B1433A41-7DAB-4C43-9A3B-CF16ACA21EB6}.Release|Any CPU.ActiveCfg = Release|Any CPU - {B1433A41-7DAB-4C43-9A3B-CF16ACA21EB6}.Release|Any CPU.Build.0 = Release|Any CPU - {68BB77C2-AAB6-4973-B2D3-8D8507FEAD99}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {68BB77C2-AAB6-4973-B2D3-8D8507FEAD99}.Debug|Any CPU.Build.0 = Debug|Any CPU - {68BB77C2-AAB6-4973-B2D3-8D8507FEAD99}.Release|Any CPU.ActiveCfg = Release|Any CPU - {68BB77C2-AAB6-4973-B2D3-8D8507FEAD99}.Release|Any CPU.Build.0 = Release|Any CPU - {072C4309-9CAA-44CB-AD9E-B6286F5C0E82}.Debug|Any CPU.ActiveCfg = Debug|Any CPU - {072C4309-9CAA-44CB-AD9E-B6286F5C0E82}.Debug|Any CPU.Build.0 = Debug|Any CPU - {072C4309-9CAA-44CB-AD9E-B6286F5C0E82}.Release|Any CPU.ActiveCfg = Release|Any CPU - {072C4309-9CAA-44CB-AD9E-B6286F5C0E82}.Release|Any CPU.Build.0 = Release|Any CPU - EndGlobalSection - GlobalSection(SolutionProperties) = preSolution - HideSolutionNode = FALSE - EndGlobalSection - GlobalSection(NestedProjects) = preSolution - {68BB77C2-AAB6-4973-B2D3-8D8507FEAD99} = {EAA05BDE-F757-48DA-9923-029E28D2F4A2} - {072C4309-9CAA-44CB-AD9E-B6286F5C0E82} = {EAA05BDE-F757-48DA-9923-029E28D2F4A2} - EndGlobalSection -EndGlobal diff --git a/gulp-dependents/.npmignore b/gulp-dependents/.npmignore deleted file mode 100644 index 3364ac5..0000000 --- a/gulp-dependents/.npmignore +++ /dev/null @@ -1,7 +0,0 @@ -src/ -node_modules/ -typings/ -bin/ -obj/ -*.dat -*.njsproj \ No newline at end of file diff --git a/gulp-dependents/gulp-dependents.njsproj b/gulp-dependents/gulp-dependents.njsproj deleted file mode 100644 index 40b3b7e..0000000 --- a/gulp-dependents/gulp-dependents.njsproj +++ /dev/null @@ -1,120 +0,0 @@ - - - - 11.0 - $(MSBuildExtensionsPath32)\Microsoft\VisualStudio\v$(VisualStudioVersion) - gulp-dependents - gulp-dependents - - - - Debug - 2.0 - b1433a41-7dab-4c43-9a3b-cf16aca21eb6 - - - - - False - - - . - . - v4.0 - {3AF33F2E-1136-4D97-BBB7-1795711AC8B8};{9092AA53-FB77-4645-B42D-1CCCA6BD08BD} - ProjectFiles - true - CommonJS - true - false - - - true - - - true - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - ES5 - None - True - False - CommonJS - True - - dist - False - True - - - - False - - - - - - - - False - True - 0 - / - http://localhost:48022/ - False - True - http://localhost:1337 - False - - - - - - - CurrentPage - True - False - False - False - - - - - - - - - False - False - - - - - \ No newline at end of file diff --git a/gulp-dependents/readme.md b/gulp-dependents/readme.md deleted file mode 100644 index cbad1a6..0000000 --- a/gulp-dependents/readme.md +++ /dev/null @@ -1,167 +0,0 @@ -gulp-dependents -=============== -Gulp plugin that tracks dependencies between files and adds any files that depend -on the files currently in the stream, thus enabling incremental build of `pcss`, -`less`, `scss` and `sass` files, with extensibility points to support other file -types. - -## Problem -Gulp makes it easy to build all your files, but as the code base grows, so does -the build time, significantly slowing down your workflow. The solution is -incremental building - i.e. to rebuild only the files that have actually changed. -Unfortunately Gulp is agnostic about the depenencies between your files, making -it hard to incrementally build files that depend on other files - it doesn't know, -that when a dependency changes, so does the files that depend on it. - -## Solution -This plugin tracks the dependencies of all the files that pass trough it, building -and maintaining an in-memory dependency tree describing the dependencies between -the files. For each file that passes through, it will add any files that directly -or indirectly depend on that file to the stream, thus ensuring that they will also -be rebuild. Combined with e.g. the [gulp-cached](https://www.npmjs.com/package/gulp-cached) -plugin, or the "since last run" option in Gulp 4, this enables fast and reliable -incremental builds. - -## Usage -This example shows how the plugin may be used to watch and incrementally build -`less` files. The `gulp-cached` plugin will pass all files through on the first -run, thus allowing `gulp-dependents` to set up the initial dependency graph. On -subsequent runs, only changed files will be passed through, and `gulp-dependents` -will then ensure that any dependent files are also pulled into the stream. - -```javascript - -var gulp = require('gulp'), - less = require('gulp-less'), - cached = require('gulp-cached'), - dependents = require('gulp-dependents'); - -gulp.task('watch.less', function() { - gulp.watch('src/**/*.less', ['build.less']); -}); - -gulp.task('build.less', function() { - return gulp - .src('src/**/*.less') - .pipe(cached('less')) - .pipe(dependents()) - .pipe(less()) - .pipe(gulp.dest('dist')) -}); - -``` - -Note that `gulp-cached` and `gulp-changed` have different behavior - `gulp-changed` -will *not* nessesarily pass all files through on first run. Instead, it compares the -timestamps of the source and destination files, and only pass through those that appear -to be different. This means, that you must clean your output folder every time your -watch task starts, as this plugin needs to process all files at least once, in order to -determine the initial dependency tree - it won't know a file depends on another, -until it has parsed its dependency statements at least once. - -## Support and limitations -Out of the box, this plugin supports `pcss`, `less`, `scss` and `sass` files, including -things like comma-separated path lists, import statements spanning multiple lines -and `url(...)` paths. For `sass`, which is the indent-based variant of the `scss` -syntax, support is limited to single-line statements. Also note, that due to the -way tracking is implemented, it is currently not be possible to support dependency -statements with glob patterns, referencing e.g. all files in a folder. - -## Configuration -For the file types supported out of the box, there's generally no need to -configure anything, but should the need arise, a parser configuration may be -passed to the plugin function. Note that the options are merged into the -default configuration, so if you only wish to override e.g. the `basePaths` -option for `scss` files, then simply specify only that property. - -The parser will apply each `RegExp` or `function` in the `parserSteps` array in -sequence, such that the first receives all the file content and may e.g. extract -whole dependency statements, and the second one may then extract the paths from -those statements. This design enables parsing of complex statements that e.g. -list multiple, comma-separated file paths. It also enables the use of externa -parsers, by specifying a function, which simply invokes the external parser to -get the dependency paths. - -```javascript - -// The parser configuration, in which keys represents file name -// extensions, including the dot, and values represent the config -// to use when parsing the file type. -var config = { - - ".scss": { - - // The sequence of RegExps and/or functions to use when parsing - // dependency paths from a source file. Each RegExp must have the - // 'gm' modifier and at least one capture group. Each function must - // accept a string and return an array of captured strings. The - // strings captured by each RegExp or function will be passed - // to the next, thus iteratively reducing the file content to an - // array of dependency file paths. - parserSteps: [ - - // PLEASE NOTE: - // The parser steps shown here are only meant as an example to - // illustrate the concept of the matching pipeline. - // The default config used for scss files is pure RegExp and - // reliably supports the full syntax of scss import statements. - - // Match the import statements and capture the text - // between '@import' and ';'. - /^\s*@import\s+(.+?);/gm, - - // Split the captured text on ',' to get each path. - function (text) { return text.split(","); }, - - // Match the balanced quotes and capture only the file path. - /"([^"]+)"|'([^']+)'/m - ], - - // The file name prefixes to try when looking for dependency - // files, if the syntax does not require them to be specified in - // dependency statements. This could be e.g. '_', which is often - // used as a naming convention for mixin files. - prefixes: ['_'], - - // The file name postfixes to try when looking for dependency - // files, if the syntax does not require them to be specified in - // dependency statements. This could be e.g. file name extensions. - postfixes: ['.scss', '.sass'], - - // The additional base paths to try when looking for dependency - // files referenced using relative paths. - basePaths: [], - } -}; - -// Pass the config object to the plugin function. -.pipe(dependents(config)) - -// You can also pass a second config argument to enable logging. -.pipe(dependents(config, { logDependents: true })) - -``` - -## Why this plugin? -There exist a couple of other plugins similar to this, also trying to solve the -incremental build problem. Unfortunately, in our experience, none of them seem -to do so reliably, and when they fail, it is often in subtle ways, such as: - -* Failing to correctly normalize file paths on both Windows and Unix platforms. - -* Failing to correctly support the full syntax for dependency statements in `less` - and `scss` files, or relying on outdated versions of e.g. the `less` parser. - -* Failing to correctly update the dependency tree when import statements or - files are removed, thus building files unnessesarily or crashing due to - missing files. - -* Failing to correctly track dependencies when a dependency file is referenced - in an import statement, before the file is actually created in the file system. - -* Failing to correctly track dependencies when e.g a prefix or file name extension - is added or removed in either the file name or the import statement. - -You have to be able to trust your build system to stay sane, and thats why this -plugin was developed - to make sure all of those things were handled correctly. -That said, if you do find any issues, please report them in the issue tracker :-) \ No newline at end of file diff --git a/gulp-dependents/src/Plugin.ts b/gulp-dependents/src/Plugin.ts deleted file mode 100644 index b0acac3..0000000 --- a/gulp-dependents/src/Plugin.ts +++ /dev/null @@ -1,76 +0,0 @@ -import * as util from "gulp-util"; -import * as path from "path"; -import * as through from "through2"; -import PluginConfig from "./PluginConfig"; -import DependencyParser from "./DependencyParser"; -import DependencyTracker from "./DependencyTracker"; - -/** - * Represents the plugin. - */ -export default class Plugin -{ - /** - * The static dependency tracker instance. - */ - private static dependencyTracker: DependencyTracker; - - /** - * Creates a new instance of the plugin. - * @param parserConfig The parser configuration use, null, undefined or empty string to use the default configuration, or an instance of a custom IDependencyParser. - * @param pluginConfig The debug configuration use, or null or undefined to disable all debug options. - */ - public static run(parserConfig?: {}, pluginConfig?: PluginConfig) - { - // Get or create the debug options. - if (!pluginConfig) - { - pluginConfig = new PluginConfig(); - } - - // Get or create the dependency parser and tracker. - - if (Plugin.dependencyTracker == null) - { - Plugin.dependencyTracker = new DependencyTracker(new DependencyParser(parserConfig)); - } - - // Return the stream transform. - return through.obj( - function (file: util.File, encoding, callback) - { - // Get the files that depend on the current file. - let dependentFiles = Plugin.dependencyTracker.updateAndGetDependents(file, encoding); - - // Should we log the dependents to the console? - if (dependentFiles != null && pluginConfig.logDependents) - { - Plugin.dependencyTracker.logDependents(path.normalize(file.path), true, process.cwd()); - } - - // Push the current file to the stream. - this.push(file); - - // If the current file is tracked, add its dependents to the stream. - if (dependentFiles != null) - { - for (let dependentFile of dependentFiles) - { - this.push(dependentFile); - } - } - - callback(); - }, - function (callback) - { - // Should we log the dependency map to the console? - if (pluginConfig.logDependencyMap) - { - Plugin.dependencyTracker.logDependencyMap(process.cwd()); - } - - callback(); - }); - } -} diff --git a/gulp-dependents/typings/chalk/chalk.d.ts b/gulp-dependents/typings/chalk/chalk.d.ts deleted file mode 100644 index ede2947..0000000 --- a/gulp-dependents/typings/chalk/chalk.d.ts +++ /dev/null @@ -1,93 +0,0 @@ -// Type definitions for chalk v0.4.0 -// Project: https://github.com/sindresorhus/chalk -// Definitions by: Diullei Gomes , Bart van der Schoor -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -declare module Chalk { - export interface ChalkModule extends ChalkStyle { - enabled: boolean; - supportsColor: boolean; - styles: ChalkStyleMap; - - stripColor(value: string): any; - hasColor(str: string): boolean; - } - - export interface ChalkChain extends ChalkStyle { - (...text: string[]): ChalkChain; - } - - export interface ChalkStyleElement { - open: string; - close: string; - } - - export interface ChalkStyle { - // General - reset: ChalkChain; - bold: ChalkChain; - italic: ChalkChain; - underline: ChalkChain; - inverse: ChalkChain; - strikethrough: ChalkChain; - - // Text colors - black: ChalkChain; - red: ChalkChain; - green: ChalkChain; - yellow: ChalkChain; - blue: ChalkChain; - magenta: ChalkChain; - cyan: ChalkChain; - white: ChalkChain; - gray: ChalkChain; - grey: ChalkChain; - - // Background colors - bgBlack: ChalkChain; - bgRed: ChalkChain; - bgGreen: ChalkChain; - bgYellow: ChalkChain; - bgBlue: ChalkChain; - bgMagenta: ChalkChain; - bgCyan: ChalkChain; - bgWhite: ChalkChain; - } - - export interface ChalkStyleMap { - // General - reset: ChalkStyleElement; - bold: ChalkStyleElement; - italic: ChalkStyleElement; - underline: ChalkStyleElement; - inverse: ChalkStyleElement; - strikethrough: ChalkStyleElement; - - // Text colors - black: ChalkStyleElement; - red: ChalkStyleElement; - green: ChalkStyleElement; - yellow: ChalkStyleElement; - blue: ChalkStyleElement; - magenta: ChalkStyleElement; - cyan: ChalkStyleElement; - white: ChalkStyleElement; - gray: ChalkStyleElement; - - // Background colors - bgBlack: ChalkStyleElement; - bgRed: ChalkStyleElement; - bgGreen: ChalkStyleElement; - bgYellow: ChalkStyleElement; - bgBlue: ChalkStyleElement; - bgMagenta: ChalkStyleElement; - bgCyan: ChalkStyleElement; - bgWhite: ChalkStyleElement; - } -} - -declare module "chalk" { - var ch: Chalk.ChalkModule; - export = ch; -} - diff --git a/gulp-dependents/typings/gulp-util/gulp-util.d.ts b/gulp-dependents/typings/gulp-util/gulp-util.d.ts deleted file mode 100644 index 33ea20f..0000000 --- a/gulp-dependents/typings/gulp-util/gulp-util.d.ts +++ /dev/null @@ -1,138 +0,0 @@ -// Type definitions for gulp-util v3.0.x -// Project: https://github.com/gulpjs/gulp-util -// Definitions by: jedmao -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/// -/// -/// -/// - -declare module 'gulp-util' { - - import vinyl = require('vinyl'); - import chalk = require('chalk'); - import through2 = require('through2'); - - export class File extends vinyl { } - - /** - * Replaces a file extension in a path. Returns the new path. - */ - export function replaceExtension(npath: string, ext: string): string; - - export var colors: typeof chalk; - - export var date: { - (now?: Date, mask?: string, convertLocalTimeToUTC?: boolean): any; - (date?: string, mask?: string, convertLocalTimeToUTC?: boolean): any; - masks: any; - }; - - /** - * Logs stuff. Already prefixed with [gulp] and all that. Use the right colors - * for values. If you pass in multiple arguments it will join them by a space. - */ - export function log(message?: any, ...optionalParams: any[]): void; - - /** - * This is a lodash.template function wrapper. You must pass in a valid gulp - * file object so it is available to the user or it will error. You can not - * configure any of the delimiters. Look at the lodash docs for more info. - */ - export function template(tmpl: string): (opt: { file: { path: string } }) => string; - export function template(tmpl: string, opt: { file: { path: string } }): string; - - export var env: any; - - export function beep(): void; - - /** - * Returns a stream that does nothing but pass data straight through. - */ - export var noop: typeof through2; - - export function isStream(obj: any): boolean; - - export function isBuffer(obj: any): boolean; - - export function isNull(obj: any): boolean; - - export var linefeed: string; - - export function combine(streams: NodeJS.ReadWriteStream[]): () => NodeJS.ReadWriteStream; - export function combine(...streams: NodeJS.ReadWriteStream[]): () => NodeJS.ReadWriteStream; - - /** - * This is similar to es.wait but instead of buffering text into one string - * it buffers anything into an array (so very useful for file objects). - */ - export function buffer(cb?: (err: Error, data: any[]) => void): NodeJS.ReadWriteStream; - - export class PluginError implements Error, PluginErrorOptions { - constructor(options?: PluginErrorOptions); - constructor(pluginName: string, options?: PluginErrorOptions); - constructor(pluginName: string, message: string, options?: PluginErrorOptions); - constructor(pluginName: string, message: Error, options?: PluginErrorOptions); - /** - * The module name of your plugin. - */ - name: string; - /** - * Can be a string or an existing error. - */ - message: any; - fileName: string; - lineNumber: number; - /** - * You need to include the message along with this stack. If you pass an - * error in as the message the stack will be pulled from that, otherwise one - * will be created. - */ - stack: string; - /** - * By default the stack will not be shown. Set this to true if you think the - * stack is important for your error. - */ - showStack: boolean; - /** - * Error properties will be included in err.toString(). Can be omitted by - * setting this to false. - */ - showProperties: boolean; - plugin: string; - error: Error; - } - -} - -interface PluginErrorOptions { - /** - * The module name of your plugin. - */ - name?: string; - /** - * Can be a string or an existing error. - */ - message?: any; - fileName?: string; - lineNumber?: number; - /** - * You need to include the message along with this stack. If you pass an - * error in as the message the stack will be pulled from that, otherwise one - * will be created. - */ - stack?: string; - /** - * By default the stack will not be shown. Set this to true if you think the - * stack is important for your error. - */ - showStack?: boolean; - /** - * Error properties will be included in err.toString(). Can be omitted by - * setting this to false. - */ - showProperties?: boolean; - plugin?: string; - error?: Error; -} diff --git a/gulp-dependents/typings/node/node.d.ts b/gulp-dependents/typings/node/node.d.ts deleted file mode 100644 index 5a163f0..0000000 --- a/gulp-dependents/typings/node/node.d.ts +++ /dev/null @@ -1,2088 +0,0 @@ -// Type definitions for Node.js v4.x -// Project: http://nodejs.org/ -// Definitions by: Microsoft TypeScript , DefinitelyTyped -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/************************************************ -* * -* Node.js v4.x API * -* * -************************************************/ - -interface Error { - stack?: string; -} - - -// compat for TypeScript 1.5.3 -// 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.5.3. -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 -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; - /** - * Allocates a new buffer containing the given {array} of octets. - * - * @param array The octets to store. - */ - new (array: any[]): Buffer; - prototype: 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; -}; - -/************************************************ -* * -* GLOBAL INTERFACES * -* * -************************************************/ -declare module NodeJS { - export interface ErrnoException extends Error { - errno?: number; - code?: string; - path?: string; - syscall?: string; - stack?: string; - } - - export interface EventEmitter { - addListener(event: string, listener: Function): EventEmitter; - on(event: string, listener: Function): EventEmitter; - once(event: string, listener: Function): EventEmitter; - removeListener(event: string, listener: Function): EventEmitter; - removeAllListeners(event?: string): EventEmitter; - setMaxListeners(n: number): void; - listeners(event: string): Function[]; - emit(event: string, ...args: any[]): boolean; - } - - export interface ReadableStream extends EventEmitter { - readable: boolean; - read(size?: number): string|Buffer; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - 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 {} - - export interface Process extends EventEmitter { - stdout: WritableStream; - stderr: WritableStream; - stdin: ReadableStream; - argv: string[]; - execPath: string; - abort(): void; - chdir(directory: string): void; - cwd(): string; - env: any; - exit(code?: number): void; - getgid(): number; - setgid(id: number): void; - setgid(id: string): void; - getuid(): number; - setuid(id: number): void; - setuid(id: string): void; - version: string; - versions: { - http_parser: string; - node: string; - v8: string; - ares: string; - uv: string; - zlib: string; - openssl: string; - }; - 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): void; - pid: number; - title: string; - arch: string; - platform: string; - memoryUsage(): { rss: number; heapTotal: number; heapUsed: number; }; - nextTick(callback: Function): void; - umask(mask?: number): number; - uptime(): number; - hrtime(time?:number[]): number[]; - - // Worker - send?(message: any, sendHandle?: any): void; - } - - 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; - } -} - -/** - * @deprecated - */ -interface NodeBuffer { - [index: number]: number; - write(string: string, offset?: number, length?: number, encoding?: string): number; - toString(encoding?: string, start?: number, end?: number): string; - toJSON(): any; - length: number; - equals(otherBuffer: Buffer): boolean; - compare(otherBuffer: Buffer): 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, noAsset?: 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; - 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): Buffer; -} - -/************************************************ -* * -* MODULES * -* * -************************************************/ -declare module "buffer" { - export var INSPECT_MAX_BYTES: number; -} - -declare module "querystring" { - export function stringify(obj: any, sep?: string, eq?: string): string; - export function parse(str: string, sep?: string, eq?: string, options?: { maxKeys?: number; }): any; - export function escape(str: string): string; - export function unescape(str: string): string; -} - -declare module "events" { - export class EventEmitter implements NodeJS.EventEmitter { - static listenerCount(emitter: EventEmitter, event: string): number; - - addListener(event: string, listener: Function): EventEmitter; - on(event: string, listener: Function): EventEmitter; - once(event: string, listener: Function): EventEmitter; - removeListener(event: string, listener: Function): EventEmitter; - removeAllListeners(event?: string): EventEmitter; - setMaxListeners(n: number): void; - listeners(event: string): Function[]; - emit(event: string, ...args: any[]): boolean; - } -} - -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; - } - - export interface Server extends events.EventEmitter { - listen(port: number, hostname?: string, backlog?: number, callback?: Function): Server; - listen(port: number, hostname?: string, callback?: Function): Server; - listen(path: string, callback?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - close(cb?: any): Server; - address(): { port: number; family: string; address: string; }; - maxHeadersCount: number; - } - /** - * @deprecated Use IncomingMessage - */ - export interface ServerRequest extends IncomingMessage { - connection: net.Socket; - } - export interface ServerResponse extends events.EventEmitter, 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; - setHeader(name: string, value: string): void; - sendDate: boolean; - getHeader(name: string): string; - removeHeader(name: string): void; - write(chunk: any, encoding?: string): any; - 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 ClientRequest extends events.EventEmitter, 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; - - // 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 events.EventEmitter, stream.Readable { - httpVersion: string; - 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; - } - /** - * @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"; - - export interface ClusterSettings { - exec?: string; - args?: string[]; - silent?: boolean; - } - - export class Worker extends events.EventEmitter { - id: string; - process: child.ChildProcess; - suicide: boolean; - send(message: any, sendHandle?: any): void; - kill(signal?: string): void; - destroy(signal?: string): void; - disconnect(): void; - } - - export var settings: ClusterSettings; - export var isMaster: boolean; - export var isWorker: boolean; - export function setupMaster(settings?: ClusterSettings): void; - export function fork(env?: any): Worker; - export function disconnect(callback?: Function): void; - export var worker: Worker; - export var workers: Worker[]; - - // Event emitter - export function addListener(event: string, listener: Function): void; - export function on(event: string, listener: Function): any; - export function once(event: string, listener: Function): void; - export function removeListener(event: string, listener: Function): void; - export function removeAllListeners(event?: string): void; - export function setMaxListeners(n: number): void; - export function listeners(event: string): Function[]; - export function emit(event: string, ...args: any[]): boolean; -} - -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 function tmpdir(): string; - export function hostname(): string; - export function type(): string; - export function platform(): string; - export function arch(): string; - export function release(): string; - export function uptime(): number; - export function loadavg(): number[]; - export function totalmem(): number; - export function freemem(): number; - export function cpus(): { model: string; speed: number; times: { user: number; nice: number; sys: number; idle: number; irq: number; }; }[]; - export function networkInterfaces(): any; - export var EOL: string; -} - -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) => 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 { - maxSockets: number; - sockets: any; - requests: any; - } - export var Agent: { - new (options?: RequestOptions): 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 events from "events"; - - export interface ReplOptions { - prompt?: string; - input?: NodeJS.ReadableStream; - output?: NodeJS.WritableStream; - terminal?: boolean; - eval?: Function; - useColors?: boolean; - useGlobal?: boolean; - ignoreUndefined?: boolean; - writer?: Function; - } - export function start(options: ReplOptions): events.EventEmitter; -} - -declare module "readline" { - import * as events from "events"; - import * as stream from "stream"; - - export interface ReadLine extends events.EventEmitter { - setPrompt(prompt: string): void; - prompt(preserveCursor?: boolean): void; - question(query: string, callback: Function): void; - pause(): void; - resume(): void; - close(): void; - write(data: any, key?: any): void; - } - export interface ReadLineOptions { - input: NodeJS.ReadableStream; - output: NodeJS.WritableStream; - completer?: Function; - terminal?: boolean; - } - export function createInterface(options: ReadLineOptions): ReadLine; -} - -declare module "vm" { - export interface Context { } - export interface Script { - runInThisContext(): void; - runInNewContext(sandbox?: Context): void; - } - export function runInThisContext(code: string, filename?: string): void; - export function runInNewContext(code: string, sandbox?: Context, filename?: string): void; - export function runInContext(code: string, context: Context, filename?: string): void; - export function createContext(initSandbox?: Context): Context; - export function createScript(code: string, filename?: string): Script; -} - -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; - pid: number; - kill(signal?: string): void; - send(message: any, sendHandle?: any): void; - disconnect(): void; - unref(): void; - } - - export function spawn(command: string, args?: string[], options?: { - cwd?: string; - stdio?: any; - custom?: any; - env?: any; - detached?: boolean; - }): ChildProcess; - export function exec(command: string, options: { - cwd?: string; - stdio?: any; - customFds?: any; - env?: any; - encoding?: string; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function exec(command: string, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, - callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, args?: string[], - callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function execFile(file: string, args?: string[], options?: { - cwd?: string; - stdio?: any; - customFds?: any; - env?: any; - encoding?: string; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - }, callback?: (error: Error, stdout: Buffer, stderr: Buffer) =>void ): ChildProcess; - export function fork(modulePath: string, args?: string[], options?: { - cwd?: string; - env?: any; - encoding?: string; - }): ChildProcess; - export function spawnSync(command: string, args?: string[], options?: { - cwd?: string; - input?: string | Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - encoding?: string; - }): { - pid: number; - output: string[]; - stdout: string | Buffer; - stderr: string | Buffer; - status: number; - signal: string; - error: Error; - }; - export function execSync(command: string, options?: { - cwd?: string; - input?: string|Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - encoding?: string; - }): string | Buffer; - export function execFileSync(command: string, args?: string[], options?: { - cwd?: string; - input?: string|Buffer; - stdio?: any; - env?: any; - uid?: number; - gid?: number; - timeout?: number; - maxBuffer?: number; - killSignal?: string; - encoding?: string; - }): string | Buffer; -} - -declare module "url" { - export interface Url { - href?: string; - protocol?: string; - auth?: string; - hostname?: string; - port?: string; - host?: string; - pathname?: string; - search?: string; - query?: any; // string | Object - 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 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: string[]) =>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[]; -} - -declare module "net" { - import * as stream from "stream"; - - 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(): void; - resume(): void; - 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; - } - - export var Socket: { - new (options?: { fd?: string; type?: string; allowHalfOpen?: boolean; }): Socket; - }; - - export interface Server extends Socket { - listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - close(callback?: Function): Server; - address(): { port: number; family: string; address: string; }; - maxConnections: number; - connections: number; - } - 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; - port: number; - size: number; - } - - interface AddressInfo { - address: string; - family: string; - port: number; - } - - export function createSocket(type: string, callback?: (msg: Buffer, rinfo: RemoteInfo) => void): Socket; - - interface Socket extends events.EventEmitter { - send(buf: Buffer, offset: number, length: number, port: number, address: string, callback?: (error: Error, bytes: number) => void): void; - bind(port: number, address?: string, callback?: () => void): void; - close(): void; - address(): AddressInfo; - setBroadcast(flag: boolean): void; - setMulticastTTL(ttl: number): void; - setMulticastLoopback(flag: boolean): void; - addMembership(multicastAddress: string, multicastInterface?: string): void; - dropMembership(multicastAddress: string, multicastInterface?: string): void; - } -} - -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; - } - - export interface ReadStream extends stream.Readable { - close(): void; - } - export interface WriteStream extends stream.Writable { - close(): void; - bytesWritten: number; - } - - /** - * 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, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncate(path: string, len: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function truncateSync(path: string, 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, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chownSync(path: string, 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, uid: number, gid: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchownSync(path: string, uid: number, gid: number): void; - export function chmod(path: string, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function chmodSync(path: string, mode: number): void; - export function chmodSync(path: string, 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, mode: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmod(path: string, mode: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function lchmodSync(path: string, mode: number): void; - export function lchmodSync(path: string, mode: string): void; - export function stat(path: string, callback?: (err: NodeJS.ErrnoException, stats: Stats) => any): void; - export function lstat(path: string, 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): Stats; - export function lstatSync(path: string): Stats; - export function fstatSync(fd: number): Stats; - export function link(srcpath: string, dstpath: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function linkSync(srcpath: string, dstpath: string): void; - export function symlink(srcpath: string, dstpath: string, type?: string, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function symlinkSync(srcpath: string, dstpath: string, type?: string): void; - export function readlink(path: string, callback?: (err: NodeJS.ErrnoException, linkString: string) => any): void; - export function readlinkSync(path: string): string; - export function realpath(path: string, callback?: (err: NodeJS.ErrnoException, resolvedPath: string) => any): void; - export function realpath(path: string, cache: {[path: string]: string}, callback: (err: NodeJS.ErrnoException, resolvedPath: string) =>any): void; - export function realpathSync(path: string, 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, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous unlink - deletes the file specified in {path} - * - * @param path - */ - export function unlinkSync(path: string): 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, callback?: (err?: NodeJS.ErrnoException) => void): void; - /* - * Synchronous rmdir - removes the directory specified in {path} - * - * @param path - */ - export function rmdirSync(path: string): 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, 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, 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, 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, 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, mode?: string): void; - export function readdir(path: string, callback?: (err: NodeJS.ErrnoException, files: string[]) => void): void; - export function readdirSync(path: string): string[]; - export function close(fd: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function closeSync(fd: number): void; - export function open(path: string, flags: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function open(path: string, flags: string, mode: number, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function open(path: string, flags: string, mode: string, callback?: (err: NodeJS.ErrnoException, fd: number) => any): void; - export function openSync(path: string, flags: string, mode?: number): number; - export function openSync(path: string, flags: string, mode?: string): number; - export function utimes(path: string, atime: number, mtime: number, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimes(path: string, atime: Date, mtime: Date, callback?: (err?: NodeJS.ErrnoException) => void): void; - export function utimesSync(path: string, atime: number, mtime: number): void; - export function utimesSync(path: string, 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 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, options: { persistent?: boolean; }, listener?: (event: string, filename: string) => any): FSWatcher; - export function exists(path: string, callback?: (exists: boolean) => void): void; - export function existsSync(path: string): boolean; - /** Constant for fs.access(). File is visible to the calling process. */ - export var F_OK: number; - /** Constant for fs.access(). File can be read by the calling process. */ - export var R_OK: number; - /** Constant for fs.access(). File can be written by the calling process. */ - export var W_OK: number; - /** Constant for fs.access(). File can be executed by the calling process. */ - export var X_OK: number; - /** Tests a user's permissions for the file specified by path. */ - export function access(path: string, callback: (err: NodeJS.ErrnoException) => void): void; - export function access(path: string, 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, mode ?: number): void; - export function createReadStream(path: string, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - autoClose?: boolean; - }): ReadStream; - export function createWriteStream(path: string, options?: { - flags?: string; - encoding?: string; - fd?: number; - mode?: number; - }): WriteStream; -} - -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; - detectIncompleteChar(buffer: Buffer): number; - } - 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 TlsOptions { - pfx?: any; //string or buffer - key?: any; //string or buffer - passphrase?: string; - cert?: any; - ca?: any; //string or buffer - crl?: any; //string or string array - ciphers?: string; - honorCipherOrder?: any; - requestCert?: boolean; - rejectUnauthorized?: boolean; - NPNProtocols?: any; //array or Buffer; - SNICallback?: (servername: string) => any; - } - - export interface ConnectionOptions { - host?: string; - port?: number; - socket?: net.Socket; - pfx?: any; //string | Buffer - key?: any; //string | Buffer - passphrase?: string; - cert?: any; //string | Buffer - ca?: any; //Array of string | Buffer - rejectUnauthorized?: boolean; - NPNProtocols?: any; //Array of string | Buffer - servername?: string; - } - - export interface Server extends net.Server { - // Extended base methods - listen(port: number, host?: string, backlog?: number, listeningListener?: Function): Server; - listen(path: string, listeningListener?: Function): Server; - listen(handle: any, listeningListener?: Function): Server; - - listen(port: number, host?: string, callback?: Function): 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; - } - - 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?: any; //string | buffer - key?: any; //string | buffer - passphrase?: string; - cert?: any; // string | buffer - ca?: any; // string | buffer - crl?: any; // 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: TlsOptions, 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 CredentialDetails { - pfx: string; - key: string; - passphrase: string; - cert: string; - ca: any; //string | string array - crl: any; //string | string array - 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): Hmac; - export function createHmac(algorithm: string, key: Buffer): Hmac; - interface Hash { - update(data: any, input_encoding?: string): Hash; - digest(encoding: 'buffer'): Buffer; - digest(encoding: string): any; - digest(): Buffer; - } - interface Hmac { - update(data: any, input_encoding?: string): Hmac; - digest(encoding: 'buffer'): Buffer; - digest(encoding: string): any; - digest(): Buffer; - } - export function createCipher(algorithm: string, password: any): Cipher; - export function createCipheriv(algorithm: string, key: any, iv: any): Cipher; - interface Cipher { - update(data: Buffer): Buffer; - update(data: string, input_encoding?: string, output_encoding?: string): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding: boolean): void; - } - export function createDecipher(algorithm: string, password: any): Decipher; - export function createDecipheriv(algorithm: string, key: any, iv: any): Decipher; - interface Decipher { - update(data: Buffer): Buffer; - update(data: string, input_encoding?: string, output_encoding?: string): string; - final(): Buffer; - final(output_encoding: string): string; - setAutoPadding(auto_padding: boolean): void; - } - export function createSign(algorithm: string): Signer; - interface Signer extends NodeJS.WritableStream { - update(data: any): void; - sign(private_key: string, output_format: string): string; - } - export function createVerify(algorith: string): Verify; - interface Verify extends NodeJS.WritableStream { - update(data: any): void; - verify(object: string, signature: string, signature_format?: string): boolean; - } - export function createDiffieHellman(prime_length: number): DiffieHellman; - export function createDiffieHellman(prime: number, encoding?: string): DiffieHellman; - interface DiffieHellman { - generateKeys(encoding?: string): string; - computeSecret(other_public_key: string, input_encoding?: string, output_encoding?: string): string; - getPrime(encoding?: string): string; - getGenerator(encoding: string): string; - getPublicKey(encoding?: string): string; - getPrivateKey(encoding?: string): string; - setPublicKey(public_key: string, encoding?: string): void; - setPrivateKey(public_key: string, encoding?: string): void; - } - export function getDiffieHellman(group_name: string): DiffieHellman; - export function pbkdf2(password: string, salt: string, iterations: number, keylen: number, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2(password: string, salt: string, iterations: number, keylen: number, digest: string, callback: (err: Error, derivedKey: Buffer) => any): void; - export function pbkdf2Sync(password: string, salt: string, iterations: number, keylen: number) : Buffer; - export function pbkdf2Sync(password: string, salt: string, 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; -} - -declare module "stream" { - import * as events from "events"; - - export interface Stream extends events.EventEmitter { - pipe(destination: T, options?: { end?: boolean; }): T; - } - - export interface ReadableOptions { - highWaterMark?: number; - encoding?: string; - objectMode?: boolean; - } - - export class Readable extends events.EventEmitter implements NodeJS.ReadableStream { - readable: boolean; - constructor(opts?: ReadableOptions); - _read(size: number): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - 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; - } - - export interface WritableOptions { - highWaterMark?: number; - decodeStrings?: boolean; - objectMode?: boolean; - } - - export class Writable extends events.EventEmitter implements NodeJS.WritableStream { - writable: boolean; - constructor(opts?: WritableOptions); - _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 DuplexOptions extends ReadableOptions, WritableOptions { - allowHalfOpen?: boolean; - } - - // Note: Duplex extends both Readable and Writable. - export class Duplex extends Readable implements NodeJS.ReadWriteStream { - writable: boolean; - constructor(opts?: DuplexOptions); - _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 ReadableOptions, WritableOptions {} - - // 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); - _transform(chunk: any, encoding: string, callback: Function): void; - _flush(callback: Function): void; - read(size?: number): any; - setEncoding(encoding: string): void; - pause(): void; - resume(): void; - 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 {} -} - -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; -} - -declare module "assert" { - function internal (value: any, message?: string): void; - module 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 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; - } - export interface WriteStream extends net.Socket { - columns: number; - rows: number; - } -} - -declare module "domain" { - import * as events from "events"; - - export class Domain extends events.EventEmitter { - 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; - - addListener(event: string, listener: Function): Domain; - on(event: string, listener: Function): Domain; - once(event: string, listener: Function): Domain; - removeListener(event: string, listener: Function): Domain; - removeAllListeners(event?: string): Domain; - } - - 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_IFLNK: number; - export var O_CREAT: number; - export var O_EXCL: 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; -} diff --git a/gulp-dependents/typings/through2/through2.d.ts b/gulp-dependents/typings/through2/through2.d.ts deleted file mode 100644 index e64d571..0000000 --- a/gulp-dependents/typings/through2/through2.d.ts +++ /dev/null @@ -1,32 +0,0 @@ -// Type definitions for through2 v 2.0.0 -// Project: https://github.com/rvagg/through2 -// Definitions by: Bart van der Schoor , jedmao , Georgios Valotasios -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/// - -declare module 'through2' { - - import stream = require('stream'); - - type TransfofmCallback = (err?: any, data?: any) => void; - type TransformFunction = (chunk: any, enc: string, callback: TransfofmCallback) => void; - type FlashCallback = (flushCallback: () => void) => void; - - function through2(transform?: TransformFunction, flush?: FlashCallback): NodeJS.ReadWriteStream; - - function through2(opts?: stream.DuplexOptions, transform?: TransformFunction, flush?: FlashCallback): NodeJS.ReadWriteStream; - - module through2 - { - - export function obj(transform?: TransformFunction, flush?: FlashCallback): NodeJS.ReadWriteStream; - - export function push(data: any): void; - - } - - export = through2; - -} - diff --git a/gulp-dependents/typings/vinyl/vinyl.d.ts b/gulp-dependents/typings/vinyl/vinyl.d.ts deleted file mode 100644 index b41a815..0000000 --- a/gulp-dependents/typings/vinyl/vinyl.d.ts +++ /dev/null @@ -1,109 +0,0 @@ -// Type definitions for vinyl 0.4.3 -// Project: https://github.com/wearefractal/vinyl -// Definitions by: vvakame , jedmao -// Definitions: https://github.com/borisyankov/DefinitelyTyped - -/// - -declare module 'vinyl' { - - import fs = require('fs'); - - /** - * A virtual file format. - */ - class File { - constructor(options?: { - /** - * Default: process.cwd() - */ - cwd?: string; - /** - * Used for relative pathing. Typically where a glob starts. - */ - base?: string; - /** - * Full path to the file. - */ - path?: string; - /** - * Path history. Has no effect if options.path is passed. - */ - history?: string[]; - /** - * The result of an fs.stat call. See fs.Stats for more information. - */ - stat?: fs.Stats; - /** - * File contents. - * Type: Buffer, Stream, or null - */ - contents?: Buffer | NodeJS.ReadWriteStream; - }); - - /** - * Default: process.cwd() - */ - public cwd: string; - /** - * Used for relative pathing. Typically where a glob starts. - */ - public base: string; - /** - * Full path to the file. - */ - public path: string; - public stat: fs.Stats; - /** - * Type: Buffer|Stream|null (Default: null) - */ - public contents: Buffer | NodeJS.ReadableStream; - /** - * Returns path.relative for the file base and file path. - * Example: - * var file = new File({ - * cwd: "/", - * base: "/test/", - * path: "/test/file.js" - * }); - * console.log(file.relative); // file.js - */ - public relative: string; - - public isBuffer(): boolean; - - public isStream(): boolean; - - public isNull(): boolean; - - public isDirectory(): boolean; - - /** - * Returns a new File object with all attributes cloned. Custom attributes are deep-cloned. - */ - public clone(opts?: { contents?: boolean }): File; - - /** - * If file.contents is a Buffer, it will write it to the stream. - * If file.contents is a Stream, it will pipe it to the stream. - * If file.contents is null, it will do nothing. - */ - public pipe( - stream: T, - opts?: { - /** - * If false, the destination stream will not be ended (same as node core). - */ - end?: boolean; - } - ): T; - - /** - * Returns a pretty String interpretation of the File. Useful for console.log. - */ - public inspect(): string; - } - - export = File; - -} diff --git a/gulp-dependents/package.json b/package.json similarity index 66% rename from gulp-dependents/package.json rename to package.json index bce5818..38df0bb 100644 --- a/gulp-dependents/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "gulp-dependents", - "version": "1.1.0", + "version": "1.2.0", "description": "Gulp plugin that tracks dependencies between files and adds any files that depend on the files currently in the stream, thus enabling incremental build of pcss, less, scss, sass, with extensibility points to support other file types.", "keywords": [ "gulp", @@ -18,8 +18,7 @@ ], "license": "MIT", "author": { - "name": "Thomas Darling", - "email": "mail@thda.dk" + "name": "Thomas Darling" }, "homepage": "https://github.com/thomas-darling/gulp-dependents", "bugs": { @@ -30,11 +29,21 @@ "url": "https://github.com/thomas-darling/gulp-dependents.git" }, "dependencies": { - "gulp-util": "^3.0.7", - "through2": "^2.0.0" + "gulp-util": "^3.0.8", + "through2": "^2.0.3" }, "devDependencies": { - "gulp": "3.9.0" + "@types/chalk": "^0.4.31", + "@types/gulp-util": "3.0.30", + "@types/mkdirp": "^0.3.29", + "@types/node": "7.0.4", + "@types/through2": "^2.0.32", + "@types/vinyl": "^2.0.0", + "typescript": "^2.1.1" }, - "main": "dist/main.js" + "scripts":{ + "prepublish": "tsc" + }, + "types": "lib/index.d.ts", + "main": "lib/index.js" } diff --git a/gulp-dependents/main.ts b/src/index.ts similarity index 53% rename from gulp-dependents/main.ts rename to src/index.ts index 14fef44..c1d42d9 100644 --- a/gulp-dependents/main.ts +++ b/src/index.ts @@ -1,4 +1,4 @@ -import Plugin from "./src/Plugin"; +import Plugin from "./plugin/Plugin"; // Export the plugin function that will be used in the gulp pipeline. -export = Plugin.run; \ No newline at end of file +export = Plugin.create; \ No newline at end of file diff --git a/gulp-dependents/src/DependencyParser.ts b/src/plugin/DependencyParser.ts similarity index 95% rename from gulp-dependents/src/DependencyParser.ts rename to src/plugin/DependencyParser.ts index e3e385e..29b8814 100644 --- a/gulp-dependents/src/DependencyParser.ts +++ b/src/plugin/DependencyParser.ts @@ -5,7 +5,7 @@ import IDependencyParser from "./IDependencyParser"; import DependencyParserConfig from "./DependencyParserConfig"; /** - * Represents the default configuration for the dependency tracker, specifying + * Represents the default configuration for the dependency tracker, specifying * how dependencies should be parsed from each of the supported file types. */ export const defaultConfig = @@ -71,7 +71,7 @@ export default class DependencyParser implements IDependencyParser public config = {}; /** - * Creates a new instance of the type. + * Creates a new instance of the type. * @param config The configuration to merge with the default configuration. */ constructor(config?: {}) @@ -101,7 +101,7 @@ export default class DependencyParser implements IDependencyParser } // Get the dependency paths specified in the file. - let dependencyPaths = this.parseFile(file, encoding, config); + let dependencyPaths = this.parseFile(file, config); // Ignore dependency paths representing URL's. dependencyPaths = dependencyPaths.filter(function (path) @@ -111,7 +111,7 @@ export default class DependencyParser implements IDependencyParser // Add path variants for all prefix and postfix variants. - + if (config.prefixes) { this.getPrefixedPathVariants(dependencyPaths, config) @@ -127,6 +127,7 @@ export default class DependencyParser implements IDependencyParser if (config.basePaths) { this.getBasePathVariants(dependencyPaths, config) + .map(dependencyPath => path.resolve(path.dirname(file.base), dependencyPath)) .forEach(dependencyPath => dependencyPaths.push(dependencyPath)); } @@ -143,14 +144,13 @@ export default class DependencyParser implements IDependencyParser * Parses the specified file, returning the set of paths specified in its dependency statements. * Note that those are not yet valid file paths, as prefixes and postfixes may be missing. * @param file The file for which dependency paths should be returned. - * @param encoding The name of the encoding used in the file. * @param config The parser config for the file type being parsed. * @return The set of paths specified in the files dependency statements. */ - private parseFile(file: util.File, encoding: string, config: DependencyParserConfig): string[] + private parseFile(file: util.File, config: DependencyParserConfig): string[] { // Read the file contents as a string. - const fileContents = file.contents.toString(encoding); + const fileContents = file.contents.toString(); // Iteratively reduce the file contents to a set of dependency references. @@ -165,11 +165,11 @@ export default class DependencyParser implements IDependencyParser } /** - * Applies the specified RegExp or function to each of the specified texts, aggregating all the captured + * Applies the specified RegExp or function to each of the specified texts, aggregating all the captured * values into a single list. * @param texts The texts against which the RegExp or function should be executed. - * @param regExpOrFunc The RegExp or function to be executed. If the parameter is a RegExp, it must have - * a single capture group representing the string to be matched. If the parameter is a function, it must + * @param regExpOrFunc The RegExp or function to be executed. If the parameter is a RegExp, it must have + * a single capture group representing the string to be matched. If the parameter is a function, it must * accept a string and return an array of matched strings. * @return An array containing all the matches found in all the texts. */ @@ -252,7 +252,7 @@ export default class DependencyParser implements IDependencyParser return variants; } - + /** * Applies the alternate base paths in the specified config to the specified paths, returning the resulting set of path variants. * @param dependencyPaths The dependency paths for which variants should be returned. diff --git a/gulp-dependents/src/DependencyParserConfig.ts b/src/plugin/DependencyParserConfig.ts similarity index 100% rename from gulp-dependents/src/DependencyParserConfig.ts rename to src/plugin/DependencyParserConfig.ts diff --git a/gulp-dependents/src/DependencyTracker.ts b/src/plugin/DependencyTracker.ts similarity index 96% rename from gulp-dependents/src/DependencyTracker.ts rename to src/plugin/DependencyTracker.ts index 6b89aec..49f3d95 100644 --- a/gulp-dependents/src/DependencyTracker.ts +++ b/src/plugin/DependencyTracker.ts @@ -6,14 +6,14 @@ import IDependencyParser from "./IDependencyParser"; /** * Represents a dependency tracker, which tracks the files that pass through and the dependencies between them. - * It assumes that it will be used in such a way, that after the instance has been created, the first sequence of - * files passed to the tracker represent all the files between which dependencies may exist. This is nessesary to + * It assumes that it will be used in such a way, that after the instance has been created, the first sequence of + * files passed to the tracker represent all the files between which dependencies may exist. This is nessesary to * set up the initial dependency map, such that when a dependency is changed, we knows which files depend on it. * * A typical Gulp setup satisfying the above requirement involves two tasks: * - A 'build' task, which pipes all files through first the 'gulp-cached' plugin, and then through this plugin. * - A 'watch' task, which watches the files, and invokes the 'build' task whenever a file changes. - * This works because the 'gulp-cached' plugin will pass through, and cache, only the files that are not already + * This works because the 'gulp-cached' plugin will pass through, and cache, only the files that are not already * in the cache or which have changed compared to the cached version. Alternatively, you may use the 'gulp-watch' * plugin, which creates an infinite stream that initially pass through all files, and after that, only changes. */ @@ -37,7 +37,7 @@ export default class DependencyTracker implements IDependencyTracker private trackedFilePaths = {}; /** - * Creates a new instance of the type. + * Creates a new instance of the type. * @param dependencyParser The parser used to extract dependency file paths from files. */ constructor(dependencyParser: IDependencyParser) @@ -99,7 +99,7 @@ export default class DependencyTracker implements IDependencyTracker // Add the normalized dependency file paths to the map. for (let dependencyFilePath of dependencyFilePaths.map(p => path.normalize(p))) { - // If the dependency file is missing in the file system, ensure its path is marked + // If the dependency file is missing in the file system, ensure its path is marked // as tracked, so we know to process its dependents if it is added later. if (!this.trackedFilePaths[dependencyFilePath] && !fs.existsSync(dependencyFilePath)) { @@ -117,20 +117,20 @@ export default class DependencyTracker implements IDependencyTracker } } - // If this is the first time we encounter the file, and it isn't tracked as a missing dependency, then + // If this is the first time we encounter the file, and it isn't tracked as a missing dependency, then // it is assumed that we're still in the initial run, where all files should already be in the stream. // We therefore should not add dependents, as they will be processed anyway. if (!shouldReturnDependents) { return null; } - + // Recursively find the file paths for all files that depend on the specified file. // If a dependent file no longer exists, it will not be included, and will be removed from the map. const dependentFilePaths = this.getDependentFilePaths(filePath, true, true); // Return the set of files that depend on the current file. - // We return those dependents even if the current file itself does not exist; all we do here is to find + // We return those dependents even if the current file itself does not exist; all we do here is to find // the dependents, and if one is missing, it is up to the actual build tool to report that as an error. return dependentFilePaths.map(dependentFilePath => { @@ -145,7 +145,7 @@ export default class DependencyTracker implements IDependencyTracker /** * Logs the state of the dependency map to the console. - * Note that this lists only dependencies and their dependents; files without dependencies + * Note that this lists only dependencies and their dependents; files without dependencies * are not listed, except as dependents, even though they are in fact tracked. * @param basePath The absolute base path, or null to log absolute file paths. */ @@ -282,7 +282,7 @@ export default class DependencyTracker implements IDependencyTracker for (let dependencyFilePath of Object.keys(dependencyMap)) { delete dependencyMap[dependencyFilePath][dependentFilePath]; - + // If the dependency has no dependents left, remove it from the map. if (!Object.keys(dependencyMap[dependencyFilePath]).length) { diff --git a/gulp-dependents/src/IDependencyParser.ts b/src/plugin/IDependencyParser.ts similarity index 100% rename from gulp-dependents/src/IDependencyParser.ts rename to src/plugin/IDependencyParser.ts diff --git a/gulp-dependents/src/IDependencyTracker.ts b/src/plugin/IDependencyTracker.ts similarity index 100% rename from gulp-dependents/src/IDependencyTracker.ts rename to src/plugin/IDependencyTracker.ts diff --git a/src/plugin/Plugin.ts b/src/plugin/Plugin.ts new file mode 100644 index 0000000..e67346d --- /dev/null +++ b/src/plugin/Plugin.ts @@ -0,0 +1,75 @@ +import * as util from "gulp-util"; +import * as path from "path"; +import * as through from "through2"; +import PluginConfig from "./PluginConfig"; +import DependencyParser from "./DependencyParser"; +import DependencyTracker from "./DependencyTracker"; + +/** + * Represents the plugin. + */ +export default class Plugin +{ + /** + * The static dependency tracker instance. + */ + private static dependencyTracker: DependencyTracker; + + /** + * Creates a new instance of the plugin. + * @param parserConfig The parser configuration use, null, undefined or empty string to use the default configuration, or an instance of a custom IDependencyParser. + * @param pluginConfig The debug configuration use, or null or undefined to disable all debug options. + */ + public static create(parserConfig?: {}, pluginConfig?: PluginConfig): NodeJS.ReadWriteStream + { + // Get or create the debug options. + if (!pluginConfig) + { + pluginConfig = new PluginConfig(); + } + + // Get or create the dependency parser and tracker. + + if (Plugin.dependencyTracker == null) + { + Plugin.dependencyTracker = new DependencyTracker(new DependencyParser(parserConfig)); + } + + // Return the stream transform. + return through.obj(function (file: util.File, encoding: string, callback: (err?: any, data?: any) => void) + { + // Get the files that depend on the current file. + let dependentFiles = Plugin.dependencyTracker.updateAndGetDependents(file, encoding); + + // Should we log the dependents to the console? + if (dependentFiles != null && pluginConfig.logDependents) + { + Plugin.dependencyTracker.logDependents(path.normalize(file.path), true, process.cwd()); + } + + // Push the current file to the stream. + this.push(file); + + // If the current file is tracked, add its dependents to the stream. + if (dependentFiles != null) + { + for (let dependentFile of dependentFiles) + { + this.push(dependentFile); + } + } + + callback(); + }, + function (callback) + { + // Should we log the dependency map to the console? + if (pluginConfig.logDependencyMap) + { + Plugin.dependencyTracker.logDependencyMap(process.cwd()); + } + + callback(); + }); + } +} diff --git a/gulp-dependents/src/PluginConfig.ts b/src/plugin/PluginConfig.ts similarity index 100% rename from gulp-dependents/src/PluginConfig.ts rename to src/plugin/PluginConfig.ts diff --git a/tsconfig.json b/tsconfig.json new file mode 100644 index 0000000..33ced14 --- /dev/null +++ b/tsconfig.json @@ -0,0 +1,24 @@ +{ + "compilerOptions": { + "target": "es5", + "module": "commonjs", + "sourceMap": false, + "declaration": true, + "noEmitOnError": true, + "noImplicitAny": false, + "removeComments": false, + "preserveConstEnums": true, + "noImplicitReturns": true, + "noFallthroughCasesInSwitch": true, + "forceConsistentCasingInFileNames": true, + "moduleResolution": "node", + "strictNullChecks": false, + "outDir": "lib" + }, + "exclude": [ + ".vscode", + "example", + "lib", + "node_modules" + ] +} \ No newline at end of file