Semantic Coherence: gulp.js – Signal Evidence & AI Readability

[H1] A toolkit to automate & enhance your workflow
Leverage gulp and the flexibility of JavaScript to automate slow, repetitive workflows and compose them into efficient build pipelines.TypeScriptDevelop in any languagePNGCreate assets with any toolMarkdownWrite using any formatJavaScriptGet compiled codeWebPGet optimized imagesHTMLGet rendered contentOrganization SupportProvide gulp with ongoing support and we’ll let our users know!
[IMG: Flexible sample]
[H2] Flexible
Using code over configuration, utilize all of JavaScript to create your gulpfile—where tasks can be written using your own code or chained single purpose plugins.
[IMG: Composable sample]
[H2] Composable
Write individual, focused tasks and compose them into larger operations, providing you with speed and accuracy while reducing repetition.
[IMG: Efficient sample]
[H2] Efficient
By using gulp streams, you can apply many transformations to your files while in memory before anything is written to the disk—significantly speeding up your build process.
[H2] Connecting plugins
Using community-built plugins is a quick way to get started with gulp. Each plugin does a small amount of work, so you can connect them like building blocks. Chain together plugins from a variety of technologies to reach your desired result.Browse the community plugins to see what’s available!
[IMG: Babel logo]
Babel
[IMG: SASS logo]
SASS
[IMG: TypeScript logo]
TypeScript
[IMG: Autoprefixer logo]
Autoprefixer
[IMG: Imagemin logo]
Imagemin
[IMG: Pug logo]
Pug
[H2] Individual backers
Since 2013, gulp has been the toolkit of choice for developers and designers alike. Not only do we have communities who’ve relied on us since the beginning, but there’s also a constant flow of new users who find out how great their workflow can be with gulp.Gulp needs your help! We want to continue expanding our team and find even more contributors from every discipline to maintain and improve the project you love!
[H3] $2 each month
Thanks for supporting us. Every contribution helps us maintain and improve gulp!Donate $2
[H3] $5 each month
In the future, we'll rotate your avatar through an individual contributors banner below.Donate $5
[H3] $10 each month
We'll thank you on Twitter and, in the future, rotate your avatar through an individual contributors banner below.Donate $10

[H1]

On this page
[H1] Quick Start
If you've previously installed gulp globally, run npm rm --global gulp before following these instructions. For more information, read this Sip.
[H2] Check for node, npm, and npx​
node --version
[IMG: Output: v8.11.1]
npm --version
[IMG: Output: 5.6.0]
npx --version
[IMG: Output: 9.7.1]
If they are not installed, follow the instructions here.
[H2] Install the gulp command line utility​
npm install --global gulp-cli
[H2] Create a project directory and navigate into it​
npx mkdirp my-project
cd my-project
[H2] Create a package.json file in your project directory​
npm init
This will guide you through giving your project a name, version, description, etc.
[H2] Install the gulp package in your devDependencies​
npm install --save-dev gulp
[H2] Verify your gulp versions​
gulp --version
Ensure the output matches the screenshot below or you might need to restart the steps in this guide.
[IMG: Output: CLI version 2.0.1 & Local version 4.0.0]
[H2] Create a gulpfile​
Using your text editor, create a file named gulpfile.js in your project root with these contents:
function defaultTask(cb) { // place code for your default task here cb();}exports.default = defaultTask
[H2] Test it​
Run the gulp command in your project directory:
gulp
To run multiple tasks, you can use gulp <task> <othertask>.
[H2] Result​
The default task will run and do nothing.
[IMG: Output: Starting default & Finished default]
Check for node, npm, and npxInstall the gulp command line utilityCreate a project directory and navigate into itCreate a package.json file in your project directoryInstall the gulp package in your devDependenciesVerify your gulp versionsCreate a gulpfileTest itResult

On this page
[H1] Concepts
The following concepts are prerequisites to understanding the API docs. They will be referenced throughout, refer back to this page for detailed explanations.
If you're new here, begin with the Getting Started Guide.
[H2] Vinyl​
Vinyl is a metadata object that describes a file. The main properties of a Vinyl instance are path and contents - core aspects of a file on your file system. Vinyl objects can be used to describe files from many sources - on a local file system or any remote storage option.
[H2] Vinyl adapters​
While Vinyl provides a way to describe a file, a way to access these files is needed. Each file source is accessed using a Vinyl adapter.
An adapter exposes:
A method with the signature src(globs, [options]) and returns a stream that produces Vinyl objects.
A method with the signature dest(folder, [options]) and returns a stream that consumes Vinyl objects.
Any extra methods specific to their input/output medium - such as the symlink method vinyl-fs provides. They should always return streams that produce and/or consume Vinyl objects.
[H2] Tasks​
Each gulp task is an asynchronous JavaScript function that either accepts an error-first callback or returns a stream, promise, event emitter, child process, or observable. Due to some platform limitations, synchronous tasks aren't supported.
For a more detailed explanation, see Creating Tasks.
[H2] Globs​
A glob is a string of literal and/or wildcard characters, like *, **, or !, used to match filepaths. Globbing is the act of locating files on a file system using one or more globs.
If you don't have experience with globs, see Explaining Globs.
[H2] Glob base​
A glob base - sometimes called glob parent - is the path segment before any special characters in a glob string. As such, the glob base of /src/js/**.js is /src/js/. All paths that match the glob are guaranteed to share the glob base - that path segment can't be variable.
Vinyl instances generated by src() are constructed with the glob base set as their base property. When written to the file system with dest(), the base will be removed from the output path to preserve directory structures.
For more in depth information, see the glob-parent repository.
[H2] File system stats​
File metadata is provided as an instance of Node's fs.Stats. It is available as the stat property on your Vinyl instances and used internally to determine if a Vinyl object represents a directory or symbolic link. When written to the file system, permissions and time values are synchronized from the Vinyl object's stat property.
[H2] File system modes​
File system modes determine what permissions exist for a file. Most files and directories on your file system will have a fairly permissive mode, allowing gulp to read/write/update files on your behalf. By default, gulp will create files with the same permissions as the running process, but you can configure the modes through options in src(), dest(), etc. If you're experiencing permission (EPERM) issues, check the modes on your files.
[H2] Modules​
Gulp is made up of many small modules that are pulled together to work cohesively. By utilizing semver within the small modules, we can release bug fixes and features without publishing new versions of gulp. Often, when you don't see progress on the main repository, work is being done in one of these modules.
If you're having trouble, ensure your current modules are updated using the npm update command. If the problem persists, open an issue on the individual project repository.
undertaker - the task registration system
vinyl - the virtual file objects
vinyl-fs - a vinyl adapter to your local file system
glob-watcher - the file watcher
bach - task orchestration using series() and parallel()
last-run - tracks the last run time of a task
vinyl-sourcemap - built-in sourcemap support
gulp-cli - the command line interface for interacting with gulp
VinylVinyl adaptersTasksGlobsGlob baseFile system statsFile system modesModules