ACR Rules

  1. Home
  2. Docs
  3. ACR Rules
  4. Project hygiene (32)
  5. Documents in a module should be organized in a good folder structure

Documents in a module should be organized in a good folder structure

Items in a module should be organized in a good folder structure

Every item e.g. microflow, page, etc has its proper place in a good folder structure. A good folder structure is key to having a maintainable application. When everything can be found in the same way you will have faster development and maintenance.

Customize the folder structure so that it suits your needs.

The default folder structure mandates that items should be organized into folders based on the entity they operate on. For example, if the module has entities “project” and “department” then the folder structure should be as follows:

This default structure is defined by the pattern: /{entity}/Pages|Events|Resources/+
which only allows folder with matching entities, with subfolders one of PagesEvents or Resources and then any items inside that folder.

More formally the pattern defines each level of the folder structure:

/<level1>/<level2>/<level3>

Where each level can be:

  • a hardcoded value e.g. Pages
  • a list of values separated by | e.g. Pages|Events
  • an entity name {entity}
  • a value that containsstartsWith or endsWith any of the above
  • any name *
  • any name and any nested levels allowed after that +

Examples:

/API/Calls|Mappings/*
/Functions/+
/UI/+