Folder Structure for SuiteCommerce Extensions Development

The folder structure for SuiteCommerce extensions is crucial for organizing your development environment effectively. It dictates how your code is structured and how various components interact. Below, we'll break down the key aspects of the folder structure and provide useful code samples to assist in your development process.

Understanding the Folder Structure

The primary directory for your extension will reside in a top-level development directory under a folder named after your extension. Each extension gets its own subdirectory within the Workspace directory. Within this subdirectory, a Modules folder usually contains your extension’s modules. Here’s an example layout:

1<TopLevelDevelopmentDirectory>
2   Workspace
3      MyCoolExtension
4         assets
5         Modules
6            MyCoolModule
7         manifest.json

Module Folder Flexibility

It's important to note that while the default convention is to name each module folder after the extension, you are not strictly required to do so. Your directory can adopt any naming scheme that fits your project. Below is another potential structure:

1<TopLevelDevelopmentDirectory>
2   Workspace
3      MyCoolExtension
4         assets
5         Modules
6            ModuleOne
7               JavaScript
8                  ModuleOne.js
9            ModuleTwo
10               JavaScript
11                  ModuleTwo.js
12         manifest.json

Creating Entry Point Files

To allow your modules to integrate properly with the SuiteCommerce framework, you will create entry point files in your module directories. Below is an example of how to structure these files:

1define('ModuleOne'
2, [
3  // dependencies
4]
5, function
6  () {
7  'use strict';
8 
9  return {
10    mountToApp: function () {
11      console.log('ModuleOne loaded!');
12    }
13  };
14})

Note that for ModuleTwo.js, you should change ModuleOne in the definition to ModuleTwo accordingly. This modular approach allows flexibility in your coding strategy and promotes reusability across your SuiteCommerce projects.

Best Practices

• Consistency: Maintain a consistent naming convention for your modules to ensure clarity.
• Documentation: Keep your modules well-documented to assist future development or team collaboration.
• Avoid Manual Edits: As a best practice, do not manually edit files within the generated directories to prevent issues.

By adhering to this structure and following these best practices, you will facilitate a more organized and manageable development experience in SuiteCommerce.

Key Components of the Directory:

Understanding the folder structure not only improves your workflow but also leverages the full potential of SuiteCommerce development capabilities.