Skip to main content
Version: 1.0-beta

Naming

API reference​

The engine's identifier naming rules at an engine version.

Implements Node

formatIdentifiers(names: [String!]!,casing: Casing!,acronyms: AcronymStyle = UPPERCASE): [String!]!

Format many names at once, for codegen. Returns them in input order.

names: [String!]!

The names to format, in any casing.

casing: Casing!

The casing to format the names in.

acronyms: AcronymStyle = UPPERCASE

How to write acronyms and terms where a word starts with a capital.

id: ID!

A unique identifier for this Naming.

version: String!

The normalized engine version these rules answer for.

dictionary: [NamingTerm!]!

The acronyms and terms used to parse and format identifiers.

identifier(name: String!): Identifier!

Parse a name in any casing into words.

Known acronyms and terms come from the naming dictionary; everything else falls back to the case heuristic. Errors on non-ASCII input, input with no letters or digits, or input over 256 bytes.

name: String!

The name to parse.

module(name: String!, originalName: String): ModuleNaming!

The names the engine gives the declarations of a module named by these rules.

name: String!

The module's name, which namespaces its types.

originalName: String

The module's original name, when it's loaded under another (as a dependency alias): its main object and namespaced type names are spelled after it. Defaults to name.

References

Returned by