A gulpfile is a file in your project directory titled
gulpfile.js (or capitalized as
Gulpfile.js, like Makefile), that automatically loads when you run the
gulp command. Within this file, you'll often see gulp APIs, like
You can write a gulpfile using a language that requires transpilation, like TypeScript or Babel, by changing the extension on your
gulpfile.js to indicate the language and install the matching transpiler module.
- For TypeScript, rename to
gulpfile.tsand install the ts-node module.
- For Babel, rename to
gulpfile.babel.jsand install the @babel/register module.
Most new versions of node support most features that TypeScript or Babel provide, except the
export syntax. When only that syntax is desired, rename to
gulpfile.esm.js and install the esm module.
For a more advanced dive into this topic and the full list of supported extensions, see our gulpfile transpilation documentation.
Splitting a gulpfile
Many users start by adding all logic to a gulpfile. If it ever grows too big, it can be refactored into separate files.
Each task can be split into its own file, then imported into your gulpfile for composition. Not only does this keep things organized, but it allows you to test each task independently or vary composition based on conditions.
Node's module resolution allows you to replace your
gulpfile.js file with a directory named
gulpfile.js that contains an
index.js file which is treated as a
gulpfile.js. This directory could then contain your individual modules for tasks. If you are using a transpiler, name the folder and file accordingly.