Skip to content
This repository
branch: master
Fetching contributors…

Cannot retrieve contributors at this time

file 392 lines (326 sloc) 15.184 kb
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392
// Type definitions for jake
// Project: https://github.com/mde/jake
// Definitions by: Kon <http://phyzkit.net/>
// Definitions: https://github.com/borisyankov/DefinitelyTyped

/// <reference path="../node/node.d.ts" />

/**
* Complets an asynchronous task, allowing Jake's execution to proceed to the next task
* @param value A value to return from the task.
*/
declare function complete(value?: any): void;

/**
* Creates a description for a Jake Task (or FileTask, DirectoryTask). When invoked, the description that iscreated will be associated with whatever Task is created next.
* @param description The description for the Task
*/
declare function desc(description:string): void;

/**
* Creates a Jake DirectoryTask. Can be used as a prerequisite for FileTasks, or for simply ensuring a directory exists for use with a Task's action.
* @param name The name of the DiretoryTask
*/
declare function directory(name:string): jake.DirectoryTask;

/**
* Causes Jake execution to abort with an error. Allows passing an optional error code, which will be used to set the exit-code of exiting process.
* @param err The error to thow when aborting execution. If this argument is an Error object, it will simply be thrown. If a String, it will be used as the error-message. (If it is a multi-line String, the first line will be used as the Error message, and the remaining lines will be used as the error-stack.)
*/
declare function fail(...err:string[]): void;
declare function fail(...err:Error[]): void;
declare function fail(...err:any[]): void;

/**
* Creates a Jake FileTask.
* @name name The name of the Task
* @param prereqs Prerequisites to be run before this task
* @param action The action to perform for this task
* @param opts Perform this task asynchronously. If you flag a task with this option, you must call the global `complete` method inside the task's action, for execution to proceed to the next task.
*/
declare function file(name:string, prereqs?:string[], action?:()=>void, opts?:jake.FileTaskOptions): jake.FileTask;

/**
* Creates a namespace which allows logical grouping of tasks, and prevents name-collisions with task-names. Namespaces can be nested inside of other namespaces.
* @param name The name of the namespace
* @param scope The enclosing scope for the namespaced tasks
*/
declare function namespace(name:string, scope:()=>void): void;

/**
* @param name The name of the Task
* @param prereqs Prerequisites to be run before this task
* @param action The action to perform for this task
* @param opts
*/
declare function task(name:string, prereqs?:string[], action?:(...params:any[])=>any, opts?:jake.TaskOptions): jake.Task;
declare function task(name:string, action?:(...params:any[])=>any, opts?:jake.TaskOptions): jake.Task;
declare function task(name:string, opts?:jake.TaskOptions, action?:(...params:any[])=>any): jake.Task;

/**
* @param name The name of the NpmPublishTask
* @param packageFiles The files to include in the package
* @param definition A function that creates the package definition
*/
declare function npmPublishTask(name:string, packageFiles:string[]): jake.NpmPublishTask;
declare function npmPublishTask(name:string, definition?:()=>void): jake.NpmPublishTask;


declare module jake{

