diff --git a/ember-cli-build.js b/ember-cli-build.js index 709ef073383..1184f8fe1bc 100644 --- a/ember-cli-build.js +++ b/ember-cli-build.js @@ -1,10 +1,14 @@ var fs = require('fs'); var path = require('path'); +// Import the require hook. Enables us to require TS files natively. +require('ts-node/register'); + var mergeTrees = require('broccoli-merge-trees'); var Angular2App = require('angular-cli/lib/broccoli/angular2-app'); var BroccoliSass = require('broccoli-sass'); var broccoliAutoprefixer = require('broccoli-autoprefixer'); +var BroccoliTs2Dart = require('./tools/broccoli/broccoli-ts2dart').default; var autoprefixerOptions = require('./build/autoprefixer-options'); @@ -12,11 +16,17 @@ module.exports = function(defaults) { var demoAppCssTree = new BroccoliSass(['src/demo-app'], './demo-app.scss', 'demo-app/demo-app.css'); var componentCssTree = getComponentsCssTree(); var angularAppTree = new Angular2App(defaults); + var dartAppTree = new BroccoliTs2Dart('src/', { + generateLibraryName: true, + generateSourceMap: false, + translateBuiltins: true, + }); return mergeTrees([ angularAppTree.toTree(), componentCssTree, demoAppCssTree, + dartAppTree, ]); }; diff --git a/package.json b/package.json index e2e14d53fac..33227fcf7e5 100644 --- a/package.json +++ b/package.json @@ -41,6 +41,9 @@ "karma-firefox-launcher": "^0.1.7", "karma-jasmine": "^0.3.6", "karma-sauce-launcher": "^0.2.14", + "symlink-or-copy": "^1.0.1", + "ts-node": "^0.5.5", + "ts2dart": "^0.7.20", "tslint": "^3.2.2", "typescript": "^1.7.5" } diff --git a/tools/broccoli/angular_builder.d.ts b/tools/broccoli/angular_builder.d.ts new file mode 100644 index 00000000000..c7476f3c498 --- /dev/null +++ b/tools/broccoli/angular_builder.d.ts @@ -0,0 +1,5 @@ +interface AngularBuilderOptions { + outputPath: string; + dartSDK?: any; + logs?: any; +} diff --git a/tools/broccoli/angular_builder.ts b/tools/broccoli/angular_builder.ts new file mode 100644 index 00000000000..032278a9d04 --- /dev/null +++ b/tools/broccoli/angular_builder.ts @@ -0,0 +1,167 @@ +var broccoli = require('broccoli'); +var fs = require('fs'); +var makeBrowserTree = require('./trees/browser_tree'); +var makeNodeTree = require('./trees/node_tree'); +var makeDartTree = require('./trees/dart_tree'); +var path = require('path'); +var printSlowTrees = require('broccoli-slow-trees'); +var Q = require('q'); + +type ProjectMap = { + [key: string]: boolean +}; + +type Options = { + projects: ProjectMap; +noTypeChecks: boolean; +generateEs6: boolean; +useBundles: boolean; +} +; + +/** + * BroccoliBuilder facade for all of our build pipelines. + */ +export class AngularBuilder { + private nodeBuilder: BroccoliBuilder; + private browserDevBuilder: BroccoliBuilder; + private browserProdBuilder: BroccoliBuilder; + private dartBuilder: BroccoliBuilder; + private outputPath: string; + private firstResult: BuildResult; + + constructor(public options: AngularBuilderOptions) { this.outputPath = options.outputPath; } + + + public rebuildBrowserDevTree(opts: Options): Promise { + this.browserDevBuilder = this.browserDevBuilder || this.makeBrowserDevBuilder(opts); + return this.rebuild(this.browserDevBuilder, 'js.dev'); + } + + + public rebuildBrowserProdTree(opts: Options): Promise { + this.browserProdBuilder = this.browserProdBuilder || this.makeBrowserProdBuilder(opts); + return this.rebuild(this.browserProdBuilder, 'js.prod'); + } + + + public rebuildNodeTree(opts: Options): Promise { + this.nodeBuilder = this.nodeBuilder || this.makeNodeBuilder(opts.projects); + return this.rebuild(this.nodeBuilder, 'js.cjs'); + } + + + public rebuildDartTree(projects: ProjectMap): Promise { + this.dartBuilder = this.dartBuilder || this.makeDartBuilder(projects); + return this.rebuild(this.dartBuilder, 'dart'); + } + + + cleanup(): Promise { + return Q.all([ + this.nodeBuilder && this.nodeBuilder.cleanup(), + this.browserDevBuilder && this.browserDevBuilder.cleanup(), + this.browserProdBuilder && this.browserProdBuilder.cleanup() + ]); + } + + + private makeBrowserDevBuilder(opts: Options): BroccoliBuilder { + let tree = makeBrowserTree( + { + name: 'dev', + typeAssertions: true, + sourceMaps: true, + projects: opts.projects, + noTypeChecks: opts.noTypeChecks, + generateEs6: opts.generateEs6, + useBundles: opts.useBundles + }, + path.join(this.outputPath, 'js', 'dev')); + return new broccoli.Builder(tree); + } + + + private makeBrowserProdBuilder(opts: Options): BroccoliBuilder { + let tree = makeBrowserTree( + { + name: 'prod', + typeAssertions: false, + sourceMaps: false, + projects: opts.projects, + noTypeChecks: opts.noTypeChecks, + generateEs6: opts.generateEs6, + useBundles: opts.useBundles + }, + path.join(this.outputPath, 'js', 'prod')); + return new broccoli.Builder(tree); + } + + + private makeNodeBuilder(projects: ProjectMap): BroccoliBuilder { + let tree = makeNodeTree(projects, path.join(this.outputPath, 'js', 'cjs')); + return new broccoli.Builder(tree); + } + + + private makeDartBuilder(projects: ProjectMap): BroccoliBuilder { + let options = { + outputPath: path.join(this.outputPath, 'dart'), + dartSDK: this.options.dartSDK, + logs: this.options.logs, + projects: projects + }; + let tree = makeDartTree(options); + return new broccoli.Builder(tree); + } + + + private rebuild(builder, name) { + return builder.build().then( + (result) => { + if (!this.firstResult) { + this.firstResult = result; + } + + printSlowTrees(result.graph); + writeBuildLog(result, name); + }, + (error) => { + // the build tree is the same during rebuilds, only leaf properties of the nodes change + // so let's traverse it and get updated values for input/cache/output paths + if (this.firstResult) { + writeBuildLog(this.firstResult, name); + } + throw error; + }); + } +} + + +function writeBuildLog(result: BuildResult, name: string) { + let logPath = `tmp/build.${name}.log`; + let prevLogPath = logPath + '.previous'; + let formattedLogContent = JSON.stringify(broccoliNodeToBuildNode(result.graph), null, 2); + + if (fs.existsSync(prevLogPath)) fs.unlinkSync(prevLogPath); + if (fs.existsSync(logPath)) fs.renameSync(logPath, prevLogPath); + fs.writeFileSync(logPath, formattedLogContent, {encoding: 'utf-8'}); +} + + +function broccoliNodeToBuildNode(broccoliNode) { + let tree = broccoliNode.tree.newStyleTree || broccoliNode.tree; + + return new BuildNode(tree.description || tree.constructor.name, + tree.inputPath ? [tree.inputPath] : tree.inputPaths, tree.cachePath, + tree.outputPath, broccoliNode.selfTime / (1000 * 1000 * 1000), + broccoliNode.totalTime / (1000 * 1000 * 1000), + broccoliNode.subtrees.map(broccoliNodeToBuildNode)); +} + + +class BuildNode { + constructor(public pluginName: string, public inputPaths: string[], public cachePath: string, + public outputPath: string, public selfTime: number, public totalTime: number, + public inputNodes: BroccoliNode[]) {} +} diff --git a/tools/broccoli/broccoli-check-imports.ts b/tools/broccoli/broccoli-check-imports.ts new file mode 100644 index 00000000000..f1d53c0076f --- /dev/null +++ b/tools/broccoli/broccoli-check-imports.ts @@ -0,0 +1,108 @@ +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +/** + * Checks that modules do not import files that are not supposed to import. + * + * This guarantees that platform-independent modules remain platoform-independent. + */ +class CheckImports implements DiffingBroccoliPlugin { + static IMPORT_DECL_REGEXP = new RegExp(`^import[^;]+;`, "mg"); + static IMPORT_PATH_REGEXP = new RegExp(`['"]([^'"]+)+['"]`, "m"); + + static ALLOWED_IMPORTS = { + "angular2/src/core": ["angular2/src/facade"], + "angular2/src/facade": ["rxjs"], + "angular2/src/common": ["angular2/core", "angular2/src/facade"], + "angular2/src/http": ["angular2/core", "angular2/src/facade", "rxjs"], + "angular2/src/upgrade": ["angular2/core", "angular2/src/facade", "angular2/platform/browser"] + //"angular2/src/render": [ + // "angular2/animate", + // "angular2/core", + // "angular2/src/facade", + //] + }; + + private initRun = true; + + constructor(private inputPath, private cachePath, private options) {} + + rebuild(treeDiff: DiffResult) { + const errors = this.checkAllPaths(treeDiff); + if (errors.length > 0) { + throw new Error( + `The following imports are not allowed because they break barrel boundaries:\n${errors.join("\n")}`); + } + this.symlinkInputAndCacheIfNeeded(); + return treeDiff; + } + + private checkAllPaths(treeDiff: DiffResult) { + const changesFiles = treeDiff.addedPaths.concat(treeDiff.changedPaths); + return flatMap(changesFiles, _ => this.checkFilePath(_)); + } + + private symlinkInputAndCacheIfNeeded() { + if (this.initRun) { + fs.rmdirSync(this.cachePath); + fs.symlinkSync(this.inputPath, this.cachePath); + } + this.initRun = false; + } + + private checkFilePath(filePath: string) { + const sourceFilePath = path.join(this.inputPath, filePath); + if (endsWith(sourceFilePath, ".ts") && fs.existsSync(sourceFilePath)) { + const content = fs.readFileSync(sourceFilePath, "UTF-8"); + const imports = content.match(CheckImports.IMPORT_DECL_REGEXP); + if (imports) { + return imports.filter(i => !this.isAllowedImport(filePath, i)) + .map(i => this.formatError(filePath, i)); + } else { + return []; + } + } + return []; + } + + private isAllowedImport(sourceFile: string, importDecl: string): boolean { + const res = CheckImports.IMPORT_PATH_REGEXP.exec(importDecl); + if (!res || res.length < 2) return true; // non-es6 import + const importPath = res[1]; + + if (startsWith(importPath, "./") || startsWith(importPath, "../")) return true; + + const c = CheckImports.ALLOWED_IMPORTS; + for (var prop in c) { + if (c.hasOwnProperty(prop) && startsWith(sourceFile, prop)) { + const allowedPaths = c[prop]; + return startsWith(importPath, prop) || + allowedPaths.filter(p => startsWith(importPath, p)).length > 0; + } + } + + return true; + } + + private formatError(filePath: string, importPath: string): string { + const i = importPath.replace(new RegExp(`\n`, 'g'), "\\n"); + return `${filePath}: ${i}`; + } +} + + +function startsWith(str: string, substring: string): boolean { + return str.substring(0, substring.length) === substring; +} + +function endsWith(str: string, substring: string): boolean { + return str.indexOf(substring, str.length - substring.length) !== -1; +} + +function flatMap(arr: T[], fn: (t: T) => U[]): U[] { + return [].concat(...arr.map(fn)); +} + +export default wrapDiffingPlugin(CheckImports); diff --git a/tools/broccoli/broccoli-dartfmt.ts b/tools/broccoli/broccoli-dartfmt.ts new file mode 100644 index 00000000000..7872c81a4d2 --- /dev/null +++ b/tools/broccoli/broccoli-dartfmt.ts @@ -0,0 +1,107 @@ +/// +/// +import fse = require('fs-extra'); +import path = require('path'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; +var spawn = require('child_process').spawn; +var exec = require('child_process').exec; + +function processToPromise(process) { + return new Promise(function(resolve, reject) { + process.on('close', function(code) { + if (code) { + reject(code); + } else { + resolve(); + } + }); + }); +} + +class DartFormatter implements DiffingBroccoliPlugin { + private DARTFMT: string; + private verbose: boolean; + private firstBuild: boolean = true; + + constructor(public inputPath: string, public cachePath: string, options) { + if (!options.dartSDK) throw new Error("Missing Dart SDK"); + this.DARTFMT = options.dartSDK.DARTFMT; + this.verbose = options.logs.dartfmt; + } + + rebuild(treeDiff: DiffResult): Promise { + let args = ['-w']; + let argsLength = 2; + let argPackages = []; + let firstBuild = this.firstBuild; + treeDiff.addedPaths.concat(treeDiff.changedPaths) + .forEach((changedFile) => { + let sourcePath = path.join(this.inputPath, changedFile); + let destPath = path.join(this.cachePath, changedFile); + if (!firstBuild && /\.dart$/.test(changedFile)) { + if ((argsLength + destPath.length + 2) >= 0x2000) { + // Win32 command line arguments length + argPackages.push(args); + args = ['-w']; + argsLength = 2; + } + args.push(destPath); + argsLength += destPath.length + 2; + } + fse.copySync(sourcePath, destPath); + }); + treeDiff.removedPaths.forEach((removedFile) => { + let destPath = path.join(this.cachePath, removedFile); + fse.removeSync(destPath); + }); + + if (!firstBuild && args.length > 1) { + argPackages.push(args); + } + + let execute = (args) => { + if (args.length < 2) return Promise.resolve(); + return new Promise((resolve, reject) => { + exec(this.DARTFMT + ' ' + args.join(' '), (err, stdout, stderr) => { + if (this.verbose) { + console.log(stdout); + } + if (err) { + console.error(shortenFormatterOutput(stderr)); + reject('Formatting failed.'); + } else { + resolve(); + } + }); + }); + }; + + if (firstBuild) { + // On firstBuild, format the entire cachePath + this.firstBuild = false; + return execute(['-w', this.cachePath]); + } + + return Promise.all(argPackages.map(execute)); + } +} + +export default wrapDiffingPlugin(DartFormatter); + +var ARROW_LINE = /^(\s+)\^+/; +var BEFORE_CHARS = 15; +var stripAnsi = require('strip-ansi'); +function shortenFormatterOutput(formatterOutput) { + var lines = formatterOutput.split('\n'); + var match, line; + for (var i = 0; i < lines.length; i += 1) { + line = lines[i]; + if (match = stripAnsi(line).match(ARROW_LINE)) { + let leadingWhitespace = match[1].length; + let leadingCodeChars = Math.min(leadingWhitespace, BEFORE_CHARS); + lines[i] = line.substr(leadingWhitespace - leadingCodeChars); + lines[i - 1] = lines[i - 1].substr(leadingWhitespace - leadingCodeChars, 80) + '…'; + } + } + return lines.join('\n'); +} diff --git a/tools/broccoli/broccoli-dest-copy.ts b/tools/broccoli/broccoli-dest-copy.ts new file mode 100644 index 00000000000..ecfd90a482b --- /dev/null +++ b/tools/broccoli/broccoli-dest-copy.ts @@ -0,0 +1,36 @@ +/// +/// + +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +/** + * Intercepts each file as it is copied to the destination tempdir, + * and tees a copy to the given path outside the tmp dir. + */ +class DestCopy implements DiffingBroccoliPlugin { + constructor(private inputPath, private cachePath, private outputRoot: string) {} + + + rebuild(treeDiff: DiffResult) { + treeDiff.addedPaths.concat(treeDiff.changedPaths) + .forEach((changedFilePath) => { + var destFilePath = path.join(this.outputRoot, changedFilePath); + + var destDirPath = path.dirname(destFilePath); + fse.mkdirsSync(destDirPath); + fse.copySync(path.join(this.inputPath, changedFilePath), destFilePath); + }); + + treeDiff.removedPaths.forEach((removedFilePath) => { + var destFilePath = path.join(this.outputRoot, removedFilePath); + + // TODO: what about obsolete directories? we are not cleaning those up yet + fs.unlinkSync(destFilePath); + }); + } +} + +export default wrapDiffingPlugin(DestCopy); diff --git a/tools/broccoli/broccoli-filter.d.ts b/tools/broccoli/broccoli-filter.d.ts new file mode 100644 index 00000000000..3a04ebea2a8 --- /dev/null +++ b/tools/broccoli/broccoli-filter.d.ts @@ -0,0 +1,14 @@ +/// + +interface FilterOptions { + extensions?: string[] +} + +declare class Filter { + constructor(inputTree: any, options?: FilterOptions); + processString(contents: string, relativePath: string): string; + // NB: This function is probably not intended as part of the public API + processFile(srcDir: string, destDir: string, relativePath: string): Promise; +} + +export = Filter; diff --git a/tools/broccoli/broccoli-flatten.spec.ts b/tools/broccoli/broccoli-flatten.spec.ts new file mode 100644 index 00000000000..b58fd585d5e --- /dev/null +++ b/tools/broccoli/broccoli-flatten.spec.ts @@ -0,0 +1,76 @@ +/// +/// + +let mockfs = require('mock-fs'); +import fs = require('fs'); +import path = require('path'); +import {TreeDiffer} from './tree-differ'; +import {DiffingFlatten} from './broccoli-flatten'; + +describe('Flatten', () => { + afterEach(() => mockfs.restore()); + + function flatten(inputPaths) { return new DiffingFlatten(inputPaths, 'output', null); } + + function read(path) { return fs.readFileSync(path, {encoding: "utf-8"}); } + function rm(path) { return fs.unlinkSync(path); } + function write(path, content) { fs.writeFileSync(path, content, {encoding: "utf-8"}); } + + + it('should flatten files and be incremental', () => { + let testDir = { + 'input': { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-2.txt content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.txt': mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)}) + }, + 'empty-dir': {} + }, + }, + 'output': {} + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'input'); + let flattenedTree = flatten('input'); + flattenedTree.rebuild(differ.diffTree()); + + expect(fs.readdirSync('output')).toEqual(['file-1.1.txt', 'file-1.txt', 'file-2.txt']); + // fails due to a mock-fs bug related to reading symlinks? + // expect(read('output/file-1.1.txt')).toBe('file-1.1.txt content'); + + + // delete a file + rm('input/dir1/file-1.txt'); + // add a new one + write('input/dir1/file-3.txt', 'file-3.txt content'); + + flattenedTree.rebuild(differ.diffTree()); + + expect(fs.readdirSync('output')).toEqual(['file-1.1.txt', 'file-2.txt', 'file-3.txt']); + }); + + + it('should throw an exception if duplicates are found', () => { + let testDir = { + 'input': { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'subdir-1': + {'file-1.txt': mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)})}, + 'empty-dir': {} + }, + }, + 'output': {} + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'input'); + let flattenedTree = flatten('input'); + expect(() => flattenedTree.rebuild(differ.diffTree())) + .toThrowError("Duplicate file 'file-1.txt' found in path 'dir1" + path.sep + "subdir-1" + + path.sep + "file-1.txt'"); + }); +}); diff --git a/tools/broccoli/broccoli-flatten.ts b/tools/broccoli/broccoli-flatten.ts new file mode 100644 index 00000000000..079c15f671d --- /dev/null +++ b/tools/broccoli/broccoli-flatten.ts @@ -0,0 +1,51 @@ +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; +var symlinkOrCopy = require('symlink-or-copy').sync; + +var isWindows = process.platform === 'win32'; + + +/** + * Intercepts each changed file and replaces its contents with + * the associated changes. + */ +export class DiffingFlatten implements DiffingBroccoliPlugin { + constructor(private inputPath, private cachePath, private options) {} + + + rebuild(treeDiff: DiffResult) { + let pathsToUpdate = treeDiff.addedPaths; + + // since we need to run on Windows as well we can't rely on symlinks being available, + // which means that we need to respond to both added and changed paths + if (isWindows) { + pathsToUpdate = pathsToUpdate.concat(treeDiff.changedPaths); + } + + pathsToUpdate.forEach((changedFilePath) => { + var sourceFilePath = path.join(this.inputPath, changedFilePath); + var destFilePath = path.join(this.cachePath, path.basename(changedFilePath)); + var destDirPath = path.dirname(destFilePath); + + if (!fs.existsSync(destDirPath)) { + fse.mkdirpSync(destDirPath); + } + + if (!fs.existsSync(destFilePath)) { + symlinkOrCopy(sourceFilePath, destFilePath); + } else { + throw new Error(`Duplicate file '${path.basename(changedFilePath)}' ` + + `found in path '${changedFilePath}'`); + } + }); + + treeDiff.removedPaths.forEach((removedFilePath) => { + var destFilePath = path.join(this.cachePath, path.basename(removedFilePath)); + fs.unlinkSync(destFilePath); + }); + } +} + +export default wrapDiffingPlugin(DiffingFlatten); diff --git a/tools/broccoli/broccoli-lodash.ts b/tools/broccoli/broccoli-lodash.ts new file mode 100644 index 00000000000..76388c2aafd --- /dev/null +++ b/tools/broccoli/broccoli-lodash.ts @@ -0,0 +1,49 @@ +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +var _ = require('lodash'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +interface LodashRendererOptions { + encoding?: string; + context?: any; + // files option unsupported --- use Funnel on inputTree instead. + files?: string[]; +} + +const kDefaultOptions: LodashRendererOptions = { + encoding: 'utf-8', + context: {}, + files: [] +}; + + +/** + * Intercepts each changed file and replaces its contents with + * the associated changes. + */ +export class LodashRenderer implements DiffingBroccoliPlugin { + constructor(private inputPath, private cachePath, + private options: LodashRendererOptions = kDefaultOptions) {} + + rebuild(treeDiff: DiffResult) { + let {encoding = 'utf-8', context = {}} = this.options; + let processFile = (relativePath) => { + let sourceFilePath = path.join(this.inputPath, relativePath); + let destFilePath = path.join(this.cachePath, relativePath); + let content = fs.readFileSync(sourceFilePath, {encoding}); + let transformedContent = _.template(content)(context); + fse.outputFileSync(destFilePath, transformedContent); + }; + + let removeFile = (relativePath) => { + let destFilePath = path.join(this.cachePath, relativePath); + fs.unlinkSync(destFilePath); + }; + + treeDiff.addedPaths.concat(treeDiff.changedPaths).forEach(processFile); + treeDiff.removedPaths.forEach(removeFile); + } +} + +export default wrapDiffingPlugin(LodashRenderer); diff --git a/tools/broccoli/broccoli-merge-trees.spec.ts b/tools/broccoli/broccoli-merge-trees.spec.ts new file mode 100644 index 00000000000..c1c659f5462 --- /dev/null +++ b/tools/broccoli/broccoli-merge-trees.spec.ts @@ -0,0 +1,91 @@ +/// +/// + +let mockfs = require('mock-fs'); +import fs = require('fs'); +import {TreeDiffer} from './tree-differ'; +import {MergeTrees} from './broccoli-merge-trees'; + +describe('MergeTrees', () => { + afterEach(() => mockfs.restore()); + + function mergeTrees(inputPaths, cachePath, options) { + return new MergeTrees(inputPaths, cachePath, options); + } + + function MakeTreeDiffers(rootDirs) { + let treeDiffers = rootDirs.map((rootDir) => new TreeDiffer('MergeTrees', rootDir)); + treeDiffers.diffTrees = () => { return treeDiffers.map(tree => tree.diffTree()); }; + return treeDiffers; + } + + function read(path) { return fs.readFileSync(path, "utf-8"); } + + it('should copy the file from the right-most inputTree with overwrite=true', () => { + let testDir: any = { + 'tree1': {'foo.js': mockfs.file({content: 'tree1/foo.js content', mtime: new Date(1000)})}, + 'tree2': {'foo.js': mockfs.file({content: 'tree2/foo.js content', mtime: new Date(1000)})}, + 'tree3': {'foo.js': mockfs.file({content: 'tree3/foo.js content', mtime: new Date(1000)})} + }; + mockfs(testDir); + let treeDiffer = MakeTreeDiffers(['tree1', 'tree2', 'tree3']); + let treeMerger = mergeTrees(['tree1', 'tree2', 'tree3'], 'dest', {overwrite: true}); + treeMerger.rebuild(treeDiffer.diffTrees()); + expect(read('dest/foo.js')).toBe('tree3/foo.js content'); + + delete testDir.tree2['foo.js']; + delete testDir.tree3['foo.js']; + mockfs(testDir); + treeMerger.rebuild(treeDiffer.diffTrees()); + expect(read('dest/foo.js')).toBe('tree1/foo.js content'); + + testDir.tree2['foo.js'] = mockfs.file({content: 'tree2/foo.js content', mtime: new Date(1000)}); + mockfs(testDir); + treeMerger.rebuild(treeDiffer.diffTrees()); + expect(read('dest/foo.js')).toBe('tree2/foo.js content'); + }); + + it('should throw if duplicates are found during the initial build', () => { + let testDir: any = { + 'tree1': {'foo.js': mockfs.file({content: 'tree1/foo.js content', mtime: new Date(1000)})}, + 'tree2': {'foo.js': mockfs.file({content: 'tree2/foo.js content', mtime: new Date(1000)})}, + 'tree3': {'foo.js': mockfs.file({content: 'tree3/foo.js content', mtime: new Date(1000)})} + }; + mockfs(testDir); + let treeDiffer = MakeTreeDiffers(['tree1', 'tree2', 'tree3']); + let treeMerger = mergeTrees(['tree1', 'tree2', 'tree3'], 'dest', {}); + expect(() => treeMerger.rebuild(treeDiffer.diffTrees())) + .toThrowError( + 'Duplicate path found while merging trees. Path: "foo.js".\n' + + 'Either remove the duplicate or enable the "overwrite" option for this merge.'); + + testDir = { + 'tree1': {'foo.js': mockfs.file({content: 'tree1/foo.js content', mtime: new Date(1000)})}, + 'tree2': {}, + 'tree3': {} + }; + mockfs(testDir); + }); + + + it('should throw if duplicates are found during rebuild', () => { + let testDir = { + 'tree1': {'foo.js': mockfs.file({content: 'tree1/foo.js content', mtime: new Date(1000)})}, + 'tree2': {}, + 'tree3': {} + }; + mockfs(testDir); + + let treeDiffer = MakeTreeDiffers(['tree1', 'tree2', 'tree3']); + let treeMerger = mergeTrees(['tree1', 'tree2', 'tree3'], 'dest', {}); + expect(() => treeMerger.rebuild(treeDiffer.diffTrees())).not.toThrow(); + + + testDir.tree2['foo.js'] = mockfs.file({content: 'tree2/foo.js content', mtime: new Date(1000)}); + mockfs(testDir); + expect(() => treeMerger.rebuild(treeDiffer.diffTrees())) + .toThrowError( + 'Duplicate path found while merging trees. Path: "foo.js".\n' + + 'Either remove the duplicate or enable the "overwrite" option for this merge.'); + }); +}); diff --git a/tools/broccoli/broccoli-merge-trees.ts b/tools/broccoli/broccoli-merge-trees.ts new file mode 100644 index 00000000000..60672c1a2b2 --- /dev/null +++ b/tools/broccoli/broccoli-merge-trees.ts @@ -0,0 +1,137 @@ +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +var symlinkOrCopySync = require('symlink-or-copy').sync; +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +var isWindows = process.platform === 'win32'; + +interface MergeTreesOptions { + overwrite?: boolean; +} + +function outputFileSync(sourcePath, destPath) { + let dirname = path.dirname(destPath); + fse.mkdirsSync(dirname, {fs: fs}); + symlinkOrCopySync(sourcePath, destPath); +} + +function pathOverwrittenError(path) { + const msg = 'Either remove the duplicate or enable the "overwrite" option for this merge.'; + return new Error(`Duplicate path found while merging trees. Path: "${path}".\n${msg}`); +} + +export class MergeTrees implements DiffingBroccoliPlugin { + private pathCache: {[key: string]: number[]} = Object.create(null); + public options: MergeTreesOptions; + private firstBuild: boolean = true; + + constructor(public inputPaths: string[], public cachePath: string, + options: MergeTreesOptions = {}) { + this.options = options || {}; + } + + rebuild(treeDiffs: DiffResult[]) { + let overwrite = this.options.overwrite; + let pathsToEmit: string[] = []; + let pathsToRemove: string[] = []; + let emitted: {[key: string]: boolean} = Object.create(null); + let contains = (cache, val) => { + for (let i = 0, ii = cache.length; i < ii; ++i) { + if (cache[i] === val) return true; + } + return false; + }; + + let emit = (relativePath) => { + // ASSERT(!emitted[relativePath]); + pathsToEmit.push(relativePath); + emitted[relativePath] = true; + }; + + if (this.firstBuild) { + this.firstBuild = false; + + // Build initial cache + treeDiffs.reverse().forEach((treeDiff: DiffResult, index) => { + index = treeDiffs.length - 1 - index; + treeDiff.addedPaths.forEach((changedPath) => { + let cache = this.pathCache[changedPath]; + if (cache === undefined) { + this.pathCache[changedPath] = [index]; + pathsToEmit.push(changedPath); + } else if (overwrite) { + // ASSERT(contains(pathsToEmit, changedPath)); + cache.unshift(index); + } else { + throw pathOverwrittenError(changedPath); + } + }); + }); + + } else { + // Update cache + treeDiffs.reverse().forEach((treeDiff: DiffResult, index) => { + index = treeDiffs.length - 1 - index; + if (treeDiff.removedPaths) { + treeDiff.removedPaths.forEach((removedPath) => { + let cache = this.pathCache[removedPath]; + // ASSERT(cache !== undefined); + // ASSERT(contains(cache, index)); + if (cache[cache.length - 1] === index) { + pathsToRemove.push(path.join(this.cachePath, removedPath)); + cache.pop(); + if (cache.length === 0) { + this.pathCache[removedPath] = undefined; + } else if (!emitted[removedPath]) { + if (cache.length === 1 && !overwrite) { + throw pathOverwrittenError(removedPath); + } + emit(removedPath); + } + } + }); + } + + let pathsToUpdate = treeDiff.addedPaths; + + if (isWindows) { + pathsToUpdate = pathsToUpdate.concat(treeDiff.changedPaths); + } + + pathsToUpdate.forEach((changedPath) => { + let cache = this.pathCache[changedPath]; + if (cache === undefined) { + // File was added + this.pathCache[changedPath] = [index]; + emit(changedPath); + } else if (!contains(cache, index)) { + cache.push(index); + cache.sort((a, b) => a - b); + if (cache.length > 1 && !overwrite) { + throw pathOverwrittenError(changedPath); + } + if (cache[cache.length - 1] === index && !emitted[changedPath]) { + emit(changedPath); + } + } + }); + }); + } + + pathsToRemove.forEach((destPath) => fse.removeSync(destPath)); + pathsToEmit.forEach((emittedPath) => { + let cache = this.pathCache[emittedPath]; + let destPath = path.join(this.cachePath, emittedPath); + let sourceIndex = cache[cache.length - 1]; + let sourceInputPath = this.inputPaths[sourceIndex]; + let sourcePath = path.join(sourceInputPath, emittedPath); + if (cache.length > 1) { + fse.removeSync(destPath); + } + outputFileSync(sourcePath, destPath); + }); + } +} + +export default wrapDiffingPlugin(MergeTrees); diff --git a/tools/broccoli/broccoli-replace.ts b/tools/broccoli/broccoli-replace.ts new file mode 100644 index 00000000000..7583dd5b3b7 --- /dev/null +++ b/tools/broccoli/broccoli-replace.ts @@ -0,0 +1,59 @@ +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +var minimatch = require('minimatch'); +var FILE_ENCODING = {encoding: 'utf-8'}; + +/** + * Intercepts each changed file and replaces its contents with + * the associated changes. + */ +class DiffingReplace implements DiffingBroccoliPlugin { + constructor(private inputPath, private cachePath, private options) {} + + rebuild(treeDiff: DiffResult) { + var patterns = this.options.patterns; + var files = this.options.files; + + treeDiff.addedPaths.concat(treeDiff.changedPaths) + .forEach((changedFilePath) => { + var sourceFilePath = path.join(this.inputPath, changedFilePath); + var destFilePath = path.join(this.cachePath, changedFilePath); + var destDirPath = path.dirname(destFilePath); + + if (!fs.existsSync(destDirPath)) { + fse.mkdirpSync(destDirPath); + } + + var fileMatches = files.some((filePath) => minimatch(changedFilePath, filePath)); + if (fileMatches) { + var content = fs.readFileSync(sourceFilePath, FILE_ENCODING); + patterns.forEach((pattern) => { + var replacement = pattern.replacement; + if (typeof replacement === 'function') { + replacement = function(content) { + return pattern.replacement(content, changedFilePath); + }; + } + content = content.replace(pattern.match, replacement); + }); + fs.writeFileSync(destFilePath, content, FILE_ENCODING); + } else if (!fs.existsSync(destFilePath)) { + try { + fs.symlinkSync(sourceFilePath, destFilePath); + } catch (e) { + fs.writeFileSync(destFilePath, fs.readFileSync(sourceFilePath)); + } + } + }); + + treeDiff.removedPaths.forEach((removedFilePath) => { + var destFilePath = path.join(this.cachePath, removedFilePath); + fs.unlinkSync(destFilePath); + }); + } +} + +export default wrapDiffingPlugin(DiffingReplace); diff --git a/tools/broccoli/broccoli-tree-stabilizer.ts b/tools/broccoli/broccoli-tree-stabilizer.ts new file mode 100644 index 00000000000..9a1bf97a4f0 --- /dev/null +++ b/tools/broccoli/broccoli-tree-stabilizer.ts @@ -0,0 +1,45 @@ +/// +/// + +import fs = require('fs'); +let symlinkOrCopy = require('symlink-or-copy'); + + +/** + * Stabilizes the inputPath for the following plugins in the build tree. + * + * All broccoli plugins that inherit from `broccoli-writer` or `broccoli-filter` change their + * outputPath during each rebuild. + * + * This means that all following plugins in the build tree can't rely on their inputPath being + * immutable. This results in breakage of any plugin that is not expecting such behavior. + * + * For example all `DiffingBroccoliPlugin`s expect their inputPath to be stable. + * + * By inserting this plugin into the tree after any misbehaving plugin, we can stabilize the + * inputPath for the following plugin in the tree and correct the surprising behavior. + */ +class TreeStabilizer implements BroccoliTree { + inputPath: string; + outputPath: string; + + + constructor(public inputTree: BroccoliTree) {} + + + rebuild() { + fs.rmdirSync(this.outputPath); + + // TODO: investigate if we can use rename the directory instead to improve performance on + // Windows + symlinkOrCopy.sync(this.inputPath, this.outputPath); + } + + + cleanup() {} +} + + +export default function stabilizeTree(inputTree) { + return new TreeStabilizer(inputTree); +} diff --git a/tools/broccoli/broccoli-ts2dart.ts b/tools/broccoli/broccoli-ts2dart.ts new file mode 100644 index 00000000000..6df6fbacccb --- /dev/null +++ b/tools/broccoli/broccoli-ts2dart.ts @@ -0,0 +1,50 @@ +/// +/// + +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import * as ts2dart from 'ts2dart'; +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + +class TSToDartTranspiler implements DiffingBroccoliPlugin { + static includeExtensions = ['.ts']; + + private transpiler: ts2dart.Transpiler; + + constructor(public inputPath: string, public cachePath: string, + public options: ts2dart.TranspilerOptions) { + options.basePath = inputPath; + this.transpiler = new ts2dart.Transpiler(options); + } + + rebuild(treeDiff: DiffResult) { + let toEmit = [path.resolve(this.inputPath, 'angular2/manual_typings/globals.d.ts')]; + let getDartFilePath = (path: string) => path.replace(/((\.js)|(\.ts))$/i, '.dart'); + treeDiff.addedPaths.concat(treeDiff.changedPaths) + .forEach((changedPath) => { + let inputFilePath = path.resolve(this.inputPath, changedPath); + + // Ignore files which don't need to be transpiled to Dart + let dartInputFilePath = getDartFilePath(inputFilePath); + if (fs.existsSync(dartInputFilePath)) return; + + // Prepare to rebuild + toEmit.push(path.resolve(this.inputPath, changedPath)); + }); + + treeDiff.removedPaths.forEach((removedPath) => { + let absolutePath = path.resolve(this.inputPath, removedPath); + + // Ignore files which don't need to be transpiled to Dart + let dartInputFilePath = getDartFilePath(absolutePath); + if (fs.existsSync(dartInputFilePath)) return; + + let dartOutputFilePath = getDartFilePath(removedPath); + fs.unlinkSync(path.join(this.cachePath, dartOutputFilePath)); + }); + this.transpiler.transpile(toEmit, this.cachePath); + } +} + +export default wrapDiffingPlugin(TSToDartTranspiler); diff --git a/tools/broccoli/broccoli-typescript.ts b/tools/broccoli/broccoli-typescript.ts new file mode 100644 index 00000000000..1913d02c502 --- /dev/null +++ b/tools/broccoli/broccoli-typescript.ts @@ -0,0 +1,370 @@ +/// + +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import * as ts from 'typescript'; +import {wrapDiffingPlugin, DiffingBroccoliPlugin, DiffResult} from './diffing-broccoli-plugin'; + + +type FileRegistry = ts.Map<{version: number}>; + +const FS_OPTS = { + encoding: 'utf-8' +}; + +// Sub-directory where the @internal typing files (.d.ts) are stored +export const INTERNAL_TYPINGS_PATH: string = 'internal_typings'; + +// Monkey patch the TS compiler to be able to re-emit files with @internal symbols +let tsEmitInternal: boolean = false; + +const originalEmitFiles: Function = (ts).emitFiles; + +(ts).emitFiles = function(resolver: any, host: any, targetSourceFile: any): any { + if (tsEmitInternal) { + const orignalgetCompilerOptions = host.getCompilerOptions; + host.getCompilerOptions = () => { + let options = clone(orignalgetCompilerOptions.call(host)); + options.stripInternal = false; + options.outDir = `${options.outDir}/${INTERNAL_TYPINGS_PATH}`; + return options; + } + } + return originalEmitFiles(resolver, host, targetSourceFile); +}; + +/** + * Broccoli plugin that implements incremental Typescript compiler. + * + * It instantiates a typescript compiler instance that keeps all the state about the project and + * can re-emit only the files that actually changed. + * + * Limitations: only files that map directly to the changed source file via naming conventions are + * re-emitted. This primarily affects code that uses `const enum`s, because changing the enum value + * requires global emit, which can affect many files. + */ +class DiffingTSCompiler implements DiffingBroccoliPlugin { + private tsOpts: ts.CompilerOptions; + private fileRegistry: FileRegistry = Object.create(null); + private rootFilePaths: string[]; + private tsServiceHost: ts.LanguageServiceHost; + private tsService: ts.LanguageService; + private firstRun: boolean = true; + private previousRunFailed: boolean = false; + // Whether to generate the @internal typing files (they are only generated when `stripInternal` is + // true) + private genInternalTypings: boolean = false; + + static includeExtensions = ['.ts']; + static excludeExtensions = ['.d.ts']; + + constructor(public inputPath: string, public cachePath: string, public options) { + if (options.rootFilePaths) { + this.rootFilePaths = options.rootFilePaths.splice(0); + delete options.rootFilePaths; + } else { + this.rootFilePaths = []; + } + + if (options.internalTypings) { + this.genInternalTypings = true; + delete options.internalTypings; + } + + // the conversion is a bit awkward, see https://github.com/Microsoft/TypeScript/issues/5276 + // in 1.8 use convertCompilerOptionsFromJson + this.tsOpts = + ts.parseJsonConfigFileContent({compilerOptions: options, files: []}, null, null).options; + + if ((this.tsOpts).stripInternal === false) { + // @internal are included in the generated .d.ts, do not generate them separately + this.genInternalTypings = false; + } + + // TODO: the above turns rootDir set to './' into an empty string - looks like a tsc bug + // check back when we upgrade to 1.7.x + if (this.tsOpts.rootDir === '') { + this.tsOpts.rootDir = './'; + } + this.tsOpts.outDir = this.cachePath; + + this.tsServiceHost = new CustomLanguageServiceHost(this.tsOpts, this.rootFilePaths, + this.fileRegistry, this.inputPath); + this.tsService = ts.createLanguageService(this.tsServiceHost, ts.createDocumentRegistry()); + } + + + rebuild(treeDiff: DiffResult) { + let pathsToEmit = []; + let pathsWithErrors = []; + let errorMessages = []; + + treeDiff.addedPaths.concat(treeDiff.changedPaths) + .forEach((tsFilePath) => { + if (!this.fileRegistry[tsFilePath]) { + this.fileRegistry[tsFilePath] = {version: 0}; + this.rootFilePaths.push(tsFilePath); + } else { + this.fileRegistry[tsFilePath].version++; + } + + pathsToEmit.push(tsFilePath); + }); + + treeDiff.removedPaths.forEach((tsFilePath) => { + console.log('removing outputs for', tsFilePath); + + this.rootFilePaths.splice(this.rootFilePaths.indexOf(tsFilePath), 1); + this.fileRegistry[tsFilePath] = null; + this.removeOutputFor(tsFilePath); + }); + + if (this.firstRun) { + this.firstRun = false; + this.doFullBuild(); + } else { + tsEmitInternal = false; + pathsToEmit.forEach((tsFilePath) => { + let output = this.tsService.getEmitOutput(tsFilePath); + + if (output.emitSkipped) { + let errorFound = this.collectErrors(tsFilePath); + if (errorFound) { + pathsWithErrors.push(tsFilePath); + errorMessages.push(errorFound); + } + } else { + output.outputFiles.forEach(o => { + let destDirPath = path.dirname(o.name); + fse.mkdirsSync(destDirPath); + fs.writeFileSync(o.name, this.fixSourceMapSources(o.text), FS_OPTS); + }); + } + }); + + if (pathsWithErrors.length) { + this.previousRunFailed = true; + var error = + new Error('Typescript found the following errors:\n' + errorMessages.join('\n')); + error['showStack'] = false; + throw error; + } else if (this.previousRunFailed) { + this.doFullBuild(); + } else if (this.genInternalTypings) { + // serialize the .d.ts files containing @internal symbols + tsEmitInternal = true; + pathsToEmit.forEach((tsFilePath) => { + let output = this.tsService.getEmitOutput(tsFilePath); + if (!output.emitSkipped) { + output.outputFiles.forEach(o => { + if (endsWith(o.name, '.d.ts')) { + let destDirPath = path.dirname(o.name); + fse.mkdirsSync(destDirPath); + fs.writeFileSync(o.name, this.fixSourceMapSources(o.text), FS_OPTS); + } + }); + } + }); + tsEmitInternal = false; + } + } + } + + private collectErrors(tsFilePath): String { + let allDiagnostics = this.tsService.getCompilerOptionsDiagnostics() + .concat(this.tsService.getSyntacticDiagnostics(tsFilePath)) + .concat(this.tsService.getSemanticDiagnostics(tsFilePath)); + let errors = []; + + allDiagnostics.forEach(diagnostic => { + let message = ts.flattenDiagnosticMessageText(diagnostic.messageText, "\n"); + if (diagnostic.file) { + let {line, character} = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start); + errors.push(` ${diagnostic.file.fileName} (${line + 1},${character + 1}): ${message}`); + } else { + errors.push(` Error: ${message}`); + } + }); + + if (errors.length) { + return errors.join('\n'); + } + } + + private doFullBuild() { + let program = this.tsService.getProgram(); + + tsEmitInternal = false; + let emitResult = program.emit(undefined, (absoluteFilePath, fileContent) => { + fse.mkdirsSync(path.dirname(absoluteFilePath)); + fs.writeFileSync(absoluteFilePath, this.fixSourceMapSources(fileContent), FS_OPTS); + }); + + if (this.genInternalTypings) { + // serialize the .d.ts files containing @internal symbols + tsEmitInternal = true; + program.emit(undefined, (absoluteFilePath, fileContent) => { + if (endsWith(absoluteFilePath, '.d.ts')) { + fse.mkdirsSync(path.dirname(absoluteFilePath)); + fs.writeFileSync(absoluteFilePath, fileContent, FS_OPTS); + } + }); + tsEmitInternal = false; + } + + if (emitResult.emitSkipped) { + let allDiagnostics = ts.getPreEmitDiagnostics(program).concat(emitResult.diagnostics); + let errorMessages = []; + + allDiagnostics.forEach(diagnostic => { + var pos = ''; + if (diagnostic.file) { + var {line, character} = diagnostic.file.getLineAndCharacterOfPosition(diagnostic.start); + pos = `${diagnostic.file.fileName} (${line + 1}, ${character + 1}): ` + } + var message = ts.flattenDiagnosticMessageText(diagnostic.messageText, '\n'); + errorMessages.push(` ${pos}${message}`); + }); + + if (errorMessages.length) { + this.previousRunFailed = true; + var error = + new Error('Typescript found the following errors:\n' + errorMessages.join('\n')); + error['showStack'] = false; + throw error; + } else { + this.previousRunFailed = false; + } + } + } + + /** + * There is a bug in TypeScript 1.6, where the sourceRoot and inlineSourceMap properties + * are exclusive. This means that the sources property always contains relative paths + * (e.g, ../../../../angular2/src/di/injector.ts). + * + * Here, we normalize the sources property and remove the ../../../ + * + * This issue is fixed in https://github.com/Microsoft/TypeScript/pull/5620. + * Once we switch to TypeScript 1.8, we can remove this method. + */ + private fixSourceMapSources(content: string): string { + try { + const marker = "//# sourceMappingURL=data:application/json;base64,"; + const index = content.indexOf(marker); + if (index == -1) return content; + + const base = content.substring(0, index + marker.length); + const sourceMapBit = + new Buffer(content.substring(index + marker.length), 'base64').toString("utf8"); + const sourceMaps = JSON.parse(sourceMapBit); + const source = sourceMaps.sources[0]; + sourceMaps.sources = [source.substring(source.lastIndexOf("../") + 3)]; + return `${base}${new Buffer(JSON.stringify(sourceMaps)).toString('base64')}`; + } catch (e) { + return content; + } + } + + private removeOutputFor(tsFilePath: string) { + let absoluteJsFilePath = path.join(this.cachePath, tsFilePath.replace(/\.ts$/, '.js')); + let absoluteMapFilePath = path.join(this.cachePath, tsFilePath.replace(/.ts$/, '.js.map')); + let absoluteDtsFilePath = path.join(this.cachePath, tsFilePath.replace(/\.ts$/, '.d.ts')); + + if (fs.existsSync(absoluteJsFilePath)) { + fs.unlinkSync(absoluteJsFilePath); + if (fs.existsSync(absoluteMapFilePath)) { + // source map could be inline or not generated + fs.unlinkSync(absoluteMapFilePath); + } + fs.unlinkSync(absoluteDtsFilePath); + } + } +} + + +class CustomLanguageServiceHost implements ts.LanguageServiceHost { + private currentDirectory: string; + private defaultLibFilePath: string; + + + constructor(private compilerOptions: ts.CompilerOptions, private fileNames: string[], + private fileRegistry: FileRegistry, private treeInputPath: string) { + this.currentDirectory = process.cwd(); + this.defaultLibFilePath = ts.getDefaultLibFilePath(compilerOptions).replace(/\\/g, '/'); + } + + + getScriptFileNames(): string[] { return this.fileNames; } + + + getScriptVersion(fileName: string): string { + return this.fileRegistry[fileName] && this.fileRegistry[fileName].version.toString(); + } + + + /** + * This method is called quite a bit to lookup 3 kinds of paths: + * 1/ files in the fileRegistry + * - these are the files in our project that we are watching for changes + * - in the future we could add caching for these files and invalidate the cache when + * the file is changed lazily during lookup + * 2/ .d.ts and library files not in the fileRegistry + * - these are not our files, they come from tsd or typescript itself + * - these files change only rarely but since we need them very rarely, it's not worth the + * cache invalidation hassle to cache them + * 3/ bogus paths that typescript compiler tries to lookup during import resolution + * - these paths are tricky to cache since files come and go and paths that was bogus in the + * past might not be bogus later + * + * In the initial experiments the impact of this caching was insignificant (single digit %) and + * not worth the potential issues with stale cache records. + */ + getScriptSnapshot(tsFilePath: string): ts.IScriptSnapshot { + let absoluteTsFilePath; + + if (tsFilePath == this.defaultLibFilePath || path.isAbsolute(tsFilePath)) { + absoluteTsFilePath = tsFilePath; + } else if (this.compilerOptions.moduleResolution === ts.ModuleResolutionKind.NodeJs && + tsFilePath.match(/^node_modules/)) { + absoluteTsFilePath = path.resolve(tsFilePath); + } else if (tsFilePath.match(/^rxjs/)) { + absoluteTsFilePath = path.resolve('node_modules', tsFilePath); + } else { + absoluteTsFilePath = path.join(this.treeInputPath, tsFilePath); + } + + + if (!fs.existsSync(absoluteTsFilePath)) { + // TypeScript seems to request lots of bogus paths during import path lookup and resolution, + // so we we just return undefined when the path is not correct. + return undefined; + } + return ts.ScriptSnapshot.fromString(fs.readFileSync(absoluteTsFilePath, FS_OPTS)); + } + + + getCurrentDirectory(): string { return this.currentDirectory; } + + getCompilationSettings(): ts.CompilerOptions { return this.compilerOptions; } + + getDefaultLibFileName(options: ts.CompilerOptions): string { + // ignore options argument, options should not change during the lifetime of the plugin + return this.defaultLibFilePath; + } +} + +export default wrapDiffingPlugin(DiffingTSCompiler); + +function clone(object: T): T { + const result: any = {}; + for (const id in object) { + result[id] = (object)[id]; + } + return result; +} + +function endsWith(str: string, substring: string): boolean { + return str.indexOf(substring, str.length - substring.length) !== -1; +} diff --git a/tools/broccoli/broccoli-writer.d.ts b/tools/broccoli/broccoli-writer.d.ts new file mode 100644 index 00000000000..5d821fa4f96 --- /dev/null +++ b/tools/broccoli/broccoli-writer.d.ts @@ -0,0 +1,8 @@ +/// + +declare module "broccoli-writer" { + class Writer { + write(readTree: (tree) => Promise, destDir: string): Promise; + } + export = Writer; +} diff --git a/tools/broccoli/broccoli.d.ts b/tools/broccoli/broccoli.d.ts new file mode 100644 index 00000000000..d058488c82c --- /dev/null +++ b/tools/broccoli/broccoli.d.ts @@ -0,0 +1,160 @@ +/// + + +interface BroccoliTree { + /** + * Contains the fs path for the input tree when the plugin takes only one input tree. + * + * For plugins that take multiple trees see the `inputPaths` property. + * + * This property is set just before the first rebuild and doesn't change afterwards. + */ + inputPath: string; + + /** + * Contains the array of fs paths for input trees. + * + * For plugins that take only one input tree, it might be more convenient to use the `inputPath` + *property instead. + * + * This property is set just before the first rebuild and doesn't change afterwards, unless + * plugins themselves change it. + * + * If the inputPath is outside of broccoli's temp directory, then it's lifetime is not managed by + *the builder. + * If the inputPath is within broccoli's temp directory it is an outputPath (and output directory) + *of another plugin. + * This means that while the `outputPath` doesn't change, the underlying directory is frequently + *recreated. + */ + inputPaths?: string[]; + + /** + * Contains the fs paths for the output trees. + * + * This property is set just before the first rebuild and doesn't change afterwards, unless the + * plugins themselves change it. + * + * The underlying directory is also created by the builder just before the first rebuild. + * This directory is destroyed and recreated upon each rebuild. + */ + outputPath?: string; + + /** + * Contains the fs paths for a cache directory available to the plugin. + * + * This property is set just before the first rebuild and doesn't change afterwards. + * + * The underlying directory is also created by the builder just before the first rebuild. + * The lifetime of the directory is associated with the lifetime of the plugin. + */ + cachePath?: string; + + inputTree?: BroccoliTree; + inputTrees?: BroccoliTree[]; + + /** + * Trees which implement the rebuild api are wrapped automatically for api compat, + * and `newStyleTree` keeps a reference to the original unwrapped tree. + */ + newStyleTree?: BroccoliTree; + + /** + * Description or name of the plugin used for reporting. + * + * If missing `tree.constructor.name` is usually used instead. + */ + description?: string; + + rebuild(): (Promise| void); + cleanup(): void; +} + + +interface OldBroccoliTree { + read?(readTree: (tree: BroccoliTree) => Promise): (Promise| string); +} + + + +interface BroccoliBuilder { + /** + * Triggers a build and returns a promise for the build result + */ + build(): Promise; + + + /** + * Cleans up the whole build tree by calling `.cleanup()` method on all trees that are part of the + * pipeline. + */ + cleanup(): Promise; +} + + +interface BuildResult { + /** + * Directory that contains result of the build. + * + * This directory will contains symlinks, so it is not safe to just use it as is. + * + * Use `copy-dereference` npm package to create a safe-to-use replica of the build artifacts. + */ + directory: string; + + + /** + * The DAG (graph) of all trees in the build pipeline. + */ + graph: BroccoliNode; + + /** + * Total time it took to make the build. + */ + totalTime: number; +} + + + +interface BroccoliNode { + ///** + // * Id of the current node + // */ + // id: number; //only in master + + /** + * Time spent processing the current node during a single rebuild. + */ + selfTime: number; + + + /** + * Time spent processing the current node and its subtrees during a single rebuild. + */ + totalTime: number; + + + /** + * Tree associated with the current node. + */ + tree: BroccoliTree; + + + /** + * Child nodes with references to trees that are input for the tree of the current node. + */ + subtrees: BroccoliNode[]; + + + /** + * Parent nodes with references to trees that are consume the output of processing the current + * tree. + */ + parents: BroccoliNode[]; + + + /** + * Path to the directory containing the output of processing the current tree. + */ + directory: string; +} diff --git a/tools/broccoli/diffing-broccoli-plugin.ts b/tools/broccoli/diffing-broccoli-plugin.ts new file mode 100644 index 00000000000..d61db4364f2 --- /dev/null +++ b/tools/broccoli/diffing-broccoli-plugin.ts @@ -0,0 +1,190 @@ +/// +/// +/// + +import fs = require('fs'); +import fse = require('fs-extra'); +import path = require('path'); +import {TreeDiffer, DiffResult} from './tree-differ'; +import stabilizeTree from './broccoli-tree-stabilizer'; +let symlinkOrCopy = require('symlink-or-copy'); + + +export {DiffResult} from './tree-differ'; + + +/** + * Makes writing diffing plugins easy. + * + * Factory method that takes a class that implements the DiffingBroccoliPlugin interface and returns + * an instance of BroccoliTree. + * + * @param pluginClass + * @returns {DiffingBroccoliPlugin} + */ +export function wrapDiffingPlugin(pluginClass): DiffingPluginWrapperFactory { + return function() { return new DiffingPluginWrapper(pluginClass, arguments); }; +} + + +export interface DiffingBroccoliPlugin { + rebuild(diff: (DiffResult | DiffResult[])): (Promise| DiffResult | void); + cleanup ? () : void; +} + + +type DiffingPluginWrapperFactory = (inputTrees: (BroccoliTree | BroccoliTree[]), options?) => + BroccoliTree; + + +class DiffingPluginWrapper implements BroccoliTree { + treeDiffer: TreeDiffer = null; + treeDiffers: TreeDiffer[] = null; + initialized = false; + wrappedPlugin: DiffingBroccoliPlugin = null; + inputTree = null; + inputTrees = null; + description = null; + + // props monkey-patched by broccoli builder: + inputPath = null; + inputPaths = null; + cachePath = null; + outputPath = null; + + private diffResult: DiffResult = null; + + constructor(private pluginClass, private wrappedPluginArguments) { + if (Array.isArray(wrappedPluginArguments[0])) { + this.inputTrees = this.stabilizeTrees(wrappedPluginArguments[0]); + } else { + this.inputTree = this.stabilizeTree(wrappedPluginArguments[0]); + } + + this.description = this.pluginClass.name; + } + + private getDiffResult(): (DiffResult | DiffResult[]) { + let returnOrCalculateDiffResult = (tree, index) => { + // returnOrCalculateDiffResult will do one of two things: + // + // If `this.diffResult` is null, calculate a DiffResult using TreeDiffer + // for the input tree. + // + // Otherwise, `this.diffResult` was produced from the output of the + // inputTree's rebuild() method, and can be used without being checked. + // Set `this.diffResult` to null and return the previously stored value. + let diffResult = tree.diffResult; + if (diffResult) return diffResult; + let differ = index === false ? this.treeDiffer : this.treeDiffers[index]; + return differ.diffTree(); + }; + + if (this.inputTrees) { + return this.inputTrees.map(returnOrCalculateDiffResult); + } else if (this.inputTree) { + return returnOrCalculateDiffResult(this.inputTree, false); + } else { + throw new Error("Missing TreeDiffer"); + } + } + + private maybeStoreDiffResult(value: (DiffResult | void)) { + if (!(value instanceof DiffResult)) value = null; + this.diffResult = (value); + } + + rebuild(): (Promise| void) { + try { + let firstRun = !this.initialized; + this.init(); + + let diffResult = this.getDiffResult(); + + let result = this.wrappedPlugin.rebuild(diffResult); + + if (result) { + let resultPromise = >(result); + if (resultPromise.then) { + // rebuild() -> Promise<> + return resultPromise.then((result: (DiffResult | void)) => { + this.maybeStoreDiffResult(result); + this.relinkOutputAndCachePaths(); + }); + } + } + + this.maybeStoreDiffResult(<(DiffResult | void)>(result)); + this.relinkOutputAndCachePaths(); + } catch (e) { + e.message = `[${this.description}]: ${e.message}`; + throw e; + } + } + + + cleanup() { + if (this.wrappedPlugin && this.wrappedPlugin.cleanup) { + this.wrappedPlugin.cleanup(); + } + } + + + private relinkOutputAndCachePaths() { + // just symlink the cache and output tree + fs.rmdirSync(this.outputPath); + symlinkOrCopy.sync(this.cachePath, this.outputPath); + } + + + private init() { + if (!this.initialized) { + let includeExtensions = this.pluginClass.includeExtensions || []; + let excludeExtensions = this.pluginClass.excludeExtensions || []; + let description = this.description; + this.initialized = true; + if (this.inputPaths) { + this.treeDiffers = + this.inputPaths.map((inputPath) => new TreeDiffer( + description, inputPath, includeExtensions, excludeExtensions)); + } else if (this.inputPath) { + this.treeDiffer = + new TreeDiffer(description, this.inputPath, includeExtensions, excludeExtensions); + } + this.wrappedPlugin = new this.pluginClass(this.inputPaths || this.inputPath, this.cachePath, + this.wrappedPluginArguments[1]); + } + } + + + private stabilizeTrees(trees: BroccoliTree[]) { + // Prevent extensions to prevent array from being mutated from the outside. + // For-loop used to avoid re-allocating a new array. + var stableTrees = []; + for (let i = 0; i < trees.length; ++i) { + // ignore null/undefined input tries in order to support conditional build pipelines + if (trees[i]) { + stableTrees.push(this.stabilizeTree(trees[i])); + } + } + + if (stableTrees.length === 0) { + throw new Error('No input trees provided!'); + } + + return Object.freeze(stableTrees); + } + + + private stabilizeTree(tree: BroccoliTree) { + // Ignore all DiffingPlugins as they are already stable, for others we don't know for sure + // so we need to stabilize them. + // Since it's not safe to use instanceof operator in node, we are checking the constructor.name. + // + // New-style/rebuild trees should always be stable. + let isNewStyleTree = !!(tree['newStyleTree'] || typeof tree.rebuild === 'function' || + tree['isReadAPICompatTree'] || tree.constructor['name'] === 'Funnel'); + + return isNewStyleTree ? tree : stabilizeTree(tree); + } +} diff --git a/tools/broccoli/multi_copy.ts b/tools/broccoli/multi_copy.ts new file mode 100644 index 00000000000..18573be43bf --- /dev/null +++ b/tools/broccoli/multi_copy.ts @@ -0,0 +1,49 @@ +/// +/// +/// + +import Writer = require('broccoli-writer'); +import fs = require('fs'); +import fsx = require('fs-extra'); +var minimatch = require('minimatch'); +var path = require('path'); +var glob = require('glob'); + +export interface MultiCopyOptions { + /** The path of the file to copy. */ + srcPath: string; + /** A list of glob patterns of folders to copy to, matched against the input tree. */ + targetPatterns: string[]; + /** List of glob patterns to *not* copy to, matched against the matches from `targetPatterns`. */ + exclude?: string[]; +} + +/** + * A writer that copies an input file from an input path into (potentially many) output locations + * given by glob patterns, . + */ +export class MultiCopy extends Writer { + constructor(private inputTree, private options: MultiCopyOptions) { super(); } + + write(readTree: (tree) => Promise, destDir: string): Promise { + return readTree(this.inputTree) + .then((inputPath: string) => { + var fileName = path.basename(this.options.srcPath); + var data = fs.readFileSync(path.join(inputPath, this.options.srcPath), 'utf-8'); + + this.options.targetPatterns.forEach(pattern => { + var paths: string[] = glob.sync(pattern); + paths = paths.filter(p => fs.statSync(p).isDirectory()); + if (this.options.exclude) { + paths = paths.filter(p => !this.options.exclude.some((excl) => minimatch(p, excl))); + } + paths.forEach(p => { + var folder = path.join(destDir, p); + fsx.mkdirsSync(folder); + var outputPath = path.join(folder, fileName); + fs.writeFileSync(outputPath, data); + }); + }); + }); + } +} diff --git a/tools/broccoli/tree-differ.spec.ts b/tools/broccoli/tree-differ.spec.ts new file mode 100644 index 00000000000..0a2205ca522 --- /dev/null +++ b/tools/broccoli/tree-differ.spec.ts @@ -0,0 +1,378 @@ +/// +/// + +let mockfs = require('mock-fs'); +import fs = require('fs'); +import path = require('path'); +import {TreeDiffer} from './tree-differ'; + + +describe('TreeDiffer', () => { + + afterEach(() => mockfs.restore()); + + + describe('diff of added and changed files', () => { + + it('should list all files (but no directories) during the first diff', () => { + let testDir = { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-2.txt content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.txt': mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)}) + }, + 'empty-dir': {} + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths) + .toEqual(['file-1.txt', 'file-2.txt', 'subdir-1' + path.sep + 'file-1.1.txt']); + + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + }); + + + it('should return empty diff if nothing has changed', () => { + let testDir = { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-2.txt content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.txt': mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)}) + }, + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).not.toEqual([]); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + + diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual([]); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + }); + + + it('should list only changed files during the subsequent diffs', () => { + let testDir = { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-2.txt content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.txt': + mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)}) + } + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths) + .toEqual(['file-1.txt', 'file-2.txt', 'subdir-1' + path.sep + 'file-1.1.txt']); + + // change two files + testDir['dir1']['file-1.txt'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['subdir-1']['file-1.1.txt'] = + mockfs.file({content: 'file-1.1.txt content', mtime: new Date(9999)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + + expect(diffResult.changedPaths) + .toEqual(['file-1.txt', 'subdir-1' + path.sep + 'file-1.1.txt']); + + expect(diffResult.removedPaths).toEqual([]); + + // change one file + testDir['dir1']['file-1.txt'] = mockfs.file({content: 'super new', mtime: new Date(1000)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual(['file-1.txt']); + }); + + + it('should handle changes via symbolic links', () => { + let testDir = { + 'orig_path': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-2.txt content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.txt': mockfs.file({content: 'file-1.1.txt content', mtime: new Date(1000)}) + } + }, + 'symlinks': { + 'file-1.txt': mockfs.symlink({path: '../orig_path/file-1.txt'}), + 'file-2.txt': mockfs.symlink({path: '../orig_path/file-2.txt'}), + 'subdir-1': + {'file-1.1.txt': mockfs.symlink({path: '../../orig_path/subdir-1/file-1.1.txt'})} + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'symlinks'); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths) + .toEqual(['file-1.txt', 'file-2.txt', 'subdir-1' + path.sep + 'file-1.1.txt']); + + // change two files + testDir['orig_path']['file-1.txt'] = + mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['orig_path']['subdir-1']['file-1.1.txt'] = + mockfs.file({content: 'file-1.1.txt content', mtime: new Date(9999)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual([]); + expect(diffResult.changedPaths) + .toEqual(['file-1.txt', 'subdir-1' + path.sep + 'file-1.1.txt']); + expect(diffResult.removedPaths).toEqual([]); + + // change one file + testDir['orig_path']['file-1.txt'] = + mockfs.file({content: 'super new', mtime: new Date(1000)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual(['file-1.txt']); + + // remove a link + delete testDir['orig_path']['file-1.txt']; + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.addedPaths).toEqual([]); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual(['file-1.txt']); + + // don't report it as a removal twice + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + + // re-add it. + testDir['orig_path']['file-1.txt'] = + mockfs.file({content: 'super new', mtime: new Date(1000)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.addedPaths).toEqual(['file-1.txt']); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + }); + + + it("should throw an error if an extension isn't prefixed with doc", () => { + // includeExtensions + expect(() => new TreeDiffer('testLabel', 'dir1', ['js'])) + .toThrowError("Extension must begin with '.'. Was: 'js'"); + + // excludeExtentions + expect(() => new TreeDiffer('testLabel', 'dir1', [], ['js'])) + .toThrowError("Extension must begin with '.'. Was: 'js'"); + }); + + + it('should ignore files with extensions not listed in includeExtensions', () => { + let testDir = { + 'dir1': { + 'file-1.js': mockfs.file({content: 'file-1.js content', mtime: new Date(1000)}), + 'file-2.md': mockfs.file({content: 'file-2.md content', mtime: new Date(1000)}), + 'file-3.coffee': mockfs.file({content: 'file-3.coffee content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.cc': mockfs.file({content: 'file-1.1.cc content', mtime: new Date(1000)}) + } + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1', ['.js', '.coffee']); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual(['file-1.js', 'file-3.coffee']); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + + // change two files + testDir['dir1']['file-1.js'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['file-3.coffee'] = + mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['subdir-1']['file-1.1.cc'] = + mockfs.file({content: 'file-1.1.cc content', mtime: new Date(9999)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual([]); + expect(diffResult.changedPaths).toEqual(['file-1.js', 'file-3.coffee']); + expect(diffResult.removedPaths).toEqual([]); + + // change one file + testDir['dir1']['file-1.js'] = mockfs.file({content: 'super new', mtime: new Date(1000)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual(['file-1.js']); + }); + + + it('should ignore files with extensions listed in excludeExtensions', () => { + let testDir = { + 'dir1': { + 'file-1.ts': mockfs.file({content: 'file-1.ts content', mtime: new Date(1000)}), + 'file-1.cs': mockfs.file({content: 'file-1.cs content', mtime: new Date(1000)}), + 'file-1d.cs': mockfs.file({content: 'file-1d.cs content', mtime: new Date(1000)}), + 'file-1.d.cs': mockfs.file({content: 'file-1.d.cs content', mtime: new Date(1000)}), + 'file-2.md': mockfs.file({content: 'file-2.md content', mtime: new Date(1000)}), + 'file-3.ts': mockfs.file({content: 'file-3.ts content', mtime: new Date(1000)}), + 'file-4.d.ts': mockfs.file({content: 'file-4.d.ts content', mtime: new Date(1000)}), + 'subdir-1': { + 'file-1.1.cc': mockfs.file({content: 'file-1.1.cc content', mtime: new Date(1000)}) + } + } + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1', ['.ts', '.cs'], ['.d.ts', '.d.cs']); + + let diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual(['file-1.cs', 'file-1.ts', 'file-1d.cs', 'file-3.ts']); + + // change two files + testDir['dir1']['file-1.ts'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['file-1.cs'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['file-1.d.cs'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['file-3.ts'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['file-4.d.ts'] = mockfs.file({content: 'new content', mtime: new Date(1000)}); + testDir['dir1']['subdir-1']['file-1.1.cc'] = + mockfs.file({content: 'file-1.1.cc content', mtime: new Date(9999)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + + expect(diffResult.addedPaths).toEqual([]); + expect(diffResult.changedPaths).toEqual(['file-1.cs', 'file-1.ts', 'file-3.ts']); + expect(diffResult.removedPaths).toEqual([]); + + // change one file + testDir['dir1']['file-4.d.ts'] = mockfs.file({content: 'super new', mtime: new Date(1000)}); + mockfs(testDir); + + diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual([]); + }); + }); + + describe('diff of new files', () => { + + it('should detect file additions', () => { + let testDir = { + 'dir1': + {'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)})} + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + differ.diffTree(); + + testDir['dir1']['file-2.txt'] = 'new file'; + mockfs(testDir); + + let diffResult = differ.diffTree(); + expect(diffResult.addedPaths).toEqual(['file-2.txt']); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual([]); + }); + + + it('should detect file additions mixed with file changes', () => { + let testDir = { + 'dir1': + {'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)})} + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + differ.diffTree(); + + testDir['dir1']['file-1.txt'] = 'new content'; + testDir['dir1']['file-2.txt'] = 'new file'; + mockfs(testDir); + + let diffResult = differ.diffTree(); + expect(diffResult.addedPaths).toEqual(['file-2.txt']); + expect(diffResult.changedPaths).toEqual(['file-1.txt']); + }); + }); + + + describe('diff of removed files', () => { + + it('should detect file removals and report them as removed files', () => { + let testDir = { + 'dir1': + {'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)})} + }; + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + differ.diffTree(); + + delete testDir['dir1']['file-1.txt']; + mockfs(testDir); + + let diffResult = differ.diffTree(); + expect(diffResult.changedPaths).toEqual([]); + expect(diffResult.removedPaths).toEqual(['file-1.txt']); + }); + + + it('should detect file removals mixed with file changes and additions', () => { + let testDir = { + 'dir1': { + 'file-1.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}), + 'file-2.txt': mockfs.file({content: 'file-1.txt content', mtime: new Date(1000)}) + } + }; + + mockfs(testDir); + + let differ = new TreeDiffer('testLabel', 'dir1'); + differ.diffTree(); + + testDir['dir1']['file-1.txt'] = 'changed content'; + delete testDir['dir1']['file-2.txt']; + testDir['dir1']['file-3.txt'] = 'new content'; + mockfs(testDir); + + let diffResult = differ.diffTree(); + expect(diffResult.addedPaths).toEqual(['file-3.txt']); + expect(diffResult.changedPaths).toEqual(['file-1.txt']); + expect(diffResult.removedPaths).toEqual(['file-2.txt']); + }); + }); +}); diff --git a/tools/broccoli/tree-differ.ts b/tools/broccoli/tree-differ.ts new file mode 100644 index 00000000000..af3000670fd --- /dev/null +++ b/tools/broccoli/tree-differ.ts @@ -0,0 +1,176 @@ +/// + +import fs = require('fs'); +import path = require('path'); + + +function tryStatSync(path) { + try { + return fs.statSync(path); + } catch (e) { + if (e.code === "ENOENT") return null; + throw e; + } +} + + +export class TreeDiffer { + private fingerprints: {[key: string]: string} = Object.create(null); + private nextFingerprints: {[key: string]: string} = Object.create(null); + private rootDirName: string; + private include: RegExp = null; + private exclude: RegExp = null; + + constructor(private label: string, private rootPath: string, includeExtensions?: string[], + excludeExtensions?: string[]) { + this.rootDirName = path.basename(rootPath); + + let buildRegexp = (arr) => new RegExp(`(${arr.reduce(combine, "")})$`, "i"); + + this.include = (includeExtensions || []).length ? buildRegexp(includeExtensions) : null; + this.exclude = (excludeExtensions || []).length ? buildRegexp(excludeExtensions) : null; + + function combine(prev, curr) { + if (curr.charAt(0) !== ".") { + throw new Error(`Extension must begin with '.'. Was: '${curr}'`); + } + let kSpecialRegexpChars = /[\-\[\]\/\{\}\(\)\*\+\?\.\\\^\$\|]/g; + curr = '(' + curr.replace(kSpecialRegexpChars, '\\$&') + ')'; + return prev ? (prev + '|' + curr) : curr; + } + } + + + public diffTree(): DiffResult { + let result = new DirtyCheckingDiffResult(this.label, this.rootDirName); + this.dirtyCheckPath(this.rootPath, result); + this.detectDeletionsAndUpdateFingerprints(result); + result.endTime = Date.now(); + return result; + } + + + private dirtyCheckPath(rootDir: string, result: DirtyCheckingDiffResult) { + fs.readdirSync(rootDir).forEach((segment) => { + let absolutePath = path.join(rootDir, segment); + let pathStat = fs.lstatSync(absolutePath); + if (pathStat.isSymbolicLink()) { + pathStat = tryStatSync(absolutePath); + if (pathStat === null) return; + } + + if (pathStat.isDirectory()) { + result.directoriesChecked++; + this.dirtyCheckPath(absolutePath, result); + } else { + if (!(this.include && !absolutePath.match(this.include)) && + !(this.exclude && absolutePath.match(this.exclude))) { + result.filesChecked++; + let relativeFilePath = path.relative(this.rootPath, absolutePath); + + switch (this.isFileDirty(absolutePath, pathStat)) { + case FileStatus.Added: + result.addedPaths.push(relativeFilePath); + break; + case FileStatus.Changed: + result.changedPaths.push(relativeFilePath); + } + } + } + }); + + return result; + } + + + private isFileDirty(path: string, stat: fs.Stats): FileStatus { + let oldFingerprint = this.fingerprints[path]; + let newFingerprint = `${stat.mtime.getTime()} # ${stat.size}`; + + this.nextFingerprints[path] = newFingerprint; + + if (oldFingerprint) { + this.fingerprints[path] = null; + + if (oldFingerprint === newFingerprint) { + // nothing changed + return FileStatus.Unchanged; + } + + return FileStatus.Changed; + } + + return FileStatus.Added; + } + + + private detectDeletionsAndUpdateFingerprints(result: DiffResult) { + for (let absolutePath in this.fingerprints) { + if (!(this.include && !absolutePath.match(this.include)) && + !(this.exclude && absolutePath.match(this.exclude))) { + if (this.fingerprints[absolutePath] !== null) { + let relativePath = path.relative(this.rootPath, absolutePath); + result.removedPaths.push(relativePath); + } + } + } + + this.fingerprints = this.nextFingerprints; + this.nextFingerprints = Object.create(null); + } +} + + +export class DiffResult { + public addedPaths: string[] = []; + public changedPaths: string[] = []; + public removedPaths: string[] = []; + + constructor(public label: string = '') {} + + log(verbose: boolean): void {} + + toString(): string { + // TODO(@caitp): more meaningful logging + return ''; + } +} + +class DirtyCheckingDiffResult extends DiffResult { + public filesChecked: number = 0; + public directoriesChecked: number = 0; + public startTime: number = Date.now(); + public endTime: number = null; + + constructor(label: string, public directoryName: string) { super(label); } + + toString() { + return `${pad(this.label, 30)}, ${pad(this.endTime - this.startTime, 5)}ms, ` + + `${pad(this.addedPaths.length + this.changedPaths.length + this.removedPaths.length, 5)} changes ` + + `(files: ${pad(this.filesChecked, 5)}, dirs: ${pad(this.directoriesChecked, 4)})`; + } + + log(verbose) { + let prefixedPaths = this.addedPaths.map(p => `+ ${p}`) + .concat(this.changedPaths.map(p => `* ${p}`)) + .concat(this.removedPaths.map(p => `- ${p}`)); + console.log(`Tree diff: ${this}` + ((verbose && prefixedPaths.length) ? + ` [\n ${prefixedPaths.join('\n ')}\n]` : + '')); + } +} + + +function pad(value, length) { + value = '' + value; + let whitespaceLength = (value.length < length) ? length - value.length : 0; + whitespaceLength = whitespaceLength + 1; + return new Array(whitespaceLength).join(' ') + value; +} + + +enum FileStatus { + Added, + Unchanged, + Changed +} diff --git a/tools/typings/es6-promise/es6-promise.d.ts b/tools/typings/es6-promise/es6-promise.d.ts new file mode 100644 index 00000000000..4a793e540bb --- /dev/null +++ b/tools/typings/es6-promise/es6-promise.d.ts @@ -0,0 +1,71 @@ +// Type definitions for es6-promise +// Project: https://github.com/jakearchibald/ES6-Promise +// Definitions by: François de Campredon , vvakame +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +interface Thenable { + then(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => U | Thenable): Thenable; +} + +declare class Promise implements Thenable { + /** + * If you call resolve in the body of the callback passed to the constructor, + * your promise is fulfilled with result object passed to resolve. + * If you call reject your promise is rejected with the object passed to resolve. + * For consistency and debugging (eg stack traces), obj should be an instanceof Error. + * Any errors thrown in the constructor callback will be implicitly passed to reject(). + */ + constructor(callback: (resolve : (value?: R | Thenable) => void, reject: (error?: any) => void) => void); + + /** + * onFulfilled is called when/if "promise" resolves. onRejected is called when/if "promise" rejects. + * Both are optional, if either/both are omitted the next onFulfilled/onRejected in the chain is called. + * Both callbacks have a single parameter , the fulfillment value or rejection reason. + * "then" returns a new promise equivalent to the value you return from onFulfilled/onRejected after being passed through Promise.resolve. + * If an error is thrown in the callback, the returned promise rejects with that error. + * + * @param onFulfilled called when/if "promise" resolves + * @param onRejected called when/if "promise" rejects + */ + then(onFulfilled?: (value: R) => U | Thenable, onRejected?: (error: any) => U | Thenable): Promise; + + /** + * Sugar for promise.then(undefined, onRejected) + * + * @param onRejected called when/if "promise" rejects + */ + catch(onRejected?: (error: any) => U | Thenable): Promise; +} + +declare module Promise { + /** + * Make a new promise from the thenable. + * A thenable is promise-like in as far as it has a "then" method. + */ + function resolve(value?: R | Thenable): Promise; + + /** + * Make a promise that rejects to obj. For consistency and debugging (eg stack traces), obj should be an instanceof Error + */ + function reject(error: any): Promise; + + /** + * Make a promise that fulfills when every item in the array fulfills, and rejects if (and when) any item rejects. + * the array passed to all can be a mixture of promise-like objects and other objects. + * The fulfillment value is an array (in order) of fulfillment values. The rejection value is the first rejection value. + */ + function all(promises: (R | Thenable)[]): Promise; + + /** + * Make a Promise that fulfills when any item fulfills, and rejects if any item rejects. + */ + function race(promises: (R | Thenable)[]): Promise; +} + +declare module 'es6-promise' { + var foo: typeof Promise; // Temp variable to reference Promise in local context + module rsvp { + export var Promise: typeof foo; + } + export = rsvp; +} diff --git a/tools/typings/fs-extra/fs-extra.d.ts b/tools/typings/fs-extra/fs-extra.d.ts new file mode 100644 index 00000000000..852956a71bb --- /dev/null +++ b/tools/typings/fs-extra/fs-extra.d.ts @@ -0,0 +1,195 @@ +// Type definitions for fs-extra +// Project: https://github.com/jprichardson/node-fs-extra +// Definitions by: midknight41 +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +// Imported from: https://github.com/soywiz/typescript-node-definitions/fs-extra.d.ts + +/// + +declare module "fs-extra" { + import stream = require("stream"); + + export 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; + } + + export interface FSWatcher { + close(): void; + } + + export class ReadStream extends stream.Readable { } + export class WriteStream extends stream.Writable { } + + //extended methods + export function copy(src: string, dest: string, callback?: (err: Error) => void): void; + export function copy(src: string, dest: string, filter: (src: string) => boolean, callback?: (err: Error) => void): void; + + export function copySync(src: string, dest: string): void; + export function copySync(src: string, dest: string, filter: (src: string) => boolean): void; + + export function createFile(file: string, callback?: (err: Error) => void): void; + export function createFileSync(file: string): void; + + export function mkdirs(dir: string, callback?: (err: Error) => void): void; + export function mkdirp(dir: string, callback?: (err: Error) => void): void; + export function mkdirs(dir: string, options?: MkdirOptions, callback?: (err: Error) => void): void; + export function mkdirp(dir: string, options?: MkdirOptions, callback?: (err: Error) => void): void; + export function mkdirsSync(dir: string, options?: MkdirOptions): void; + export function mkdirpSync(dir: string, options?: MkdirOptions): void; + + export function outputFile(file: string, data: any, callback?: (err: Error) => void): void; + export function outputFileSync(file: string, data: any): void; + + export function outputJson(file: string, data: any, callback?: (err: Error) => void): void; + export function outputJSON(file: string, data: any, callback?: (err: Error) => void): void; + export function outputJsonSync(file: string, data: any): void; + export function outputJSONSync(file: string, data: any): void; + + export function readJson(file: string, callback?: (err: Error) => void): void; + export function readJson(file: string, options?: OpenOptions, callback?: (err: Error) => void): void; + export function readJSON(file: string, callback?: (err: Error) => void): void; + export function readJSON(file: string, options?: OpenOptions, callback?: (err: Error) => void): void; + + export function readJsonSync(file: string, options?: OpenOptions): void; + export function readJSONSync(file: string, options?: OpenOptions): void; + + export function remove(dir: string, callback?: (err: Error) => void): void; + export function removeSync(dir: string): void; + // export function delete(dir: string, callback?: (err: Error) => void): void; + // export function deleteSync(dir: string): void; + + export function writeJson(file: string, object: any, callback?: (err: Error) => void): void; + export function writeJson(file: string, object: any, options?: OpenOptions, callback?: (err: Error) => void): void; + export function writeJSON(file: string, object: any, callback?: (err: Error) => void): void; + export function writeJSON(file: string, object: any, options?: OpenOptions, callback?: (err: Error) => void): void; + + export function writeJsonSync(file: string, object: any, options?: OpenOptions): void; + export function writeJSONSync(file: string, object: any, options?: OpenOptions): void; + + export function rename(oldPath: string, newPath: string, callback?: (err: Error) => void): void; + export function renameSync(oldPath: string, newPath: string): void; + export function truncate(fd: number, len: number, callback?: (err: Error) => void): void; + export function truncateSync(fd: number, len: number): void; + export function chown(path: string, uid: number, gid: number, callback?: (err: Error) => void): void; + export function chownSync(path: string, uid: number, gid: number): void; + export function fchown(fd: number, uid: number, gid: number, callback?: (err: Error) => void): void; + export function fchownSync(fd: number, uid: number, gid: number): void; + export function lchown(path: string, uid: number, gid: number, callback?: (err: Error) => void): void; + export function lchownSync(path: string, uid: number, gid: number): void; + export function chmod(path: string, mode: number, callback?: (err: Error) => void): void; + export function chmod(path: string, mode: string, callback?: (err: Error) => 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: Error) => void): void; + export function fchmod(fd: number, mode: string, callback?: (err: Error) => void): void; + export function fchmodSync(fd: number, mode: number): void; + export function fchmodSync(fd: number, mode: string): void; + export function lchmod(path: string, mode: string, callback?: (err: Error) => void): void; + export function lchmod(path: string, mode: number, callback?: (err: Error) => 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: Error, stats: Stats) => void): void; + export function lstat(path: string, callback?: (err: Error, stats: Stats) => void): void; + export function fstat(fd: number, callback?: (err: Error, stats: Stats) => void): 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: Error) => void): void; + export function linkSync(srcpath: string, dstpath: string): void; + export function symlink(srcpath: string, dstpath: string, type?: string, callback?: (err: Error) => void): void; + export function symlinkSync(srcpath: string, dstpath: string, type?: string): void; + export function readlink(path: string, callback?: (err: Error, linkString: string) => void): void; + export function realpath(path: string, callback?: (err: Error, resolvedPath: string) => void): void; + export function realpath(path: string, cache: string, callback: (err: Error, resolvedPath: string) => void): void; + export function realpathSync(path: string, cache?: boolean): string; + export function unlink(path: string, callback?: (err: Error) => void): void; + export function unlinkSync(path: string): void; + export function rmdir(path: string, callback?: (err: Error) => void): void; + export function rmdirSync(path: string): void; + export function mkdir(path: string, mode?: number, callback?: (err: Error) => void): void; + export function mkdir(path: string, mode?: string, callback?: (err: Error) => void): void; + export function mkdirSync(path: string, mode?: number): void; + export function mkdirSync(path: string, mode?: string): void; + export function readdir(path: string, callback?: (err: Error, files: string[]) => void ): void; + export function readdirSync(path: string): string[]; + export function close(fd: number, callback?: (err: Error) => void): void; + export function closeSync(fd: number): void; + export function open(path: string, flags: string, mode?: string, callback?: (err: Error, fs: number) => void): void; + export function openSync(path: string, flags: string, mode?: string): number; + export function utimes(path: string, atime: number, mtime: number, callback?: (err: Error) => void): void; + export function utimesSync(path: string, atime: number, mtime: number): void; + export function futimes(fd: number, atime: number, mtime: number, callback?: (err: Error) => void): void; + export function futimesSync(fd: number, atime: number, mtime: number): void; + export function fsync(fd: number, callback?: (err: Error) => void): void; + export function fsyncSync(fd: number): void; + export function write(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err: Error, written: number, buffer: NodeBuffer) => void): void; + export function writeSync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): number; + export function read(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number, callback?: (err: Error, bytesRead: number, buffer: NodeBuffer) => void ): void; + export function readSync(fd: number, buffer: NodeBuffer, offset: number, length: number, position: number): number; + export function readFile(filename: string, encoding: string, callback: (err: Error, data: string) => void ): void; + export function readFile(filename: string, options: OpenOptions, callback: (err: Error, data: string) => void ): void; + export function readFile(filename: string, callback: (err: Error, data: NodeBuffer) => void ): void; + export function readFileSync(filename: string): NodeBuffer; + export function readFileSync(filename: string, encoding: string): string; + export function readFileSync(filename: string, options: OpenOptions): string; + export function writeFile(filename: string, data: any, encoding?: string, callback?: (err: Error) => void): void; + export function writeFile(filename: string, data: any, options?: OpenOptions, callback?: (err: Error) => void): void; + export function writeFileSync(filename: string, data: any, encoding?: string): void; + export function writeFileSync(filename: string, data: any, option?: OpenOptions): void; + export function appendFile(filename: string, data: any, encoding?: string, callback?: (err: Error) => void): void; + export function appendFile(filename: string, data: any,option?: OpenOptions, callback?: (err: Error) => void): void; + export function appendFileSync(filename: string, data: any, encoding?: string): void; + export function appendFileSync(filename: string, data: any, option?: OpenOptions): void; + export function watchFile(filename: string, listener: { curr: Stats; prev: Stats; }): void; + export function watchFile(filename: string, options: { persistent?: boolean; interval?: number; }, listener: { curr: Stats; prev: Stats; }): void; + export function unwatchFile(filename: string, listener?: Stats): void; + 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; + export function ensureDir(path: string, cb: (err: Error) => void): void; + + export interface OpenOptions { + encoding?: string; + flag?: string; + } + + export interface MkdirOptions { + fs?: any; + mode?: number; + } + + export interface ReadStreamOptions { + flags?: string; + encoding?: string; + fd?: number; + mode?: number; + bufferSize?: number; + } + export interface WriteStreamOptions { + flags?: string; + encoding?: string; + string?: string; + } + export function createReadStream(path: string, options?: ReadStreamOptions): ReadStream; + export function createWriteStream(path: string, options?: WriteStreamOptions): WriteStream; +} diff --git a/tools/typings/jasmine/jasmine.d.ts b/tools/typings/jasmine/jasmine.d.ts new file mode 100644 index 00000000000..2b34dd0d39a --- /dev/null +++ b/tools/typings/jasmine/jasmine.d.ts @@ -0,0 +1,517 @@ +// Type definitions for Jasmine 2.2 +// Project: http://jasmine.github.io/ +// Definitions by: Boris Yankov , Theodore Brown , David Pärsson +// Definitions: https://github.com/borisyankov/DefinitelyTyped + + +// For ddescribe / iit use : https://github.com/borisyankov/DefinitelyTyped/blob/master/karma-jasmine/karma-jasmine.d.ts + +declare function describe(description: string, specDefinitions: () => void): void; +declare function fdescribe(description: string, specDefinitions: () => void): void; +declare function xdescribe(description: string, specDefinitions: () => void): void; + +declare function it(expectation: string, assertion?: () => void): void; +declare function it(expectation: string, assertion?: (done: () => void) => void): void; +declare function fit(expectation: string, assertion?: () => void): void; +declare function fit(expectation: string, assertion?: (done: () => void) => void): void; +declare function xit(expectation: string, assertion?: () => void): void; +declare function xit(expectation: string, assertion?: (done: () => void) => void): void; + +/** If you call the function pending anywhere in the spec body, no matter the expectations, the spec will be marked pending. */ +declare function pending(reason?: string): void; + +declare function beforeEach(action: () => void): void; +declare function beforeEach(action: (done: () => void) => void): void; +declare function afterEach(action: () => void): void; +declare function afterEach(action: (done: () => void) => void): void; + +declare function beforeAll(action: () => void): void; +declare function beforeAll(action: (done: () => void) => void): void; +declare function afterAll(action: () => void): void; +declare function afterAll(action: (done: () => void) => void): void; + +declare function expect(spy: Function): jasmine.Matchers; +declare function expect(actual: any): jasmine.Matchers; + +declare function fail(e?: any): void; + +declare function spyOn(object: any, method: string): jasmine.Spy; + +declare function runs(asyncMethod: Function): void; +declare function waitsFor(latchMethod: () => boolean, failureMessage?: string, timeout?: number): void; +declare function waits(timeout?: number): void; + +declare module jasmine { + + var clock: () => Clock; + + function any(aclass: any): Any; + function objectContaining(sample: any): ObjectContaining; + export function createSpy(name: string, originalFn?: Function): Spy; + export function createSpyObj(baseName: string, methodNames: any[]): any; + export function createSpyObj(baseName: string, methodNames: any[]): T; + function pp(value: any): string; + function getEnv(): Env; + function addCustomEqualityTester(equalityTester: CustomEqualityTester): void; + function addMatchers(matchers: CustomMatcherFactories): void; + + interface Any { + + new (expectedClass: any): any; + + jasmineMatches(other: any): boolean; + jasmineToString(): string; + } + + // taken from TypeScript lib.core.es6.d.ts, applicable to CustomMatchers.contains() + interface ArrayLike { + length: number; + [n: number]: T; + } + + interface ObjectContaining { + new (sample: any): any; + + jasmineMatches(other: any, mismatchKeys: any[], mismatchValues: any[]): boolean; + jasmineToString(): string; + } + + interface Block { + + new (env: Env, func: SpecFunction, spec: Spec): any; + + execute(onComplete: () => void): void; + } + + interface WaitsBlock extends Block { + new (env: Env, timeout: number, spec: Spec): any; + } + + interface WaitsForBlock extends Block { + new (env: Env, timeout: number, latchFunction: SpecFunction, message: string, spec: Spec): any; + } + + interface Clock { + install(): void; + uninstall(): void; + /** Calls to any registered callback are triggered when the clock is ticked forward via the jasmine.clock().tick function, which takes a number of milliseconds. */ + tick(ms: number): void; + } + + interface CustomEqualityTester { + (first: any, second: any): boolean; + } + + interface CustomMatcher { + compare(actual: T, expected: T): CustomMatcherResult; + compare(actual: any, expected: any): CustomMatcherResult; + } + + interface CustomMatcherFactory { + (util: MatchersUtil, customEqualityTesters: Array): CustomMatcher; + } + + interface CustomMatcherFactories { + [index: string]: CustomMatcherFactory; + } + + interface CustomMatcherResult { + pass: boolean; + message: string; + } + + interface MatchersUtil { + equals(a: any, b: any, customTesters?: Array): boolean; + contains(haystack: ArrayLike | string, needle: any, customTesters?: Array): boolean; + buildFailureMessage(matcherName: string, isNot: boolean, actual: any, ...expected: Array): string; + } + + interface Env { + setTimeout: any; + clearTimeout: void; + setInterval: any; + clearInterval: void; + updateInterval: number; + + currentSpec: Spec; + + matchersClass: Matchers; + + version(): any; + versionString(): string; + nextSpecId(): number; + addReporter(reporter: Reporter): void; + execute(): void; + describe(description: string, specDefinitions: () => void): Suite; + // ddescribe(description: string, specDefinitions: () => void): Suite; Not a part of jasmine. Angular team adds these + beforeEach(beforeEachFunction: () => void): void; + beforeAll(beforeAllFunction: () => void): void; + currentRunner(): Runner; + afterEach(afterEachFunction: () => void): void; + afterAll(afterAllFunction: () => void): void; + xdescribe(desc: string, specDefinitions: () => void): XSuite; + it(description: string, func: () => void): Spec; + // iit(description: string, func: () => void): Spec; Not a part of jasmine. Angular team adds these + xit(desc: string, func: () => void): XSpec; + compareRegExps_(a: RegExp, b: RegExp, mismatchKeys: string[], mismatchValues: string[]): boolean; + compareObjects_(a: any, b: any, mismatchKeys: string[], mismatchValues: string[]): boolean; + equals_(a: any, b: any, mismatchKeys: string[], mismatchValues: string[]): boolean; + contains_(haystack: any, needle: any): boolean; + addCustomEqualityTester(equalityTester: CustomEqualityTester): void; + addMatchers(matchers: CustomMatcherFactories): void; + specFilter(spec: Spec): boolean; + } + + interface FakeTimer { + + new (): any; + + reset(): void; + tick(millis: number): void; + runFunctionsWithinRange(oldMillis: number, nowMillis: number): void; + scheduleFunction(timeoutKey: any, funcToCall: () => void, millis: number, recurring: boolean): void; + } + + interface HtmlReporter { + new (): any; + } + + interface HtmlSpecFilter { + new (): any; + } + + interface Result { + type: string; + } + + interface NestedResults extends Result { + description: string; + + totalCount: number; + passedCount: number; + failedCount: number; + + skipped: boolean; + + rollupCounts(result: NestedResults): void; + log(values: any): void; + getItems(): Result[]; + addResult(result: Result): void; + passed(): boolean; + } + + interface MessageResult extends Result { + values: any; + trace: Trace; + } + + interface ExpectationResult extends Result { + matcherName: string; + passed(): boolean; + expected: any; + actual: any; + message: string; + trace: Trace; + } + + interface Trace { + name: string; + message: string; + stack: any; + } + + interface PrettyPrinter { + + new (): any; + + format(value: any): void; + iterateObject(obj: any, fn: (property: string, isGetter: boolean) => void): void; + emitScalar(value: any): void; + emitString(value: string): void; + emitArray(array: any[]): void; + emitObject(obj: any): void; + append(value: any): void; + } + + interface StringPrettyPrinter extends PrettyPrinter { + } + + interface Queue { + + new (env: any): any; + + env: Env; + ensured: boolean[]; + blocks: Block[]; + running: boolean; + index: number; + offset: number; + abort: boolean; + + addBefore(block: Block, ensure?: boolean): void; + add(block: any, ensure?: boolean): void; + insertNext(block: any, ensure?: boolean): void; + start(onComplete?: () => void): void; + isRunning(): boolean; + next_(): void; + results(): NestedResults; + } + + interface Matchers { + + new (env: Env, actual: any, spec: Env, isNot?: boolean): any; + + env: Env; + actual: any; + spec: Env; + isNot?: boolean; + message(): any; + + + (expected: any): boolean; + toEqual(expected: any): boolean; + toMatch(expected: any): boolean; + toBe(expected: any): boolean; + toBeDefined(): boolean; + toBeUndefined(): boolean; + toBeNull(): boolean; + toBeNaN(): boolean; + toBeTruthy(): boolean; + toBeFalsy(): boolean; + toHaveBeenCalled(): boolean; + toHaveBeenCalledWith(...params: any[]): boolean; + toContain(expected: any): boolean; + toBeLessThan(expected: any): boolean; + toBeGreaterThan(expected: any): boolean; + toBeCloseTo(expected: any, precision: any): boolean; + toContainHtml(expected: string): boolean; + toContainText(expected: string): boolean; + toThrow(expected?: any): boolean; + toThrowError(expected?: any): boolean; + + not: Matchers; + + Any: Any; + } + + interface Reporter { + reportRunnerStarting(runner: Runner): void; + reportRunnerResults(runner: Runner): void; + reportSuiteResults(suite: Suite): void; + reportSpecStarting(spec: Spec): void; + reportSpecResults(spec: Spec): void; + log(str: string): void; + } + + interface MultiReporter extends Reporter { + addReporter(reporter: Reporter): void; + } + + interface Runner { + + new (env: Env): any; + + execute(): void; + beforeEach(beforeEachFunction: SpecFunction): void; + afterEach(afterEachFunction: SpecFunction): void; + beforeAll(beforeAllFunction: SpecFunction): void; + afterAll(afterAllFunction: SpecFunction): void; + finishCallback(): void; + addSuite(suite: Suite): void; + add(block: Block): void; + specs(): Spec[]; + suites(): Suite[]; + topLevelSuites(): Suite[]; + results(): NestedResults; + } + + interface SpecFunction { + (spec?: Spec): void; + } + + interface SuiteOrSpec { + id: number; + env: Env; + description: string; + queue: Queue; + } + + interface Spec extends SuiteOrSpec { + + new (env: Env, suite: Suite, description: string): any; + + suite: Suite; + + afterCallbacks: SpecFunction[]; + spies_: Spy[]; + + results_: NestedResults; + matchersClass: Matchers; + + getFullName(): string; + results(): NestedResults; + log(arguments: any): any; + runs(func: SpecFunction): Spec; + addToQueue(block: Block): void; + addMatcherResult(result: Result): void; + expect(actual: any): any; + waits(timeout: number): Spec; + waitsFor(latchFunction: SpecFunction, timeoutMessage?: string, timeout?: number): Spec; + fail(e?: any): void; + getMatchersClass_(): Matchers; + addMatchers(matchersPrototype: CustomMatcherFactories): void; + finishCallback(): void; + finish(onComplete?: () => void): void; + after(doAfter: SpecFunction): void; + execute(onComplete?: () => void): any; + addBeforesAndAftersToQueue(): void; + explodes(): void; + spyOn(obj: any, methodName: string, ignoreMethodDoesntExist: boolean): Spy; + removeAllSpies(): void; + } + + interface XSpec { + id: number; + runs(): void; + } + + interface Suite extends SuiteOrSpec { + + new (env: Env, description: string, specDefinitions: () => void, parentSuite: Suite): any; + + parentSuite: Suite; + + getFullName(): string; + finish(onComplete?: () => void): void; + beforeEach(beforeEachFunction: SpecFunction): void; + afterEach(afterEachFunction: SpecFunction): void; + beforeAll(beforeAllFunction: SpecFunction): void; + afterAll(afterAllFunction: SpecFunction): void; + results(): NestedResults; + add(suiteOrSpec: SuiteOrSpec): void; + specs(): Spec[]; + suites(): Suite[]; + children(): any[]; + execute(onComplete?: () => void): void; + } + + interface XSuite { + execute(): void; + } + + interface Spy { + (...params: any[]): any; + + identity: string; + and: SpyAnd; + calls: Calls; + mostRecentCall: { args: any[]; }; + argsForCall: any[]; + wasCalled: boolean; + callCount: number; + } + + interface SpyAnd { + /** By chaining the spy with and.callThrough, the spy will still track all calls to it but in addition it will delegate to the actual implementation. */ + callThrough(): Spy; + /** By chaining the spy with and.returnValue, all calls to the function will return a specific value. */ + returnValue(val: any): void; + /** By chaining the spy with and.callFake, all calls to the spy will delegate to the supplied function. */ + callFake(fn: Function): Spy; + /** By chaining the spy with and.throwError, all calls to the spy will throw the specified value. */ + throwError(msg: string): void; + /** When a calling strategy is used for a spy, the original stubbing behavior can be returned at any time with and.stub. */ + stub(): Spy; + } + + interface Calls { + /** By chaining the spy with calls.any(), will return false if the spy has not been called at all, and then true once at least one call happens. **/ + any(): boolean; + /** By chaining the spy with calls.count(), will return the number of times the spy was called **/ + count(): number; + /** By chaining the spy with calls.argsFor(), will return the arguments passed to call number index **/ + argsFor(index: number): any[]; + /** By chaining the spy with calls.allArgs(), will return the arguments to all calls **/ + allArgs(): any[]; + /** By chaining the spy with calls.all(), will return the context (the this) and arguments passed all calls **/ + all(): any; + /** By chaining the spy with calls.mostRecent(), will return the context (the this) and arguments for the most recent call **/ + mostRecent(): any; + /** By chaining the spy with calls.first(), will return the context (the this) and arguments for the first call **/ + first(): any; + /** By chaining the spy with calls.reset(), will clears all tracking for a spy **/ + reset(): void; + } + + interface Util { + inherit(childClass: Function, parentClass: Function): any; + formatException(e: any): any; + htmlEscape(str: string): string; + argsToArray(args: any): any; + extend(destination: any, source: any): any; + } + + interface JsApiReporter extends Reporter { + + started: boolean; + finished: boolean; + result: any; + messages: any; + + new (): any; + + suites(): Suite[]; + summarize_(suiteOrSpec: SuiteOrSpec): any; + results(): any; + resultsForSpec(specId: any): any; + log(str: any): any; + resultsForSpecs(specIds: any): any; + summarizeResult_(result: any): any; + } + + interface Jasmine { + Spec: Spec; + clock: Clock; + util: Util; + } + + export var HtmlReporter: HtmlReporter; + export var HtmlSpecFilter: HtmlSpecFilter; + export var DEFAULT_TIMEOUT_INTERVAL: number; + + export interface GlobalPolluter { + describe(description: string, specDefinitions: () => void): void; + fdescribe(description: string, specDefinitions: () => void): void; + xdescribe(description: string, specDefinitions: () => void): void; + + it(expectation: string, assertion?: () => void): void; + it(expectation: string, assertion?: (done: () => void) => void): void; + fit(expectation: string, assertion?: () => void): void; + fit(expectation: string, assertion?: (done: () => void) => void): void; + xit(expectation: string, assertion?: () => void): void; + xit(expectation: string, assertion?: (done: () => void) => void): void; + + pending(): void; + + beforeEach(action: () => void): void; + beforeEach(action: (done: () => void) => void): void; + afterEach(action: () => void): void; + afterEach(action: (done: () => void) => void): void; + + beforeAll(action: () => void): void; + beforeAll(action: (done: () => void) => void): void; + afterAll(action: () => void): void; + afterAll(action: (done: () => void) => void): void; + + expect(spy: Function): jasmine.Matchers; + expect(actual: any): jasmine.Matchers; + + fail(e?: any): void; + + spyOn(object: any, method: string): jasmine.Spy; + + runs(asyncMethod: Function): void; + waitsFor(latchMethod: () => boolean, failureMessage?: string, timeout?: number): void; + waits(timeout?: number): void; + } +} diff --git a/tools/typings/node/node.d.ts b/tools/typings/node/node.d.ts new file mode 100644 index 00000000000..7498e401f15 --- /dev/null +++ b/tools/typings/node/node.d.ts @@ -0,0 +1,2077 @@ +// Type definitions for Node.js v0.12.0 +// Project: http://nodejs.org/ +// Definitions by: Microsoft TypeScript , DefinitelyTyped +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/************************************************ +* * +* Node.js v0.12.0 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): boolean; + /** + * 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, cb?: Function): boolean; + write(str: 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; + } + + 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): void; + writeUInt16LE(value: number, offset: number, noAssert?: boolean): void; + writeUInt16BE(value: number, offset: number, noAssert?: boolean): void; + writeUInt32LE(value: number, offset: number, noAssert?: boolean): void; + writeUInt32BE(value: number, offset: number, noAssert?: boolean): void; + writeInt8(value: number, offset: number, noAssert?: boolean): void; + writeInt16LE(value: number, offset: number, noAssert?: boolean): void; + writeInt16BE(value: number, offset: number, noAssert?: boolean): void; + writeInt32LE(value: number, offset: number, noAssert?: boolean): void; + writeInt32BE(value: number, offset: number, noAssert?: boolean): void; + writeFloatLE(value: number, offset: number, noAssert?: boolean): void; + writeFloatBE(value: number, offset: number, noAssert?: boolean): void; + writeDoubleLE(value: number, offset: number, noAssert?: boolean): void; + writeDoubleBE(value: number, offset: number, noAssert?: boolean): void; + fill(value: any, offset?: number, end?: number): void; +} + +/************************************************ +* * +* 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 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: any, 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 { + host?: string; + hostname?: string; + port?: number; + path?: string; + method?: string; + headers?: any; + auth?: string; + agent?: any; + pfx?: any; + key?: any; + passphrase?: string; + cert?: any; + ca?: any; + ciphers?: string; + rejectUnauthorized?: boolean; + } + + 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): string; + 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?: string; + 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 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; + }): ChildProcess; + 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; + }): ChildProcess; +} + +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 interface UrlOptions { + protocol?: string; + auth?: string; + hostname?: string; + port?: string; + host?: string; + pathname?: string; + search?: string; + query?: any; + hash?: string; + path?: string; + } + + export function parse(urlStr: string, parseQueryString?: boolean , slashesDenoteHost?: boolean ): Url; + export function format(url: UrlOptions): 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: { 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: { 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?: string; + mode?: number; + bufferSize?: number; + }): ReadStream; + export function createReadStream(path: string, options?: { + flags?: string; + encoding?: string; + fd?: string; + mode?: string; + bufferSize?: number; + }): ReadStream; + export function createWriteStream(path: string, options?: { + flags?: string; + encoding?: string; + string?: string; + }): 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; + } + + 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; +} + +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/tools/typings/tsd.d.ts b/tools/typings/tsd.d.ts new file mode 100644 index 00000000000..3791dd7c830 --- /dev/null +++ b/tools/typings/tsd.d.ts @@ -0,0 +1,4 @@ +/// +/// +/// +///