aboutsummaryrefslogtreecommitdiff
path: root/tools/typings/gulp-load-plugins.d.ts
diff options
context:
space:
mode:
Diffstat (limited to 'tools/typings/gulp-load-plugins.d.ts')
-rw-r--r--tools/typings/gulp-load-plugins.d.ts42
1 files changed, 42 insertions, 0 deletions
diff --git a/tools/typings/gulp-load-plugins.d.ts b/tools/typings/gulp-load-plugins.d.ts
new file mode 100644
index 0000000..809c305
--- /dev/null
+++ b/tools/typings/gulp-load-plugins.d.ts
@@ -0,0 +1,42 @@
+// Type definitions for gulp-load-plugins
+// Project: https://github.com/jackfranklin/gulp-load-plugins
+// Definitions by: Joe Skeen <http://github.com/joeskeen>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+// Does not support ES2015 import (import * as open from 'open').
+
+/** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */
+declare module 'gulp-load-plugins' {
+
+ interface IOptions {
+ /** the glob(s) to search for, default ['gulp-*', 'gulp.*'] */
+ pattern?: string[];
+ /** where to find the plugins, searched up from process.cwd(), default 'package.json' */
+ config?: string;
+ /** which keys in the config to look within, default ['dependencies', 'devDependencies', 'peerDependencies'] */
+ scope?: string[];
+ /** what to remove from the name of the module when adding it to the context, default /^gulp(-|\.)/ */
+ replaceString?: RegExp;
+ /** if true, transforms hyphenated plugin names to camel case, default true */
+ camelize?: boolean;
+ /** whether the plugins should be lazy loaded on demand, default true */
+ lazy?: boolean;
+ /** a mapping of plugins to rename, the key being the NPM name of the package, and the value being an alias you define */
+ rename?: IPluginNameMappings;
+ }
+
+ interface IPluginNameMappings {
+ [npmPackageName: string]: string;
+ }
+
+ /** Loads in any gulp plugins and attaches them to an object, freeing you up from having to manually require each gulp plugin. */
+ function gulpLoadPlugins<T extends IGulpPlugins>(options?: IOptions): T;
+ module gulpLoadPlugins {}
+ export = gulpLoadPlugins;
+}
+
+/**
+ * Extend this interface to use Gulp plugins in your gulpfile.js
+ */
+interface IGulpPlugins {
+}