Overview

Best practices for naming Flows, Attestation Types, and Environments in Kosli.

Clear and consistent naming makes it easy for everyone to understand what each item in Kosli represents. Good names help you route attestations correctly and quickly find what you need.

Use these conventions for:

• Flows and Trails
• Attestation Types
• Environments

General Guidelines

The general guidelines should be considered best practices for all naming conventions in Kosli. You can adapt them to fit your organization’s needs, but consistency is key. All of our proposed conventions follow these general guidelines:

Structure: <element 1> <delimiter> <element 2> <delimiter>…<element N>

1. Choose delimiter

   Choose a delimiter that works for your and stick with it consistently. For example hyphen -, underscore _, tilde ~ or dot .. Avoid mixing delimiters within the same naming scheme.

2. Choose case style for elements

   Choose a meaningful case style across elements (e.g., PascalCase, camelCase, snake_case) and use it consistently. Avoid spaces and clashes with delimiters.

3. Keep it concise

   Shorter names are easier to read and remember. Aim for concise but descriptive names.

4. Avoid special characters

   Stick to alphanumeric characters and underscores/hyphens

Be aware of using underscore _ as the delimiter, as that conflicts with snake_case for elements.

The rest of this document uses hyphen - as the delimiter in examples, but you can choose any delimiter that fits your needs.

Regular Expression

To help enforce these conventions programmatically, here are sample regular expressions you can use based on your chosen case style.

Adjust the regex if you choose a different delimiter.

snake_case

Example: element_one-element_two-element_three

^[a-z][a-z0-9_]*(-[a-z][a-z0-9_]*)*$

camelCase

Example: elementOne-elementTwo-elementThree

^[a-z][a-zA-Z0-9]*(-[a-z][a-zA-Z0-9]*)*$

PascalCase

Example: ElementOne-ElementTwo-ElementThree

^[A-Z][a-zA-Z0-9]*(-[A-Z][a-zA-Z0-9]*)*$

If you want a specific length limit (e.g., max 50 characters), you can add a lookahead at the start of the regex:

^(?=.{1,50}$) # + rest of the regex

You can use online regex testers like regex101 to validate and test these expressions.