Initial implementation of calm-widgets

[rocketstack-matt]

This pull request introduces the calm-widgets module, a comprehensive library of Handlebars widgets for generating CALM architecture documentation. The changes include setting up workflows, adding documentation, implementing core functionality, and creating supporting infrastructure for the module.

Module Setup and Infrastructure

• .github/workflows/build-calm-widgets.yml: Added a GitHub Actions workflow to build, test, lint, and generate coverage reports for the calm-widgets module.
• calm-widgets/package.json: Defined the package configuration, including dependencies, scripts, and exports for the calm-widgets module.
• calm-widgets/pom.xml: Added a Maven POM file to define the module's metadata and parent project configuration.

Documentation

• calm-widgets/README.md: Created detailed documentation for the calm-widgets module, including its features, syntax guide, and integration examples with CALM CLI.

Core Functionality

• calm-widgets/src/formatters/table-formatter.ts: Implemented the TableFormatter class to format data as Markdown and HTML tables, with features like column inference, custom formatting, and empty data handling.
• calm-widgets/src/formatters/table-formatter.spec.ts: Added unit tests for the TableFormatter class to ensure correct functionality for various scenarios, including headers, empty data, and custom columns.

Supporting Scripts

• calm-widgets/scripts/copy-widgets.mjs: Added a script to copy widget templates from the widgets directory to the dist/widgets directory during the build process.

Future changes

This PR lays the foundation for providing simpler documentation generation using the CALM CLI without needing to provide a complex bundle. Further PRs should build in additional widgets such as diagram generation.

[jpgough-ms]

@rocketstack-matt PR has merge conflicts atm, going to convert to draft

[LeighFinegold]

Discussed PR with @markscott-ms @aidanm3341 @Thels in conjunction with #1452 with a particular focus on what is there currently.

Agreed an approach whereby

• We update the model that exists today so that we allow for
  details.nodes
  nodes.controls.security.requirement[0] syntax
  nodes.interfaces[0]
• We leverage the PathExtracter.ts for Dot Notation - we reduce usage of any (as the plan is to turn on strict mode). @aidanm3341 also wants to see if there are already any libraries doing it that we can atleast build upon. @Thels had brief look but not convinced there is. We also discussed that the PathExtractor has this additional filter capability that unlikely to get from a library
• The widgets can largely remain (can keep in shared to start and then pull out) and be merged with the existing templates/helpers in docify and default template processor extracted out.