Skip to main content

theemo package

The yordle powered theme automator

Classes

ClassDescription
Figma
StyleDictionary
Theemo

Enumerations

EnumerationDescription
FigmaReferencerTypeThe type of source for retrieving references
TokenTierThe usage level of a token
ToolsAn list of known toolsEach tool can be a ReaderTool, WriterTool or BuilderTool (multiple of that are allowed) and can be further parametrized through respective configs

Interfaces

InterfaceDescription
BaseTokenThe base token, with all properties shared amongst various token types used throughout theemo.
BuilderToolThis is for tools used during the build command and trigger the execution of that tool.
FigmaReaderConfigConfig for Figma as a ReaderTool
FigmaReferencerPluginConfigThe interface to describe a figma plugin beind used as reference information
FigmaTheemoPluginConfig
GenerateConfig
LexerConfigThe lexer config is used for you to configure the tokens to what they mean for you and to further process them
ReaderToolThis is for tools used during the sync command to read tokens from most of a the time a design tool.
StyleDictionaryConfigConfig for Style DictionaryStyle Dictionary is used as WriterTool and BuilderTool - yet there is only the part of writer you can further parametrize.
StyleDictionaryWriterConfigThe config for Style Dicitionary being used as WriterTool.
SyncConfigThe config used to configure the theemo sync command.sync consists of three steps:1. reading 2. lexing 3. writingSee the config for each respective step. Reading and writing is expressed through the supported tools.
TheemoConfigThe main config to control all commands for theemo:- sync - build - generate
TokenThe token interface as they are returned from the reader(s).
WriterToolThis is for tools used during the sync command and writes a named collection of tokens onto the disk in the tools required format.

Type Aliases

Type AliasDescription
FigmaReferencerConfigFigma does not support references of tokens, as such this information is coming through another source, which is described here.
ReaderConfigThe reader config describes the source from which tokens are read. This is expressed through the tool property.See the respective tool configurations, what further properties will be used.
WriterConfigThe writer config describes the way tokens are written to your disk. This is expressed through the tool property.See the respective tool configurations, what further properties will be used.