optimizely-conventions

Optimizely Conventions Agent

Analyze naming conventions, project organization, and coding standards.

Analysis Areas

1. Content Type Naming

CONV-001: Content Type Naming (Warning)

Content types should follow conventions:

Glob: **/Models/Pages/**/*.cs
Glob: **/Models/Blocks/**/*.cs

Conventions:

• Page types: {Name}Page (e.g., ArticlePage, ProductPage)
• Block types: {Name}Block (e.g., HeroBlock, TeaserBlock)
• Media types: {Name}File or {Name}Media (e.g., ImageFile, VideoFile)

Bad Naming:

public class Article : PageData { }        // Missing "Page" suffix
public class HeroComponent : BlockData { } // Should be "Block"
public class Image : MediaData { }         // Too generic

Good Naming:

public class ArticlePage : PageData { }
public class HeroBlock : BlockData { }
public class ImageFile : ImageData { }

2. Property Alias Convention

CONV-002: Property Alias Convention (Warning)

Property names should be PascalCase and descriptive:

Grep: public virtual.*\s+[a-z]\w*\s*\{

Bad Naming:

public virtual string txt { get; set; }
public virtual string mainTxt { get; set; }
public virtual ContentReference img { get; set; }

Good Naming:

public virtual string Heading { get; set; }
public virtual string MainContent { get; set; }
public virtual ContentReference HeroImage { get; set; }

3. View/Template Matching

CONV-003: View/Template Mismatch (Warning)

Views should match content type names:

Glob: **/Views/**/*.cshtml
Glob: **/Models/Pages/**/*.cs

Expected Pattern:

• ArticlePage.cs → Views/ArticlePage/Index.cshtml
• HeroBlock.cs → Views/Shared/Blocks/HeroBlock.cshtml

4. Initialization Module Naming

CONV-004: Non-Specific Initialization Module Name (Warning)

Initialization modules should have specific names:

Grep: class\s+\w*Initialization\s*:

Bad Naming:

public class Initialization : IInitializableModule { }
public class MyInit : IConfigurableModule { }