nameconv

README

nameconv

nameconv is a package for converting strings between different naming conventions including camelCase, kebab-case, PascalCase and snake_case.

Documentation

Index

• Variables
• func ConvertStringListToName(list []string) english.Name
• func ParseCamelCase(s string) (english.Name, error)
• func ParseEnglish(n string) (english.Name, error)
• func ParseKebabCase(s string) (english.Name, error)
• func ParsePascalCase(s string) (english.Name, error)
• func ParseSnakeCase(s string) (english.Name, error)

Variables

var ErrEmptyString = errors.New("cannot parse empty string")

var ErrExpectedCamelCase = errors.New("expected camel case")

var ErrExpectedKebabCase = errors.New("expected kebab case")

var ErrExpectedPascalCase = errors.New("expected pascal case")

var ErrExpectedSnakeCase = errors.New("expected snake case")

Functions

func ConvertStringListToName

func ConvertStringListToName(list []string) english.Name

func ParseCamelCase

func ParseCamelCase(s string) (english.Name, error)

ParseCamelCase parses a camelCase name into a Name. If the name is not valid camelCase, an error is returned.

func ParseEnglish

func ParseEnglish(n string) (english.Name, error)

ParseEnglish parses names that use the English alphabet and spaces to separate words. If there is a non-letter character in the name, it will be ignored. If the name is empty, an error is returned.

func ParseKebabCase

func ParseKebabCase(s string) (english.Name, error)

ParseKebabCase parses a kebab-case string into a Name. It returns an error if the string is empty or not kebab-case.

func ParsePascalCase

func ParsePascalCase(s string) (english.Name, error)

ParsePascalCase parses a PascalCase name into a Name. If the name is not valid PascalCase, an error is returned.

func ParseSnakeCase

func ParseSnakeCase(s string) (english.Name, error)

ParseSnakeCase parses a snake_case string into a Name. If the string is not valid snake_case, an error is returned.