    ////////////////////////////////////////////////////////////////////////////////////
// File-utils //////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////

interface UtilOptions{
silent?: boolean;
}

/**
* The jake.mkdirP utility recursively creates a set of nested directories. It will not throw an error if any of the directories already exists.
* https://github.com/substack/node-mkdirp
*/
export function mkdirP(name:string, mode?:string, f?:(er:Error, made:any)=>void): void;
export function mkdirP(name:string, f?:(er:Error, made:any)=>void): void;

/**
* The jake.cpR utility does a recursive copy of a file or directory.
* Note that this command can only copy files and directories; it does not perform globbing (so arguments like '*.txt' are not possible).
* @param path the file/directory to copy,
* @param destination the destination.
*/
export function cpR(path:string, destination:string, opts?:UtilOptions, callback?:()=>void): void;
export function cpR(path:string, destination:string, callback?:(err:Error)=>void): void;

/**
* The jake.readdirR utility gives you a recursive directory listing, giving you output somewhat similar to the Unix find command. It only works with a directory name, and does not perform filtering or globbing.
* @return an array of filepaths for all files in the 'pkg' directory, and all its subdirectories.
*/
export function readdirR(name:string, opts?:UtilOptions): string[];

/**
* The jake.rmRf utility recursively removes a directory and all its contents.
*/
export function rmRf(name:string, opts?:UtilOptions): void;

//////////////////////////////////////////////////////////////////////////////////////////////
// Running shell-commands ////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////

interface ExecOptions{
/**
* print to stdout, default false
*/

printStdout?:boolean;
/**
* print to stderr, default false
*/
printStderr?:boolean;

/**
* stop execution on error, default true
*/
breakOnError?:boolean;
}
export function exec(cmds:string[], callback?:()=>void, opts?:ExecOptions):void;


/**
* @event cmdStart When a new command begins to run. Passes one arg, the command being run.
* @event cmdEnd When a command finishes. Passes one arg, the command being run.
* @event stdout When the stdout for the child-process recieves data. This streams the stdout data. Passes one arg, the chunk of data.
* @event stderr When the stderr for the child-process recieves data. This streams the stderr data. Passes one arg, the chunk of data.
* @event error When a shell-command
*/
export interface Exec extends NodeJS.EventEmitter {
append(cmd:string): void;
run(): void;
}

export function createExec(cmds:string[], callback?:()=>void, opts?:ExecOptions ):Exec;
export function createExec(cmds:string[], opts?:ExecOptions, callback?:()=>void):Exec;
export function createExec(cmds:string, callback?:()=>void, opts?:ExecOptions ):Exec;
export function createExec(cmds:string, opts?:ExecOptions, callback?:()=>void):Exec;

////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Logging and output ////////////////////////////////////////////////////////////////////////////////////////
/////////////////////////////////////////////////////////////////////////////////////////////////////////////

interface Logger{
log(value:any): void;
error(value:any): void;
}

export var logger: Logger;

//////////////////////////////////////////////////////////////////////////////////////////////////////////////
// program ////////////////////////////////////////////////////////////////////////////////////////////////////
////////////////////////////////////////////////////////////////////////////////////////////////////////////////

export var program: {
opts: {
[name:string]: any;
quiet: boolean;
};
taskNames: string[];
        taskArgs: string[];
        envVars: { [key:string]: string; };
};


//////////////////////////////////////////////////////////////////////////////////////////////////////////////
// Tasks /////////////////////////////////////////////////////////////////////////////////////////////////////
//////////////////////////////////////////////////////////////////////////////////////////////////////////////


export interface TaskOptions{
/**
* Perform this task asynchronously. If you flag a task with this option, you must call the global `complete` method inside the task's action, for execution to proceed to the next task.
* @default false
*/
async?: boolean;
}

/**
* A Jake Task
*
* @event complete
*/
export class Task implements NodeJS.EventEmitter {
/**
* @name name The name of the Task
* @param prereqs Prerequisites to be run before this task
* @param action The action to perform for this task
* @param opts Perform this task asynchronously. If you flag a task with this option, you must call the global `complete` method inside the task's action, for execution to proceed to the next task.
*/
constructor(name:string, prereqs?:string[], action?:()=>void, opts?:TaskOptions);

/**
* Runs prerequisites, then this task. If the task has already been run, will not run the task again.
*/
invoke(): void;

/**
* Runs this task, without running any prerequisites. If the task has already been run, it will still run it again.
*/
reenable(): void;

addListener(event: string, listener: Function): NodeJS.EventEmitter;
        on(event: string, listener: Function): NodeJS.EventEmitter;
        once(event: string, listener: Function): NodeJS.EventEmitter;
        removeListener(event: string, listener: Function): NodeJS.EventEmitter;
        removeAllListeners(event?: string): NodeJS.EventEmitter;
        setMaxListeners(n: number): void;
        listeners(event: string): Function[];
        emit(event: string, ...args: any[]): boolean;
        value: any;
}

export class DirectoryTask{
/**
* @param name The name of the directory to create.
*/
constructor(name:string);
}

export interface FileTaskOptions{
/**
* Perform this task asynchronously. If you flag a task with this option, you must call the global `complete` method inside the task's action, for execution to proceed to the next task.
* @default false
*/
async?: boolean;
}

export class FileTask{
/**
* @param name The name of the Task
* @param prereqs Prerequisites to be run before this task
* @param action The action to perform to create this file
* @param opts Perform this task asynchronously. If you flag a task with this option, you must call the global `complete` method inside the task's action, for execution to proceed to the next task.
*/
constructor(name:string, prereqs?:string[], action?:()=>void, opts?:FileTaskOptions);
}

interface FileFilter{
(filename:string): boolean;
}

export class FileList{
constructor();

/**
* Includes file-patterns in the FileList. Should be called with one or more
* pattern for finding file to include in the list. Arguments should be strings
* for either a glob-pattern or a specific file-name, or an array of them
*/
include(files:string[]): void;
include(...files:string[]): void;

/**
* Indicates whether a particular file would be filtered out by the current
* exclusion rules for this FileList.
* @param name The filename to check
* @return Whether or not the file should be excluded
*/
shouldExclude(name:string): boolean;

/**
* Excludes file-patterns from the FileList. Should be called with one or more
* pattern for finding file to include in the list. Arguments can be:
* 1. Strings for either a glob-pattern or a specific file-name
* 2. Regular expression literals
* 3. Functions to be run on the filename that return a true/false
*/
exclude(file:string[]): void;
exclude(...file:string[]): void;
exclude(file:RegExp[]): void;
exclude(...file:RegExp[]): void;
exclude(file:FileFilter[]): void;
exclude(...file:FileFilter[]): void;

/**
* Populates the FileList from the include/exclude rules with a list of
* actual files
*/
resolve(): void;

/**
* Convert to a plain-jane array
*/
toArray(): string[];

/**
* Get rid of any current exclusion rules
*/
   clearExclude(): void;
}

export class PackageTask{
        /**
* Instantiating a PackageTask creates a number of Jake Tasks that make packaging and distributing your software easy.
* @param name The name of the project
* @param version The current project version (will be appended to the project-name in the package-archive
* @param definition Defines the contents of the package, and format of the package-archive. Will be executed on the instantiated PackageTask (i.e., 'this', will be the PackageTask instance), to set the various instance-propertiess.
*/
constructor(name:string, version:string, definition:()=>void);

/**
* Equivalent to the '-C' command for the `tar` and `jar` commands. ("Change to this directory before adding files.")
*/
archiveChangeDir: string;

/**
* Specifies the files and directories to include in the package-archive. If unset, this will default to the main package directory -- i.e., name + version.
*/
      archiveContentDir: string;

