Skip to main content

@moonrepo/types

build status npm version npm license

Reusable TypeScript types for moon projects, tasks, and configurations.

Index

Interfaces

Type Aliases

Type Aliases

ActionNode

ActionNode: ActionNodeInstallProjectDeps | ActionNodeInstallWorkspaceDeps | ActionNodeRunTask | ActionNodeSetupToolchain | ActionNodeSyncProject | ActionNodeSyncWorkspace

ActionStatus

ActionStatus: aborted | cached-from-remote | cached | failed-and-abort | failed | invalid | passed | running | skipped | timed-out

BinEntry

BinEntry: string | BinConfig

CodeownersOrderBy

CodeownersOrderBy: file-source | project-name

How to order ownership rules within the generated file.

DependencyScope

DependencyScope: build | development | peer | production | root

The scope and or relationship of the dependency.

DependencySource

DependencySource: explicit | implicit

The source where the dependency comes from. Either explicitly defined in configuration, or implicitly derived from source files.

DependencyType

DependencyType: cleanup | required | optional

The task-to-task relationship of the dependency.

EventType

EventType: action.completed | action.started | dependencies.installed | dependencies.installing | pipeline.completed | pipeline.started | project.synced | project.syncing | task.ran | task.running | tool.installed | tool.installing | workspace.synced | workspace.syncing | action.finished | pipeline.finished | pipeline.aborted | target.ran | target.running

HasherOptimization

HasherOptimization: accuracy | performance

The optimization to use when hashing.

HasherWalkStrategy

HasherWalkStrategy: glob | vcs

The strategy to use when walking the file system.

LanguageType

LanguageType: bash | batch | go | javascript | php | python | ruby | rust | typescript | unknown | string

Supported programming languages that each project can be written in.

NodePackageManager

NodePackageManager: bun | npm | pnpm | yarn

The available package managers for Node.js.

NodeVersionFormat

NodeVersionFormat: file | link | star | version | version-caret | version-tilde | workspace | workspace-caret | workspace-tilde

Formats that a package.json version dependency can be.

NodeVersionManager

NodeVersionManager: nodenv | nvm

The available version managers for Node.js.

Nullable

Nullable<T>: { [ K in keyof T ]: T[K] | null }

Type parameters

  • T

OperationMeta

OperationMeta: OperationMetaArchiveCreation | OperationMetaHashGeneration | OperationMetaMutexAcquisition | OperationMetaNoOperation | OperationMetaOutputHydration | OperationMetaSyncOperation | OperationMetaTaskExecution

OwnersPaths

OwnersPaths: string[] | Record<string, string[]>

PartialBinEntry

PartialBinEntry: string | PartialBinConfig

PartialOwnersPaths

PartialOwnersPaths: string[] | Record<string, string[]>

PartialProjectDependsOn

PartialProjectDependsOn: string | PartialDependencyConfig

PartialTaskArgs

PartialTaskArgs: null | string | string[]

PartialTaskDependency

PartialTaskDependency: string | PartialTaskDependencyConfig

PartialTemplateVariable

PartialTemplateVariable: PartialTemplateVariableBoolSetting | PartialTemplateVariableEnumSetting | PartialTemplateVariableNumberSetting | PartialTemplateVariableStringSetting

PartialTemplateVariableEnumDefault

PartialTemplateVariableEnumDefault: string | string[]

PartialTemplateVariableEnumValue

PartialTemplateVariableEnumValue: string | PartialTemplateVariableEnumValueConfig

PartialWorkspaceProjects

PartialWorkspaceProjects: PartialWorkspaceProjectsConfig | string[] | Record<string, string>

PayloadActionCompleted

PayloadActionCompleted: WebhookPayload<action.completed, EventActionCompleted>

PayloadActionFinished

PayloadActionFinished: WebhookPayload<action.finished, EventActionFinished>
@deprecated

PayloadActionStarted

PayloadActionStarted: WebhookPayload<action.started, EventActionStarted>

PayloadDependenciesInstalled

PayloadDependenciesInstalled: WebhookPayload<dependencies.installed, EventDependenciesInstalled>

PayloadDependenciesInstalling

PayloadDependenciesInstalling: WebhookPayload<dependencies.installing, EventDependenciesInstalling>

