Project Config Function

The project config function is used to validate the Project Configuration File using command line statements.

To validate the project configuration, go to the command prompt or terminal of the template project and execute ch5-shell-cli validate:projectconfig or npm run validate:projectconfig. The validate:projectconfig and val:pc NPM one-click scripts can also be selected from within Visual Studio Code as shown below.

Based on the responses, the output is classified into errors and warnings. The project-config.json is validated for the following cases:

  1. Validate project-config.json based on project-config-schema.json.
  2. Verify if the pages defined in project-config.json exists in the physical folders.
  3. Verify if the widgets defined in project-config.json exists in the physical folders.
  4. Verify if the pages names are repeated in project-config.json.
  5. Check if the widget names are repeated in project-config.json.
  6. Check if the page sequences are repeated.
  7. Check if the theme name is not available in the list of mentioned themes.
  8. Check if the theme name is repeated in the themes array.
  9. If menuOrientation is either 'vertical' or 'horizontal', then check if at least one navigation item exists in the pages list.
  10. Check if the menuOrientation is 'vertical', and if there is an 'IconPosition' defined for navigation.
  11. Check if the menuOrientation is 'vertical', and if the menu is displayed.
  12. Check if the pages array is empty.
  13. Check if page names are reused in widgets and vice-versa.
  14. Check that a defaultLanguage parameter is defined for the project.

This validation will review the settings in the project configuration file and inform the developer of any invalid configuration before running the browser or running on the touch screen. During the 'start' and 'build' process, this script will be executed and if there are errors (not warnings), the script will not continue to the next step.