Theme Developer Tools

This topic applies to

Applies to

Commerce Web Stores

 

The theme developer tools are required for theme developers. This applies to all SuiteCommerce and any SuiteCommerce Advanced implementations using Aconcagua release and later. After you have successfully installed the theme developer tools you can do the following:

Important

These procedures assume that you have successfully set up your developer environment to use the theme developer tools. See Developer Environment for details.


Before You Begin

Be aware of the following important information:

  • The gulp theme:deploy command checks to see if the theme you have customized is a published theme or a previously deployed, custom theme.

    • When you deploy customizations to a published theme, the theme development tools require that you create a new, custom theme. You cannot overwrite content protected by copyright.

    • When you deploy customizations to a pre-existing custom theme, the theme development tools give you the option to create a new theme (using the existing theme as a baseline) or update the existing theme with a new revision.

  • When you create a new custom theme, the developer tools rename the local directory where you created your customizations. This name matches the theme name you specify when you deploy your code.

    Example: When you download the files for the SuiteCommerce Base Theme, the developer tools create the SuiteCommerceBaseTheme directory in your theme workspace. You make your customizations, test, and deploy to NetSuite. The developer tools prompt you to create a new theme, which you name MyTheme1. When the deployment is complete, your local theme directory is renamed to MyTheme1.

  • If you deploy a theme with extension overrides and later activate new extensions for the same domain. Your deployed customizations do not apply to the new extensions. You must update your theme to include these customizations.

  • During activation, if you decide not activate an extension for which you created an override within the active theme, that override does not take effect at runtime and has no impact on your domain.

  • After deploying a theme or extension to NetSuite, you must activate the theme using the Manage Extensions wizard to apply your changes to a domain. Even if your theme is already active for a domain, you must reactivate your theme for your changes to compile.

Theme parameters, including your NetSuite email, account, role, and domain information, are stored in the .nsdeploy file when you fetch a theme. To reset your login and deployment information, delete the .nsdeploy file. This file is located here:

<LOCAL_SOURCEFILES_ROOT>/gulp/config/.nsdeploy

Likewise, theme information, including the theme name, fantasy name, version, and description, are stored in the theme’s Manifest.json file. The manifest file is located here:

<LOCAL_SOURCEFILES_ROOT>/Workspace/<THEME_DIRECTORY>/manifest.json