PayloadPipelineAborted

PayloadPipelineAborted: WebhookPayload<pipeline.aborted, EventPipelineAborted>
@deprecated

PayloadPipelineCompleted

PayloadPipelineCompleted: WebhookPayload<pipeline.completed, EventPipelineCompleted>

PayloadPipelineFinished

PayloadPipelineFinished: WebhookPayload<pipeline.finished, EventPipelineFinished>
@deprecated

PayloadPipelineStarted

PayloadPipelineStarted: WebhookPayload<pipeline.started, EventPipelineStarted>

PayloadProjectSynced

PayloadProjectSynced: WebhookPayload<project.synced, EventProjectSynced>

PayloadProjectSyncing

PayloadProjectSyncing: WebhookPayload<project.syncing, EventProjectSyncing>

PayloadTargetRan

PayloadTargetRan: WebhookPayload<target.ran, EventTargetRan>
@deprecated

PayloadTargetRunning

PayloadTargetRunning: WebhookPayload<target.running, EventTargetRunning>
@deprecated

PayloadTaskRan

PayloadTaskRan: WebhookPayload<task.ran, EventTaskRan>

PayloadTaskRunning

PayloadTaskRunning: WebhookPayload<task.running, EventTaskRunning>

PayloadToolInstalled

PayloadToolInstalled: WebhookPayload<tool.installed, EventToolInstalled>

PayloadToolInstalling

PayloadToolInstalling: WebhookPayload<tool.installing, EventToolInstalling>

PayloadWorkspaceSynced

PayloadWorkspaceSynced: WebhookPayload<workspace.synced, EventWorkspaceSynced>

PayloadWorkspaceSyncing

PayloadWorkspaceSyncing: WebhookPayload<workspace.syncing, {}>

PlatformType

PlatformType: bun | deno | node | python | rust | system | unknown

Platforms that each programming language can belong to.

PluginLocator

PluginLocator: string

ProjectDependsOn

ProjectDependsOn: string | DependencyConfig

ProjectType

ProjectType: application | automation | configuration | library | scaffolding | tool | unknown

The type of project, for categorizing.

StackType

StackType: backend | frontend | infrastructure | systems | unknown

The technology stack of the project, for categorizing.

TaskArgs

TaskArgs: null | string | string[]

TaskDependency

TaskDependency: string | TaskDependencyConfig

TaskMergeStrategy

TaskMergeStrategy: append | prepend | preserve | replace

The strategy in which to merge a specific task option.

TaskOperatingSystem

TaskOperatingSystem: linux | macos | windows

The operating system in which to only run this task on.

TaskOptionAffectedFiles

TaskOptionAffectedFiles: boolean | args | env

TaskOptionEnvFile

TaskOptionEnvFile: boolean | string | string[]

TaskOutputStyle

TaskOutputStyle: buffer | buffer-only-failure | hash | none | stream

The style in which task output will be printed to the console.

TaskPreset

TaskPreset: server | watcher

Preset options to inherit.

TaskType

TaskType: build | run | test

The type of task.

TaskUnixShell

TaskUnixShell: bash | elvish | fish | ion | murex | nu | pwsh | xonsh | zsh

A list of available shells on Unix.

TaskWindowsShell

TaskWindowsShell: bash | elvish | fish | murex | nu | pwsh | xonsh

A list of available shells on Windows.

TemplateVariable

TemplateVariable: TemplateVariableBoolSetting | TemplateVariableEnumSetting | TemplateVariableNumberSetting | TemplateVariableStringSetting

TemplateVariableEnumDefault

TemplateVariableEnumDefault: string | string[]

TemplateVariableEnumValue

TemplateVariableEnumValue: string | TemplateVariableEnumValueConfig

UnresolvedVersionSpec

UnresolvedVersionSpec: string

VcsHookFormat

VcsHookFormat: bash | native

The format to use for generated VCS hook files.

VcsManager

VcsManager: git

The VCS being utilized by the repository.

VcsProvider

VcsProvider: bitbucket | github | gitlab | other

The upstream version control provider, where the repository source code is stored.

WorkspaceProjects

WorkspaceProjects: WorkspaceProjectsConfig | string[] | Record<string, string>