Skip to content

Gulp build tasks

Adi Dahiya edited this page Nov 16, 2017 · 4 revisions

⚠️ Deprecation notice

Blueprint's build system no longer uses Gulp as of https://github.com/palantir/blueprint/pull/1741. Please use NPM scripts listed in the root package.json and in each package's package.json for development workflows.

Aliases

The easiest way to understand the aliases is to peek at the source.

  • 🌟 gulp – Compiles code and starts docs watching for development.
  • gulp build – Compiles all projects for publishing.
  • gulp check – Lints all source files.
  • gulp compile – Compiles all source code except docs Webpack.
  • gulp docs – Generates docs data files (does not compile it).
  • gulp test – Runs all test suites. You must run build first or the test-dist tasks will fail.

Task groups

The following Gulp tasks are defined as "task groups" comprised of a parent task that runs a set of child tasks for each package. Child tasks are typically determined by the presence of a config "block" in the package setup in Gulpfile.js. See #617 for more information.

Each of the following tasks also provides a <name>-<package> subtask for each package. For instance, sass includes sass-core, sass-datetime, etc.

  • copy – Copies files, such as resources and HTML files, from source directories to distribution directories.
  • sass – Compiles .scss files to .css.
  • tsc – Compiles .tsx? files to .js.
  • bundle – Bundles .js files into one giant .bundle.js with Webpack.
  • tslint – Lints .tsx? and .js files using TSLint.
  • stylelint – Lints .scss files using Stylelint.
  • isotest – Tests isomorphic (server-side) rendering of React components.
  • karma – Runs unit tests and code coverage in Karma & Phantom.
  • test-dist – Tests presence of declared "main" distribution files created by gulp build.

Simple tasks

  • clean – Deletes generated and distribution directories.
  • icons – Generates .ts and .scss files for icon variables
  • karma-unit-<package> – Watches and re-runs unit tests in Karma & Chrome
  • sass-variables – Concats & cleans public Sass variables files into variables.{less,scss}.
  • watch – Starts watchers for all source files, for development.
  • webpack-docs – Compiles docs package with Webpack & ts-loader.
  • webpack-docs-watch – Watches docs package with Webpack & ts-loader (for development).
Clone this wiki locally