      /**
* The shell-command to use for creating jar archives.
*/
        jarCommand: string;

        /**
* Can be set to point the `jar` utility at a manifest file to use in a .jar archive. If unset, one will be automatically created by the `jar` utility. This path should be relative to the root of the package directory (this.packageDir above, likely 'pkg')
*/
        manifestFile: string;

        /**
* The name of the project
*/
name: string;

/**
* If set to true, uses the `jar` utility to create a .jar archive of the pagckage
*/
needJar: boolean;

/**
* If set to true, uses the `tar` utility to create a gzip .tgz archive of the pagckage
*/
        needTar: boolean;

        /**
* If set to true, uses the `tar` utility to create a bzip2 .bz2 archive of the pagckage
*/
needTarBz2: boolean;

/**
* If set to true, uses the `zip` utility to create a .zip archive of the pagckage
*/
needZip: boolean;

/**
* The list of files and directories to include in the package-archive
*/
        packageFiles: FileList;

        /**
* The shell-command to use for creating tar archives.
*/
        tarCommand: string;

        /**
* The project version-string
*/
version: string;

/**
* The shell-command to use for creating zip archives.
*/
zipCommand: string;

}

export class TestTask{
constructor(name:string, definition?:()=>void);
}

export class NpmPublishTask{
constructor(name:string, packageFiles:string[]);
constructor(name:string, definition?:()=>void);
}

export function addListener(event: string, listener: Function): NodeJS.EventEmitter;
export function on(event: string, listener: Function): NodeJS.EventEmitter;
export function once(event: string, listener: Function): NodeJS.EventEmitter;
export function removeListener(event: string, listener: Function): NodeJS.EventEmitter;
export function removeAllListener(event: string): NodeJS.EventEmitter;
export function setMaxListeners(n: number): void;
export function listeners(event: string): Function[];
export function emit(event: string, ...args: any[]): boolean;
}
Something went wrong with that request. Please try again.