From 9371775cde09a6c0a80caaa31e6c0de1bf42f386 Mon Sep 17 00:00:00 2001 From: Drew Noakes Date: Mon, 8 Sep 2014 16:59:28 +0100 Subject: [PATCH] Add gulp declarations. --- gulp/gulp-tests.ts | 19 +++ gulp/gulp.d.ts | 288 +++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 307 insertions(+) create mode 100644 gulp/gulp-tests.ts create mode 100644 gulp/gulp.d.ts diff --git a/gulp/gulp-tests.ts b/gulp/gulp-tests.ts new file mode 100644 index 00000000000000..372c5e258c283f --- /dev/null +++ b/gulp/gulp-tests.ts @@ -0,0 +1,19 @@ +/// + +var typescript: any = null; // this would be the TypeScript compiler +var jasmine: any = null; // this would be the jasmine test runner + +gulp.task('compile', function() +{ + gulp.src("**/*.ts") + .pipe(typescript) + .dest('out') +}); + +gulp.task('test', ['compile'], function() +{ + gulp.src("out/test/**/*.js") + .pipe(jasmine); +}); + +gulp.task('default', ['compile', 'test']); diff --git a/gulp/gulp.d.ts b/gulp/gulp.d.ts new file mode 100644 index 00000000000000..201c656a135d5f --- /dev/null +++ b/gulp/gulp.d.ts @@ -0,0 +1,288 @@ +// Type definitions for Gulp v3.8.x +// Project: http://gulpjs.com +// Definitions by: Drew Noakes +// Definitions: https://github.com/borisyankov/DefinitelyTyped + +/** + * Options to pass to node-glob through glob-stream. + * Specifies two options in addition to those used by node-glob: + * https://github.com/isaacs/node-glob#options + */ +interface ISrcOptions +{ + /** + * Setting this to false will return file.contents as null + * and not read the file at all. + * Default: true. + */ + read?: boolean; + + /** + * Setting this to false will return file.contents as a stream and not buffer files. + * This is useful when working with large files. + * Note: Plugins might not implement support for streams. + * Default: true. + */ + buffer?: boolean; + + /** + * The current working directory in which to search. + * Defaults to process.cwd(). + */ + cwd?: string; + + /** + * The place where patterns starting with / will be mounted onto. + * Defaults to path.resolve(options.cwd, "/") (/ on Unix systems, and C:\ or some such on Windows.) + */ + root?: string; + + /** + * Include .dot files in normal matches and globstar matches. + * Note that an explicit dot in a portion of the pattern will always match dot files. + */ + dot?: boolean; + + /** + * By default, a pattern starting with a forward-slash will be "mounted" onto the root setting, so that a valid + * filesystem path is returned. Set this flag to disable that behavior. + */ + nomount?: boolean; + + /** + * Add a / character to directory matches. Note that this requires additional stat calls. + */ + mark?: boolean; + + /** + * Don't sort the results. + */ + nosort?: boolean; + + /** + * Set to true to stat all results. This reduces performance somewhat, and is completely unnecessary, unless + * readdir is presumed to be an untrustworthy indicator of file existence. It will cause ELOOP to be triggered one + * level sooner in the case of cyclical symbolic links. + */ + stat?: boolean; + + /** + * When an unusual error is encountered when attempting to read a directory, a warning will be printed to stderr. + * Set the silent option to true to suppress these warnings. + */ + silent?: boolean; + + /** + * When an unusual error is encountered when attempting to read a directory, the process will just continue on in + * search of other matches. Set the strict option to raise an error in these cases. + */ + strict?: boolean; + + /** + * See cache property above. Pass in a previously generated cache object to save some fs calls. + */ + cache?: boolean; + + /** + * A cache of results of filesystem information, to prevent unnecessary stat calls. + * While it should not normally be necessary to set this, you may pass the statCache from one glob() call to the + * options object of another, if you know that the filesystem will not change between calls. + */ + statCache?: boolean; + + /** + * Perform a synchronous glob search. + */ + sync?: boolean; + + /** + * In some cases, brace-expanded patterns can result in the same file showing up multiple times in the result set. + * By default, this implementation prevents duplicates in the result set. Set this flag to disable that behavior. + */ + nounique?: boolean; + + /** + * Set to never return an empty set, instead returning a set containing the pattern itself. + * This is the default in glob(3). + */ + nonull?: boolean; + + /** + * Perform a case-insensitive match. Note that case-insensitive filesystems will sometimes result in glob returning + * results that are case-insensitively matched anyway, since readdir and stat will not raise an error. + */ + nocase?: boolean; + + /** + * Set to enable debug logging in minimatch and glob. + */ + debug?: boolean; + + /** + * Set to enable debug logging in glob, but not minimatch. + */ + globDebug?: boolean; +} + +interface IDestOptions +{ + /** + * The output folder. Only has an effect if provided output folder is relative. + * Default: process.cwd() + */ + cwd?: string; + + /** + * Octal permission string specifying mode for any folders that need to be created for output folder. + * Default: 0777. + */ + mode?: string; +} + +/** + * Options that are passed to gaze. + * https://github.com/shama/gaze + */ +interface IWatchOptions +{ + /** Interval to pass to fs.watchFile. */ + interval?: number; + /** Delay for events called in succession for the same file/event. */ + debounceDelay?: number; + /** Force the watch mode. Either 'auto' (default), 'watch' (force native events), or 'poll' (force stat polling). */ + mode?: string; + /** The current working directory to base file patterns from. Default is process.cwd().. */ + cwd?: string; +} + +interface IWatchEvent +{ + /** The type of change that occurred, either added, changed or deleted. */ + type: string; + /** The path to the file that triggered the event. */ + path: string; +} + +/** + * Callback to be called on each watched file change. + */ +interface IWatchCallback +{ + (event: IWatchEvent): void; +} + +interface ITaskCallback +{ + /** + * Defines a task. + * Tasks may be made asynchronous if they return a promise or a stream. + */ + (): any; + + /** + * Defines an asynchronous task. + * @param cb callback used to signal asynchronous completion. Caller includes err in case of error. + */ + (cb: (err?: any)=>void): void; +} + +interface EventEmitter +{ + any: any; +} + +declare class Gulp +{ + /** + * Define a task. + * + * @param name the name of the task. Tasks that you want to run from the command line should not have spaces in them. + * @param fn the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()). + */ + task(name: string, fn: ITaskCallback): Gulp; + + /** + * Define a task. + * + * @param name the name of the task. Tasks that you want to run from the command line should not have spaces in them. + * @param dep an array of tasks to be executed and completed before your task will run. + * @param fn the function that performs the task's operations. Generally this takes the form of gulp.src().pipe(someplugin()). + */ + task(name: string, dep: string[], fn?: ITaskCallback): Gulp; + + + /** + * Takes a glob and represents a file structure. Can be piped to plugins. + * @param glob a glob string, using node-glob syntax + * @param opt an optional option object + */ + src(glob: string, opt?: ISrcOptions): Gulp; + + /** + * Takes a glob and represents a file structure. Can be piped to plugins. + * @param glob an array of glob strings, using node-glob syntax + * @param opt an optional option object + */ + src(glob: string[], opt?: ISrcOptions): Gulp; + + + /** + * Can be piped to and it will write files. Re-emits all data passed to it so you can pipe to multiple folders. + * Folders that don't exist will be created. + * + * @param outFolder the path (output folder) to write files to. + * @param opt + */ + dest(outFolder: string, opt?: IDestOptions): Gulp; + + /** + * Can be piped to and it will write files. Re-emits all data passed to it so you can pipe to multiple folders. + * Folders that don't exist will be created. + * + * @param outFolder a function that converts a vinyl File instance into an output path + * @param opt + */ + dest(outFolder: (file: string)=>string, opt?: IDestOptions): Gulp; + + + /** + * Forwards the current Gulp instance, along with its contained files, to the specified receiver. + * + * @param receiver the receiver + */ + pipe(receiver: any): Gulp; + + + /** + * Watch files and do something when a file changes. This always returns an EventEmitter that emits change events. + * + * @param glob a single glob or array of globs that indicate which files to watch for changes. + * @param opt options, that are passed to the gaze library. + * @param tasks names of task(s) to run when a file changes, added with gulp.task() + */ + watch(glob: string, opt: IWatchOptions, tasks: string[]): EventEmitter; + watch(glob: string[], opt: IWatchOptions, tasks: string[]): EventEmitter; + + /** + * Watch files and do something when a file changes. This always returns an EventEmitter that emits change events. + * + * @param glob a single glob or array of globs that indicate which files to watch for changes. + * @param fn a callback or array of callbacks to be called on each change. + */ + watch(glob: string, fn: IWatchCallback): EventEmitter; + watch(glob: string[], fn: IWatchCallback): EventEmitter; + watch(glob: string, fn: IWatchCallback[]): EventEmitter; + watch(glob: string[], fn: IWatchCallback[]): EventEmitter; + + /** + * Watch files and do something when a file changes. This always returns an EventEmitter that emits change events. + * + * @param glob a single glob or array of globs that indicate which files to watch for changes. + * @param opt options, that are passed to the gaze library. + * @param fn a callback or array of callbacks to be called on each change. + */ + watch(glob: string, opt: IWatchOptions, fn: IWatchCallback): EventEmitter; + watch(glob: string, opt: IWatchOptions, fn: IWatchCallback[]): EventEmitter; +} + +declare var gulp: Gulp;