Change cuetsy annotation "targetType" to "kind" (#38564)

Mirrors change made upstream in cuetsy
This commit is contained in:
sam boyer 2021-08-29 14:29:06 -04:00 committed by GitHub
parent 3df001db93
commit 96557ecadc
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
9 changed files with 55 additions and 55 deletions

View File

@ -1,47 +1,47 @@
package schema
AxisPlacement: "auto" | "top" | "right" | "bottom" | "left" | "hidden" @cuetsy(targetType="enum")
PointVisibility: "auto" | "never" | "always" @cuetsy(targetType="enum")
DrawStyle: "line" | "bars" | "points" @cuetsy(targetType="enum")
LineInterpolation: "linear" | "smooth" | "stepBefore" | "stepAfter" @cuetsy(targetType="enum")
ScaleDistribution: "linear" | "log" @cuetsy(targetType="enum")
GraphGradientMode: "none" | "opacity" | "hue" | "scheme" @cuetsy(targetType="enum")
StackingMode: "none" | "normal" | "percent" @cuetsy(targetType="enum")
BarValueVisibility: "auto" | "never" | "always" @cuetsy(targetType="enum")
BarAlignment: -1 | 0 | 1 @cuetsy(targetType="enum",memberNames="Before|Center|After")
ScaleOrientation: 0 | 1 @cuetsy(targetType="enum",memberNames="Horizontal|Vertical")
ScaleDirection: 1 | 1 | -1 | -1 @cuetsy(targetType="enum",memberNames="Up|Right|Down|Left")
AxisPlacement: "auto" | "top" | "right" | "bottom" | "left" | "hidden" @cuetsy(kind="enum")
PointVisibility: "auto" | "never" | "always" @cuetsy(kind="enum")
DrawStyle: "line" | "bars" | "points" @cuetsy(kind="enum")
LineInterpolation: "linear" | "smooth" | "stepBefore" | "stepAfter" @cuetsy(kind="enum")
ScaleDistribution: "linear" | "log" @cuetsy(kind="enum")
GraphGradientMode: "none" | "opacity" | "hue" | "scheme" @cuetsy(kind="enum")
StackingMode: "none" | "normal" | "percent" @cuetsy(kind="enum")
BarValueVisibility: "auto" | "never" | "always" @cuetsy(kind="enum")
BarAlignment: -1 | 0 | 1 @cuetsy(kind="enum",memberNames="Before|Center|After")
ScaleOrientation: 0 | 1 @cuetsy(kind="enum",memberNames="Horizontal|Vertical")
ScaleDirection: 1 | 1 | -1 | -1 @cuetsy(kind="enum",memberNames="Up|Right|Down|Left")
LineStyle: {
fill?: "solid" | "dash" | "dot" | "square"
dash?: [...number]
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
LineConfig: {
lineColor?: string
lineWidth?: number
lineInterpolation?: LineInterpolation
lineStyle?: LineStyle
spanNulls?: bool | number
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
BarConfig: {
barAlignment?: BarAlignment
barWidthFactor?: number
barMaxWidth?: number
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
FillConfig: {
fillColor?: string
fillOpacity?: number
fillBelowTo?: string
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
PointsConfig: {
showPoints?: PointVisibility
pointSize?: number
pointColor?: string
pointSymbol?: string
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
ScaleDistributionConfig: {
type: ScaleDistribution
log?: number
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
AxisConfig: {
axisPlacement?: AxisPlacement
axisLabel?: string
@ -49,26 +49,26 @@ AxisConfig: {
axisSoftMin?: number
axisSoftMax?: number
scaleDistribution?: ScaleDistributionConfig
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
HideSeriesConfig: {
tooltip: bool
legend: bool
viz: bool
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
StackingConfig: {
mode?: StackingMode
group?: string
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
StackableFieldConfig: {
stacking?: StackingConfig
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
HideableFieldConfig: {
hideFrom?: HideSeriesConfig
} @cuetsy(targetType="interface")
GraphTresholdsStyleMode: "off" | "line" | "area" | "line+area" | "series" @cuetsy(targetType="enum",memberNames="Off|Line|Area|LineAndArea|Series")
} @cuetsy(kind="interface")
GraphTresholdsStyleMode: "off" | "line" | "area" | "line+area" | "series" @cuetsy(kind="enum",memberNames="Off|Line|Area|LineAndArea|Series")
GraphThresholdsStyleConfig: {
mode: GraphTresholdsStyleMode
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
GraphFieldConfig: {
LineConfig
FillConfig
@ -80,4 +80,4 @@ GraphFieldConfig: {
drawStyle?: DrawStyle
gradientMode?: GraphGradientMode
thresholdsStyle?: GraphThresholdsStyleConfig
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")

View File

@ -1,8 +1,8 @@
package schema
LegendPlacement: "bottom" | "right" @cuetsy(targetType="type")
LegendPlacement: "bottom" | "right" @cuetsy(kind="type")
LegendDisplayMode: "list" | "table" | "hidden" @cuetsy(targetType="enum")
LegendDisplayMode: "list" | "table" | "hidden" @cuetsy(kind="enum")
VizLegendOptions: {
displayMode: LegendDisplayMode
@ -10,4 +10,4 @@ VizLegendOptions: {
asTable: bool | *false
isVisible: bool | *false
calcs: [...string]
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")

View File

@ -6,13 +6,13 @@ package schema
TableSortByFieldState: {
displayName: string
desc?: bool
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
SingleStatBaseOptions: {
OptionsWithTextFormatting
reduceOptions: ReduceDataOptions
orientation: VizOrientation
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO copy back to appropriate place
ReduceDataOptions: {
// If true show each row value
@ -23,31 +23,31 @@ ReduceDataOptions: {
calcs: [...string]
// Which fields to show. By default this is only numeric fields
fields?: string
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO copy back to appropriate place
VizOrientation: "auto" | "vertical" | "horizontal" @cuetsy(targetType="enum")
VizOrientation: "auto" | "vertical" | "horizontal" @cuetsy(kind="enum")
// TODO copy back to appropriate place
OptionsWithTooltip: {
// FIXME this field is non-optional in the corresponding TS type
tooltip?: VizTooltipOptions
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO copy back to appropriate place
OptionsWithLegend: {
// FIXME this field is non-optional in the corresponding TS type
legend?: VizLegendOptions
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO copy back to appropriate place
OptionsWithTextFormatting: {
text?: VizTextDisplayOptions
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO copy back to appropriate place
BigValueColorMode: "value" | "background" | "none" @cuetsy(targetType="enum")
BigValueColorMode: "value" | "background" | "none" @cuetsy(kind="enum")
// TODO copy back to appropriate place
BigValueGraphMode: "none" | "line" | "area" @cuetsy(targetType="enum")
BigValueGraphMode: "none" | "line" | "area" @cuetsy(kind="enum")
// TODO copy back to appropriate place
BigValueJustifyMode: "auto" | "center" @cuetsy(targetType="enum")
BigValueJustifyMode: "auto" | "center" @cuetsy(kind="enum")
// TODO copy back to appropriate place
// TODO does cuetsy handle underscores the expected way?
BigValueTextMode: "auto" | "value" | "value_and_name" | "name" | "none" @cuetsy(targetType="enum")
BigValueTextMode: "auto" | "value" | "value_and_name" | "name" | "none" @cuetsy(kind="enum")
// TODO copy back to appropriate place
BarGaugeDisplayMode: "basic" | "lcd" | "gradient" @cuetsy(targetType="enum")
BarGaugeDisplayMode: "basic" | "lcd" | "gradient" @cuetsy(kind="enum")

View File

@ -1,7 +1,7 @@
package schema
// TODO -- should not be table specific!
FieldTextAlignment: "auto" | "left" | "right" | "center" @cuetsy(targetType="type")
FieldTextAlignment: "auto" | "left" | "right" | "center" @cuetsy(kind="type")
// FIXME can't write enums as structs, must use disjunctions
TableCellDisplayMode: {
@ -13,11 +13,11 @@ TableCellDisplayMode: {
JSONView: "json-view"
BasicGauge: "basic"
Image: "image"
} @cuetsy(targetType="enum")
} @cuetsy(kind="enum")
TableFieldOptions: {
width?: number
align: FieldTextAlignment | *"auto"
displayMode: TableCellDisplayMode | *"auto"
hidden?: bool // ?? default is missing or false ??
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")

View File

@ -5,4 +5,4 @@ VizTextDisplayOptions: {
titleSize?: number
// Explicit value text size
valueSize?: number
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")

View File

@ -1,7 +1,7 @@
package schema
TooltipDisplayMode: "single" | "multi" | "none" @cuetsy(targetType="enum")
TooltipDisplayMode: "single" | "multi" | "none" @cuetsy(kind="enum")
VizTooltipOptions: {
mode: TooltipDisplayMode
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")

View File

@ -76,10 +76,10 @@ Family: scuemata.#Family & {
panels?: [...(#Panel | #GraphPanel | #RowPanel)]
// TODO docs
#FieldColorModeId: "thresholds" | "palette-classic" | "palette-saturated" | "continuous-GrYlRd" | "fixed" @cuetsy(targetType="enum")
#FieldColorModeId: "thresholds" | "palette-classic" | "palette-saturated" | "continuous-GrYlRd" | "fixed" @cuetsy(kind="enum")
// TODO docs
#FieldColorSeriesByMode: "min" | "max" | "last" @cuetsy(targetType="type")
#FieldColorSeriesByMode: "min" | "max" | "last" @cuetsy(kind="type")
// TODO docs
#FieldColor: {
@ -89,7 +89,7 @@ Family: scuemata.#Family & {
fixedColor?: string
// Some visualizations need to know how to assign a series color from by value color schemes
seriesBy?: #FieldColorSeriesByMode
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO docs
#Threshold: {
@ -102,16 +102,16 @@ Family: scuemata.#Family & {
// TODO are the values here enumerable into a disjunction?
// Some seem to be listed in typescript comment
state?: string
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
#ThresholdsMode: "absolute" | "percentage" @cuetsy(targetType="enum")
#ThresholdsMode: "absolute" | "percentage" @cuetsy(kind="enum")
#ThresholdsConfig: {
mode: #ThresholdsMode
// Must be sorted by 'value', first value is always -Infinity
steps: [...#Threshold]
} @cuetsy(targetType="interface")
} @cuetsy(kind="interface")
// TODO docs
// FIXME this is extremely underspecfied; wasn't obvious which typescript types corresponded to it

View File

@ -22,8 +22,8 @@ Family: {
lineages: [
[
{
#TimelineMode: "changes" | "samples" @cuetsy(targetType="enum")
#TimelineValueAlignment: "center" | "left" | "right" @cuetsy(targetType="type")
#TimelineMode: "changes" | "samples" @cuetsy(kind="enum")
#TimelineValueAlignment: "center" | "left" | "right" @cuetsy(kind="type")
PanelOptions: {
// FIXME ts comments indicate this shouldn't be in the saved model, but currently is emitted
mode?: #TimelineMode

View File

@ -18,7 +18,7 @@ Family: {
lineages: [
[
{
TextMode: "html" | "markdown" @cuetsy(targetType="enum",withName="TextMode")
TextMode: "html" | "markdown" @cuetsy(kind="enum",withName="TextMode")
PanelOptions: {
mode: TextMode | *"markdown"