ident

Documentation

Overview

Package ident provides functions for parsing and converting identifier names between various naming convention. It has support for MixedCaps, lowerCamelCase, and SCREAMING_SNAKE_CASE naming conventions.

Example (LowerCamelCaseToMixedCaps)

package main

import (
	"fmt"

	"github.com/cli/shurcooL-graphql/ident"
)

func main() {
	fmt.Println(ident.ParseLowerCamelCase("clientMutationId").ToMixedCaps())

}

Output:

ClientMutationID

Example (MixedCapsToLowerCamelCase)

package main

import (
	"fmt"

	"github.com/cli/shurcooL-graphql/ident"
)

func main() {
	fmt.Println(ident.ParseMixedCaps("ClientMutationID").ToLowerCamelCase())

}

Output:

clientMutationId

Example (ScreamingSnakeCaseToMixedCaps)

package main

import (
	"fmt"

	"github.com/cli/shurcooL-graphql/ident"
)

func main() {
	fmt.Println(ident.ParseScreamingSnakeCase("CLIENT_MUTATION_ID").ToMixedCaps())

}

Output:

ClientMutationID

Index

• type Name
  • func ParseLowerCamelCase(name string) Name
  • func ParseMixedCaps(name string) Name
  • func ParseScreamingSnakeCase(name string) Name
  • func (n Name) ToLowerCamelCase() string
  • func (n Name) ToMixedCaps() string

Examples

• Package (LowerCamelCaseToMixedCaps)
• Package (MixedCapsToLowerCamelCase)
• Package (ScreamingSnakeCaseToMixedCaps)

Types

type Name

type Name []string

Name is an identifier name, broken up into individual words.

func ParseLowerCamelCase

func ParseLowerCamelCase(name string) Name

ParseLowerCamelCase parses a lowerCamelCase identifier name.

E.g., "clientMutationId" -> {"client", "Mutation", "Id"}.

func ParseMixedCaps

func ParseMixedCaps(name string) Name

ParseMixedCaps parses a MixedCaps identifier name.

E.g., "ClientMutationID" -> {"Client", "Mutation", "ID"}.

func ParseScreamingSnakeCase

func ParseScreamingSnakeCase(name string) Name

ParseScreamingSnakeCase parses a SCREAMING_SNAKE_CASE identifier name.

E.g., "CLIENT_MUTATION_ID" -> {"CLIENT", "MUTATION", "ID"}.

func (Name) ToLowerCamelCase

func (n Name) ToLowerCamelCase() string

ToLowerCamelCase expresses identifier name in lowerCamelCase naming convention.

E.g., "clientMutationId".

func (Name) ToMixedCaps

func (n Name) ToMixedCaps() string

ToMixedCaps expresses identifier name in MixedCaps naming convention.

E.g., "ClientMutationID".