Gulp Command Reference for SCA Developer Tools

This topic applies to

Applies to

SuiteCommerce Advanced

The following table lists the most commonly used gulp commands:

Command

Description

gulp

Creates the LocalDistribution directory if it does not exist. This command also compiles the source modules into a deployable application

gulp deploy

Compiles the application and deploys it to NetSuite. As part of the compilation process, gulp deploy minimizes the application by removing all white space. This command also creates the DeployDistribution directory if it does not exist. See Contents of the DeployDistribution and LocalDistribution Directories for information on the output of this command.

In addition to compiling the application, this command creates the .nsdeploy file if it does not exist.

gulp deploy --no-backup

Compiles and deploys the application, but does not upload a backup of the source files.

gulp deploy --nouglify

Compiles and deploys the application like gulp deploy, but does not compress the source files. This command is useful for debugging because it produces output files that are easier to read.

gulp deploy --source <source_type>

Compiles and deploys only the type of source files specified. Possible options are:

  • javascript

  • ssp-libraries

  • ssp-files

  • services

gulp deploy --to

Enables you to deploy to a different NetSuite account by overriding the settings defined in the .nsdeploy file.

gulp jshint

Runs the JSHint utility on the SuiteCommerce Advanced source files. This utility verifies and validates JavaScript files to help detect possible errors.

gulp local

Compiles the Sass and template files into a functional application, but does not compile the JavaScript files of the application. After compilation, this command starts a local server. This server watches for changes to the SuiteCommerce Advanced source files. After the server starts, any changes you make to a JavaScript are automatically recompiled and visible in the browser. The server also watches for changes to the Sass and template files.

See SCA on a Local Server for more information.

This command outputs files to the LocalDistribution directory. See Contents of the DeployDistribution and LocalDistribution Directories for information on the output of this command.

gulp clean

Removes the DeployDistribution and LocalDistribution directories and the .nsdeploy file.

gulp local styleguide

This command compiles your Sass, parses all KSS blocks declared in the Sass files, and creates a style guide accessible in your localhost (localhost:3000/).

This command requires the Kilimanjaro release of SuiteCommerce Advanced or later. See Style Guide for details.