Crosser.Templates 1.0.0

Crosser Templates

Official .NET template for creating a Crosser flow module using the Crosser SDK.

Overview

This package provides a dotnet template to help developers quickly create new Crosser flow modules with best practices and proper structure.

Installation

Install the dotnet template package:

dotnet new install Crosser.Templates

Crosser Flow Module (crosser-flowmodule)

Creates a new Crosser flow module project with the following structure:

• Main module project with sample implementation
• Settings class for module configuration
• Optional unit test project with sample tests
• Documentation files
• Proper project references and dependencies

Basic Usage

Create a new crosser module with default settings:

dotnet new crosser-flowmodule -n MyOrg.FlowModule.SampleModule

Template Options

Naming Conventions and Namespaces

⚠️ Important: Company-Scoped Naming

Always scope your module names to your company or organization to avoid naming conflicts in Crosser environments. This is crucial when deploying modules to shared environments or when distributing modules.

✅ Recommended naming patterns: Include your organization name or domain in the module name

• YourOrg.FlowModule.ModuleName (e.g., Acme.FlowModule.DataTransformer)

❌ Avoid generic names: Avoid ommitting your organization name or using overly generic names that coulds conflict with other packages.

• DataProcessor (too generic, likely to conflict)
• SQL.Transformer (very common name)

Namespace Structure

The template creates the following namespace structure:

• Project Name: Uses the -n parameter (e.g., YourOrg.FlowModule.EmailProcessor)
• Module Class: Uses the -m parameter (e.g., EmailProcessor)
• Namespace: Matches the project name for consistency

Example:

dotnet new crosser-flowmodule -n Acme.FlowModule.EmailProcessor -m EmailProcessor

This creates:

• Project: Acme.FlowModule.EmailProcessor
• Namespace: Acme.FlowModule.EmailProcessor
• Module class: EmailProcessor
• Settings class: EmailProcessorSettings

Generated Project Structure

YourModuleName/
├── Module/
│   ├── YourModuleName.csproj
│   ├── YourModule.cs              # Main module implementation
│   ├── YourModuleSettings.cs      # Module settings/configuration
│   ├── GlobalUsings.cs            # Global using statements
│   ├── CHANGELOG.md               # Module changelog
│   └── docs/
│       ├── YourModule.md          # Module documentation
│       ├── YourModule.svg         # Module icon/diagram
│       └── YourModule.teaser.md   # Module description
└── UnitTests/ (if includeTest = true)
    ├── YourModuleName.UnitTests.csproj
    ├── YourModuleTests.cs         # Unit tests for module
    ├── FlowMessageTests.cs        # Flow message tests
    └── GlobalUsings.cs

Next Steps

After creating your module:

1. Customize the module logic in YourModule.cs
2. Configure settings in YourModuleSettings.cs
3. Update documentation and icon in the docs/ folder
4. Add unit tests to validate your module behavior
5. Build and test your module locally
6. Package and deploy to your Crosser cloud.

Requirements

• .NET 6.0 or later
• Crosser SDK (automatically referenced by the template)

Development Resources

Crosser SDK Documentation

For comprehensive guidance on module development with the Crosser SDK, including advanced concepts, best practices, and API references, please refer to the official SDK documentation:

📚 Crosser SDK Module Development Guide

This documentation covers:

• Module lifecycle and event handling
• Advanced message processing patterns
• Settings and configuration management
• Error handling and logging best practices
• Performance optimization techniques
• Testing strategies for flow modules
• Deployment and packaging guidelines

Support

For more information about developing Crosser modules, visit the Crosser documentation or contact Crosser Technologies support.