Naming Conventions

Complete Naming Table

This table shows the naming convention used for every context in a Grit project. The code generator handles all conversions automatically.

How the Generator Handles Names

The generator builds a Names struct with all naming variants from your resource name. You can provide the name in PascalCase, snake_case, or kebab-case -- the generator normalizes it to PascalCase first, then derives all other forms.

type Names struct {
    Pascal       string  // BlogPost
    Camel        string  // blogPost
    Snake        string  // blog_post
    Kebab        string  // blog-post
    Lower        string  // blogpost
    Plural       string  // blog_posts
    PluralPascal string  // BlogPosts
    PluralSnake  string  // blog_posts
    PluralKebab  string  // blog-posts
}

Conversion Flow

Full Name Derivation Examples

Here are complete examples showing how a resource name maps to every file and identifier in the project:

Example: "Post"

Example: "BlogPost"

Example: "Category"

Notice how "Category" correctly pluralizes to "categories" (y preceded by a consonant becomes -ies).

Pluralization Rules

The Grit CLI includes a built-in English pluralization engine that handles regular and irregular forms. Pluralization is applied to the snake_case form of the resource name.

Regular Rules

Irregular Plurals

The generator handles these irregular English plurals:

Automatic Icon Selection

When generating an admin resource definition, the CLI automatically picks a Lucide icon based on the resource name. It matches the lowercase resource name against a dictionary of common domain terms. If no match is found, it defaults to the Database icon.

The matching is substring-based. A resource named "ProductCategory" would match "product" first and get the Package icon. You can always change the icon in the generated resource definition file.

File Naming Summary

Different ecosystems use different naming conventions for files. Grit follows the idiomatic convention for each language:

Column Label Generation

When the generator creates admin DataTable columns and form fields, it converts field names to human-readable labels by splitting PascalCase into separate words.

The label splitting algorithm finds uppercase letter boundaries in PascalCase and inserts spaces. You can always customize labels in the generated resource definition file after generation.