Files
misode.github.io/src/app/components/generator/McdocRenderer.tsx
OffsetMonkey538 1f8be81f50
Some checks failed
Deploy to GitHub Pages / build (push) Has been cancelled
Deploy to GitHub Pages / deploy (push) Has been cancelled
Loot Table Modifier generator (#758)
* Loot Table Modifier loot_modifier generator

Should support everything currently implemented

* Translation keys

* Make 'actions' and 'predicates' always a list

Seems simpler to understand and a list of one entry behaves exactly the same

* Update loot-table-modifier.mcdoc

Should match currently latest commit

* Fix loot modifier path in datapack being incorrect

* Match v2 alpha 1

* Import LootPoolEntry

* Add files via upload

* Revert "Add files via upload"

This reverts commit 7e9c50ee10.

* add condition_add action

* Add union member name overrides

Co-authored-by: Misode <misoloo64@gmail.com>

---------

Co-authored-by: Misode <misoloo64@gmail.com>
2026-01-19 21:06:31 +01:00

1298 lines
44 KiB
TypeScript

import * as core from '@spyglassmc/core'
import { ColorFormat } from '@spyglassmc/core'
import type { JsonPairNode } from '@spyglassmc/json'
import * as json from '@spyglassmc/json'
import { JsonArrayNode, JsonBooleanNode, JsonNode, JsonNumberNode, JsonObjectNode, JsonStringNode } from '@spyglassmc/json'
import { localeQuote } from '@spyglassmc/locales'
import type { ListType, LiteralType, McdocType, NumericType, PrimitiveArrayType, StringType, TupleType, UnionType } from '@spyglassmc/mcdoc'
import { handleAttributes } from '@spyglassmc/mcdoc/lib/runtime/attribute/index.js'
import type { SimplifiedEnum, SimplifiedMcdocType, SimplifiedMcdocTypeNoUnion, SimplifiedStructType, SimplifiedStructTypePairField } from '@spyglassmc/mcdoc/lib/runtime/checker/index.js'
import { getValues } from '@spyglassmc/mcdoc/lib/runtime/completer/index.js'
import { Identifier as Identifier1204, ItemStack as ItemStack1204 } from 'deepslate-1.20.4/core'
import { Identifier, ItemStack } from 'deepslate/core'
import DOMPurify from 'dompurify'
import { marked } from 'marked'
import { useCallback, useEffect, useMemo, useState } from 'preact/hooks'
import config from '../../Config.js'
import { useLocale } from '../../contexts/Locale.jsx'
import { useVersion } from '../../contexts/Version.jsx'
import { useFocus } from '../../hooks/useFocus.js'
import { checkVersion } from '../../services/Versions.js'
import { generateColor, hexId, intToHexRgb, randomInt, randomSeed } from '../../Utils.js'
import { Btn } from '../Btn.jsx'
import { ItemDisplay } from '../ItemDisplay.jsx'
import { ItemDisplay1204 } from '../ItemDisplay1204.jsx'
import { Octicon } from '../Octicon.jsx'
import { formatIdentifier, getCategory, getChange, getDefault, getItemType, isDefaultCollapsedType, isFixedList, isInlineTuple, isListOrArray, isNumericType, isSelectRegistry, quickEqualTypes, simplifyType } from './McdocHelpers.js'
export interface McdocContext extends core.CheckerContext {
makeEdit: MakeEdit
}
type MakeEdit = (edit: (range: core.Range) => JsonNode | undefined) => void
interface Props<Type extends SimplifiedMcdocType = SimplifiedMcdocType> {
type: Type
optional?: boolean
excludeStrings?: string[]
node: JsonNode | undefined
ctx: McdocContext
}
export function McdocRoot({ type, node, ctx } : Props) {
const { locale } = useLocale()
if (type.kind === 'struct' && type.fields.length > 0 && JsonObjectNode.is(node)) {
return <StructBody type={type} node={node} ctx={ctx} />
}
return <>
<div class="node-header">
<Errors type={type} node={node} ctx={ctx} />
<Key label={locale('root')} />
<Head type={type} node={node} ctx={ctx} />
</div>
<Body type={type} node={node} ctx={ctx} />
</>
}
function Head({ type, optional, excludeStrings, node, ctx }: Props) {
if (type.kind === 'string') {
return <StringHead type={type} optional={optional} excludeStrings={excludeStrings} node={node} ctx={ctx} />
}
if (type.kind === 'enum') {
return <EnumHead type={type} optional={optional} excludeStrings={excludeStrings} node={node} ctx={ctx} />
}
if (isNumericType(type)) {
return <NumericHead type={type} node={node} ctx={ctx} />
}
if (type.kind === 'boolean') {
return <BooleanHead type={type} node={node} ctx={ctx} />
}
if (type.kind === 'union') {
return <UnionHead type={type} optional={optional} node={node} ctx={ctx} />
}
if (type.kind === 'struct') {
return <StructHead type={type} optional={optional} node={node} ctx={ctx} />
}
if (isListOrArray(type)) {
if (isFixedList(type)) {
return <TupleHead type={{ kind: 'tuple', items: [...Array(type.lengthRange.min)].map(() => getItemType(type)), attributes: type.attributes }} optional={optional} node={node} ctx={ctx} />
}
return <ListHead type={type} node={node} ctx={ctx} />
}
if (type.kind === 'tuple') {
return <TupleHead type={type} optional={optional} node={node} ctx={ctx} />
}
if (type.kind === 'literal') {
return <LiteralHead type={type} optional={optional} node={node} ctx={ctx} />
}
if (type.kind === 'any' || type.kind === 'unsafe') {
return <AnyHead type={type} node={node} ctx={ctx} />
}
return <></>
}
function Body({ type, optional, node, ctx }: Props<SimplifiedMcdocType>) {
if (type.kind === 'union') {
return <UnionBody type={type} optional={optional} node={node} ctx={ctx} />
}
if (type.kind === 'struct') {
if (!JsonObjectNode.is(node) || type.fields.length === 0) {
return <></>
}
return <div class="node-body">
<StructBody type={type} node={node} ctx={ctx} />
</div>
}
if (isListOrArray(type)) {
if (!JsonArrayNode.is(node)) {
return <></>
}
if (isFixedList(type)) {
const tupleType: TupleType = { kind: 'tuple', items: [...Array(type.lengthRange.min)].map(() => getItemType(type)), attributes: type.attributes }
if (isInlineTuple(tupleType)) {
return <></>
}
return <div class="node-body">
<TupleBody type={tupleType} node={node} ctx={ctx} />
</div>
}
if (node.children?.length === 0) {
return <></>
}
return <div class="node-body">
<ListBody type={type} node={node} ctx={ctx} />
</div>
}
if (type.kind === 'tuple') {
if (isInlineTuple(type)) {
return <></>
}
return <div class="node-body">
<TupleBody type={type} node={node} ctx={ctx} />
</div>
}
if (type.kind === 'any' || type.kind === 'unsafe') {
return <AnyBody type={type} optional={optional} node={node} ctx={ctx} />
}
return <></>
}
const SPECIAL_UNSET = '__unset__'
function StringHead({ type, optional, excludeStrings, node, ctx }: Props<StringType>) {
const { locale } = useLocale()
const nodeValue = (JsonStringNode.is(node) ? node.value : undefined)?.replaceAll('\n', '\\n')
const [value, setValue] = useState(nodeValue)
useEffect(() => {
setValue(nodeValue)
}, [nodeValue])
const idAttribute = type.attributes?.find(a => a.name === 'id')?.value
const idRegistry = idAttribute?.kind === 'literal' && idAttribute.value.kind === 'string'
? idAttribute.value.value
: idAttribute?.kind === 'tree' && idAttribute.values.registry?.kind === 'literal' && idAttribute.values.registry.value.kind === 'string'
? idAttribute.values.registry.value.value
: undefined
const idTags = idAttribute?.kind === 'tree' && idAttribute.values.tags?.kind === 'literal' && idAttribute.values.tags.value.kind === 'string'
? idAttribute.values.tags.value.value
: undefined
const isSelect = idRegistry && isSelectRegistry(idRegistry)
const onChangeValue = useCallback((newValue: string) => {
newValue = newValue.replaceAll('\\n', '\n')
if (nodeValue === newValue) {
return
}
ctx.makeEdit((range) => {
if ((newValue.length === 0 && optional) || (isSelect && newValue === SPECIAL_UNSET)) {
return undefined
}
const valueMap = [{ inner: core.Range.create(0), outer: core.Range.create(range.start) }]
const source = new core.Source(JSON.stringify(newValue), valueMap)
const string = core.string(json.parser.JsonStringOptions)(source, ctx)
return {
...string,
type: 'json:string',
}
})
}, [optional, node, ctx, nodeValue, isSelect])
const onCommitValue = useCallback(() => {
onChangeValue(value ?? '')
}, [value, onChangeValue])
const completions = useMemo(() => {
const values = getValues(type, { ...ctx, offset: node?.range.start ?? 0 })
.filter(c => c.kind === 'string' && c.value !== 'THIS')
.filter(c => !excludeStrings?.includes(c.value))
values.sort((a, b) => a.value.localeCompare(b.value))
return values
}, [type, excludeStrings, node, ctx])
const datalistId = `mcdoc_completions_${hexId()}`
const gen = idRegistry ? config.generators.find(gen => gen.id === idRegistry) : undefined
const color = type.attributes?.find(a => a.name === 'color')?.value
const colorKind = color?.kind === 'literal' && color.value.kind === 'string' ? color.value.value : undefined
const onRandomColor = useCallback(() => {
const color = generateColor()
onChangeValue(intToHexRgb(color))
}, [onChangeValue])
return <>
{((idRegistry === 'item' || idRegistry === 'block') && idTags !== 'implicit' && value && !value.startsWith('#')) && <ItemIdPreview id={value}/>}
{isSelect ? <>
<select value={value === undefined ? SPECIAL_UNSET : value} onInput={(e) => onChangeValue((e.target as HTMLInputElement).value)}>
{(value === undefined || optional) && <option value={SPECIAL_UNSET}>{locale('unset')}</option>}
{(value !== undefined && !completions.map(c => c.value).includes(value)) && <option value={value}>{value}</option>}
{completions.map(c => <option value={c.value}>{formatIdentifier(c.value)}</option>)}
</select>
</> : <>
{completions.length > 0 && <datalist id={datalistId}>
{completions.map(c => <option>{c.value}</option>)}
</datalist>}
<input class={colorKind === 'hex_rgb' ? 'short-input' : idRegistry ? 'long-input' : ''} value={value ?? ''} onInput={(e) => setValue((e.target as HTMLInputElement).value)} onBlur={onCommitValue} onSubmit={onCommitValue} onKeyDown={(e) => {if (e.key === 'Enter') onCommitValue()}} list={completions.length > 0 ? datalistId : undefined} />
{value && gen && <a href={`/${gen.url}/?preset=${value?.replace(/^minecraft:/, '')}`} class="tooltipped tip-se" aria-label={locale('follow_reference')}>
{Octicon.link_external}
</a>}
</>}
{colorKind === 'hex_rgb' && <>
<input class="short-input" type="color" value={value} onChange={(e) => onChangeValue((e.target as HTMLInputElement).value)} />
<button class="tooltipped tip-se" aria-label={locale('generate_new_color')} onClick={onRandomColor}>{Octicon.sync}</button>
</>}
</>
}
function ItemIdPreview({ id }: { id: string }) {
const { version } = useVersion()
const stack = useMemo(() => {
try {
if (!checkVersion(version, '1.20.5')) {
return new ItemStack1204(Identifier1204.parse(id), 1)
}
return new ItemStack(Identifier.parse(id), 1)
} catch (e) {
return undefined
}
}, [id, version])
return <>{stack && <label>
{stack instanceof ItemStack1204
? <ItemDisplay1204 item={stack} />
: <ItemDisplay item={stack} />}
</label>}</>
}
function EnumHead({ type, optional, excludeStrings, node, ctx }: Props<SimplifiedEnum>) {
const { locale } = useLocale()
const value = JsonStringNode.is(node) ? node.value : (node && JsonNumberNode.is(node)) ? Number(node.value.value) : undefined
const onChangeValue = useCallback((newValue: string) => {
if (value === newValue) {
return
}
ctx.makeEdit((range) => {
if (newValue === SPECIAL_UNSET) {
return undefined
}
if (type.enumKind === 'string') {
return {
type: 'json:string',
range,
options: json.parser.JsonStringOptions,
value: newValue,
valueMap: [{ inner: core.Range.create(0), outer: core.Range.create(range.start) }],
}
}
const number: core.FloatNode = {
type: 'float',
range,
value: parseFloat(newValue),
}
const result: JsonNumberNode = {
type: 'json:number',
range,
children: [number],
value: number,
}
number.parent = result
return result
})
}, [type.enumKind, value, ctx])
const color = type.attributes?.find(a => a.name === 'color')?.value
const colorKind = color?.kind === 'literal' && color.value.kind === 'string' ? color.value.value : undefined
const nodeColor = node?.color ? (Array.isArray(node.color) ? node.color : node.color.value ) : undefined
const inputColor = nodeColor ? core.ColorPresentation.fromColorFormat(ColorFormat.HexRGB, nodeColor, core.Range.create(0)).text : undefined
return <>
<select value={value === undefined ? SPECIAL_UNSET : value} onInput={(e) => onChangeValue((e.target as HTMLSelectElement).value)}>
{(value === undefined || optional) && <option value={SPECIAL_UNSET}>{locale('unset')}</option>}
{(value !== undefined && !type.values.map(v => v.value).includes(value)) && <option value={value}>{value}</option>}
{type.values.filter(v => !excludeStrings?.includes(v.value.toString())).map(value =>
<option value={value.value}>{formatIdentifier(value.identifier, value.attributes)}</option>
)}
</select>
{colorKind === 'named' && nodeColor && <>
<input class="short-input" type="color" value={inputColor} readonly disabled />
</>}
</>
}
function NumericHead({ type, node, ctx }: Props<NumericType>) {
const { locale } = useLocale()
const nodeValue = node && JsonNumberNode.is(node) ? Number(node.value.value) : undefined
const [value, setValue] = useState(nodeValue?.toString())
useEffect(() => {
setValue(nodeValue?.toString())
}, [nodeValue])
const onChangeValue = useCallback((value: string | bigint | number) => {
const number = typeof value === 'string'
? (value.length === 0 ? undefined : Number(value))
: value
if (number !== undefined && Number.isNaN(number)) {
return
}
ctx.makeEdit((range) => {
if (number === undefined) {
return undefined
}
const newValue: core.FloatNode | core.LongNode = typeof number === 'bigint' || Number.isInteger(number)
? { type: 'long', range, value: BigInt(number) }
: { type: 'float', range, value: Number(number) }
const newNode: JsonNumberNode = {
type: 'json:number',
range,
value: newValue,
children: [newValue],
}
newValue.parent = newNode
return newNode
})
}, [node, ctx])
const onCommitValue = useCallback(() => {
onChangeValue(value ?? '')
}, [value, onChangeValue])
const color = type.attributes?.find(a => a.name === 'color')?.value
const colorKind = color?.kind === 'literal' && color.value.kind === 'string' ? color.value.value : undefined
const onChangeColor = useCallback((value: string) => {
onChangeValue(parseInt(value.slice(1), 16).toString())
}, [onChangeValue])
const onRandomColor = useCallback(() => {
onChangeValue(generateColor().toString())
}, [onChangeValue])
const random = type.attributes?.find(a => a.name === 'random')
const onRandom = useCallback(() => {
onChangeValue(type.kind === 'long' ? randomSeed() : randomInt())
}, [type, onChangeValue])
return <>
<input class="short-input" type="number" value={value} onInput={(e) => setValue((e.target as HTMLInputElement).value)} onBlur={onCommitValue} onSubmit={onCommitValue} onKeyDown={(e) => {if (e.key === 'Enter') onCommitValue()}} />
{colorKind && <>
<input class="short-input" type="color" value={intToHexRgb(nodeValue)} onChange={(e) => onChangeColor((e.target as HTMLInputElement).value)} />
<button class="tooltipped tip-se" aria-label={locale('generate_new_color')} onClick={onRandomColor}>{Octicon.sync}</button>
</>}
{random && <>
<button class="tooltipped tip-se" aria-label={locale('generate_new_seed')} onClick={onRandom}>{Octicon.sync}</button>
</>}
</>
}
function BooleanHead({ node, ctx }: Props) {
const value = node && JsonBooleanNode.is(node) ? node.value : undefined
const onSelect = useCallback((newValue: boolean) => {
ctx.makeEdit((range) => {
if (value === newValue) {
return undefined
}
return {
type: 'json:boolean',
range,
value: newValue,
}
})
}, [node, ctx, value])
return <>
<button class={value === false ? 'selected' : ''} onClick={() => onSelect(false)}>False</button>
<button class={value === true ? 'selected' : ''} onClick={() => onSelect(true)}>True</button>
</>
}
function UnionHead({ type, optional, node, ctx }: Props<UnionType<SimplifiedMcdocTypeNoUnion>>) {
const { locale } = useLocale()
if (type.members.length === 0) {
return <></>
}
const selectedType = selectUnionMember(type, node)
const onSelect = useCallback((newValue: string) => {
ctx.makeEdit((range) => {
if (newValue === SPECIAL_UNSET) {
return undefined
}
const newSelected = type.members[parseInt(newValue)]
if (node && selectedType) {
return getChange(newSelected, selectedType, node, ctx)
}
return getDefault(newSelected, range, ctx)
})
}, [type, node, ctx, selectedType])
const memberIndex = selectedType ? type.members.findIndex(m => quickEqualTypes(m, selectedType)) : -1
return <>
<select value={memberIndex > -1 ? memberIndex : SPECIAL_UNSET} onInput={(e) => onSelect((e.target as HTMLSelectElement).value)}>
{(selectedType === undefined || optional) && <option value={SPECIAL_UNSET}>{locale('unset')}</option>}
{type.members.map((member, index) =>
<option value={index}>{formatUnionMember(member, type.members.filter(m => m !== member))}</option>
)}
</select>
{selectedType && selectedType.kind !== 'literal' && <Head type={selectedType} node={node} ctx={ctx} />}
</>
}
function formatUnionMember(type: SimplifiedMcdocTypeNoUnion, others: SimplifiedMcdocTypeNoUnion[]): string {
const memberNameAttribute = type.attributes?.find(a => a.name === 'misode_member_name')?.value
if (memberNameAttribute?.kind === 'literal' && memberNameAttribute.value.kind === 'string') {
return memberNameAttribute.value.value
}
if (type.kind === 'literal') {
return formatIdentifier(type.value.value.toString())
}
if (!others.some(o => o.kind === type.kind)) {
// No other member is of this kind
return formatIdentifier(type.kind === 'struct' ? 'object' : type.kind)
}
if (type.kind === 'struct') {
// Show the first literal key
const firstKey = type.fields.find(f => f.key.kind === 'literal')?.key
if (firstKey) {
return formatUnionMember(firstKey, [])
}
}
return formatIdentifier(type.kind === 'struct' ? 'object' : type.kind)
}
function UnionBody({ type, optional, node, ctx }: Props<UnionType<SimplifiedMcdocTypeNoUnion>>) {
const selectedType = selectUnionMember(type, node)
if (selectedType === undefined) {
return <></>
}
return <Body type={selectedType} optional={optional} node={node} ctx={ctx} />
}
function selectUnionMember(union: UnionType<SimplifiedMcdocTypeNoUnion>, node: JsonNode | undefined) {
const selectedType = node?.typeDef
if (!selectedType || selectedType.kind === 'any' || selectedType.kind === 'unsafe') {
return undefined
}
if (selectedType.kind === 'union') {
// Find the first selected type that is also part of the original definition.
// The node technically matches all members of this union,
// ideally the editor should show a combination of all members
return selectedType.members.find(m1 => union.members.find(m2 => quickEqualTypes(m1, m2)))
}
return selectedType
}
function StructHead({ type: outerType, optional, node, ctx }: Props<SimplifiedStructType>) {
const { locale } = useLocale()
const type = node?.typeDef?.kind === 'struct' ? node.typeDef : outerType
const onRemove = useCallback(() => {
ctx.makeEdit(() => {
return undefined
})
}, [ctx])
const onSetDefault = useCallback(() => {
ctx.makeEdit((range) => {
return getDefault(type, range, ctx)
})
}, [type, ctx])
return <>
{optional
? (JsonObjectNode.is(node)
? <button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={onRemove}>
{Octicon.trashcan}
</button>
: <button class="add tooltipped tip-se" aria-label={locale('expand')} onClick={onSetDefault}>
{Octicon.plus_circle}
</button>)
: (!JsonObjectNode.is(node)
? <button class="add tooltipped tip-se" aria-label={locale('reset')} onClick={onSetDefault}>
{Octicon.history}
</button>
: <></>
)}
</>
}
function StructBody({ type: outerType, node, ctx }: Props<SimplifiedStructType>) {
if (!JsonObjectNode.is(node)) {
return <></>
}
const { expand, collapse, isToggled } = useToggles()
const type = node.typeDef?.kind === 'struct' ? node.typeDef : outerType
// For some reason spyglass can include fields that haven't been filtered out in node.typeDef
const fields = type.fields.filter(field => {
let keep = true
handleAttributes(field.attributes, ctx, (handler, config) => {
if (!keep || !handler.filterElement) {
return
}
if (!handler.filterElement(config, ctx)) {
keep = false
}
})
return keep
})
const staticFields = fields.filter(field => field.key.kind === 'literal')
const dynamicFields = fields.filter(field => field.key.kind !== 'literal')
const staticChilds: core.PairNode<JsonStringNode, JsonNode>[] = []
return <>
{staticFields.map(field => {
const key = (field.key as LiteralType).value.value.toString()
const index = node.children.findIndex(p => p.key?.value === key)
const pair = index === -1 ? undefined : node.children[index]
if (pair) {
staticChilds.push(pair)
}
return <StaticField key={key} pair={pair} index={index} field={field} fieldKey={key} staticFields={staticFields} isToggled={isToggled(key)} expand={expand(key)} collapse={collapse(key)} type={type} node={node} ctx={ctx} />
})}
{dynamicFields.map((field, index) => {
if (field.key.kind === 'any' && field.type.kind === 'any') {
// Hide dispatch fallback
return <></>
}
const keyType = simplifyType(field.key, ctx)
return <div key={`__dynamic_${index}__`} class="node">
<div class="node-header">
<DynamicKey keyType={keyType} valueType={field.type} parent={node} ctx={ctx} />
</div>
</div>
})}
{node.children.map((pair, index) => {
const key = pair.key?.value
if (staticChilds.includes(pair) || !key) {
return <></>
}
if (pair.value && core.Range.length(pair.value.range) === 0) {
return <></>
}
// TODO: correctly determine which dynamic field this is a key for
// Hack to support component negations, the only place with more than one dynamic field currently
const field = dynamicFields[key.startsWith('!') ? 1 : 0] as SimplifiedStructTypePairField | undefined
if (!field || (field.key.kind === 'any' && field.type.kind === 'any')) {
return <UnknownField key={key} pair={pair} index={index} fieldKey={key} type={type} node={node} ctx={ctx} />
}
return <DynamicField key={key} pair={pair} index={index} field={field} fieldKey={key} isToggled={isToggled(key)} expand={expand(key)} collapse={collapse(key)}type={type} node={node} ctx={ctx} />
})}
</>
}
interface StaticFieldProps extends Props {
pair: JsonPairNode | undefined
index: number
field: SimplifiedStructTypePairField
fieldKey: string
staticFields: SimplifiedStructTypePairField[]
isToggled: boolean | undefined
expand: (e: MouseEvent) => void
collapse: (e: MouseEvent) => void
node: JsonObjectNode
}
function StaticField({ pair, index, field, fieldKey, staticFields, isToggled, expand, collapse, node, ctx }: StaticFieldProps) {
const { locale } = useLocale()
const child = pair?.value
const childType = simplifyType(field.type, ctx, { key: pair?.key, parent: node })
const canToggle = isDefaultCollapsedType(field.type)
const isCollapsed = canToggle && isToggled !== true
const makeFieldEdit = useCallback<MakeEdit>((edit) => {
if (pair) {
ctx.makeEdit(() => {
const newChild = edit(child?.range ?? core.Range.create(pair.range.end))
if (newChild === undefined) {
node.children.splice(index, 1)
} else {
node.children[index] = {
type: 'pair',
range: pair.range,
key: pair.key,
value: newChild,
}
}
return node
})
} else {
const newFieldIndex = staticFields.indexOf(field)
const insertIndex = node.children.findIndex(child => {
const childKey = child.key?.value
if (!childKey) {
return false
}
const otherChildIndex = staticFields.findIndex(f => (f.key as LiteralType).value.value.toString() === childKey)
return otherChildIndex > newFieldIndex
})
const newChild = edit(core.Range.create(node.range.end))
if (newChild) {
ctx.makeEdit(() => {
const newPair: JsonPairNode = {
type: 'pair',
range: newChild.range,
key: {
type: 'json:string',
range: newChild.range,
options: json.parser.JsonStringOptions,
value: fieldKey,
valueMap: [{ inner: core.Range.create(0), outer: newChild.range }],
},
value: newChild,
}
if (insertIndex === -1) {
node.children.push(newPair)
} else {
node.children.splice(insertIndex, 0, newPair)
}
newPair.parent = node
return node
})
}
}
}, [pair, index, node, ctx])
const fieldCtx = useMemo(() => {
return { ...ctx, makeEdit: makeFieldEdit }
}, [ctx, makeFieldEdit])
return <div class="node" data-category={getCategory(field.type)}>
<div class="node-header">
{!field.optional && child === undefined && <ErrorIndicator error={{ message: locale('missing_key', localeQuote(fieldKey)), range: node.range, severity: 3 }} />}
<Errors type={childType} node={child} ctx={ctx} />
{canToggle && (isCollapsed
? <button class="toggle tooltipped tip-se" aria-label={`${locale('expand')}\n${locale('expand_all', 'Ctrl')}`} onClick={expand}>{Octicon.chevron_right}</button>
: <button class="toggle tooltipped tip-se" aria-label={`${locale('collapse')}\n${locale('collapse_all', 'Ctrl')}`} onClick={collapse}>{Octicon.chevron_down}</button>
)}
<Key label={fieldKey} doc={field.desc} />
{!isCollapsed && <Head type={childType} node={child} optional={field.optional} ctx={fieldCtx} />}
</div>
{!isCollapsed && <Body type={childType} node={child} optional={field.optional} ctx={fieldCtx} />}
</div>
}
interface DynamicKeyProps {
keyType: SimplifiedMcdocType
valueType: McdocType
parent: JsonObjectNode
ctx: McdocContext
}
function DynamicKey({ keyType, valueType, parent, ctx }: DynamicKeyProps) {
const { locale } = useLocale()
const [key, setKey] = useState<string>()
const keyNode = useMemo(() => {
if (key === undefined) return undefined
const node = JsonStringNode.mock(core.Range.create(0))
node.value = key
return node
}, [key])
const makeKeyEdit = useCallback<MakeEdit>((edit) => {
const newKeyNode = edit(core.Range.create(0))
if (JsonStringNode.is(newKeyNode)) {
setKey(newKeyNode.value)
}
}, [])
const keyCtx = useMemo(() => {
return { ...ctx, makeEdit: makeKeyEdit }
}, [ctx, makeKeyEdit])
const addKey = useCallback(() => {
if (!keyNode) {
return
}
setKey(undefined)
ctx.makeEdit((range) => {
const valueNode = getDefault(simplifyType(valueType, ctx, { key: keyNode, parent }), range, ctx)
const newPair: core.PairNode<JsonStringNode, JsonNode> = {
type: 'pair',
range: keyNode.range,
key: keyNode,
value: valueNode,
}
valueNode.parent = newPair
parent.children.push(newPair)
newPair.parent = parent
return parent
})
}, [keyNode, ctx])
const excludeStrings = useMemo(() => {
return parent.children.flatMap(pair => pair.key ? [pair.key.value] : [])
}, [parent])
return <>
<Head type={keyType} optional={true} excludeStrings={excludeStrings} node={keyNode} ctx={keyCtx} />
<button class="add tooltipped tip-se" aria-label={locale('add_key')} onClick={addKey} disabled={!key || key.length === 0}>{Octicon.plus_circle}</button>
</>
}
interface DynamicFieldProps extends Props {
pair: JsonPairNode
index: number
field: SimplifiedStructTypePairField
fieldKey: string
isToggled: boolean | undefined
expand: (e: MouseEvent) => void
collapse: (e: MouseEvent) => void
node: JsonObjectNode
}
function DynamicField({ pair, index, field, fieldKey, isToggled, expand, collapse, node, ctx }: DynamicFieldProps) {
const { locale } = useLocale()
const child = pair.value
const canToggle = JsonObjectNode.is(child) || JsonArrayNode.is(child)
const isCollapsed = canToggle && (isToggled === false || (isToggled === undefined && (node.children.length - node.children.length) > 20))
const childType = simplifyType(field.type, ctx, { key: pair.key, parent: node })
const category = getCategory(field.type)
const makeFieldEdit = useCallback<MakeEdit>((edit) => {
ctx.makeEdit(() => {
const newChild = edit(child?.range ?? core.Range.create(pair.range.end))
if (newChild === undefined) {
node.children.splice(index, 1)
} else {
node.children[index] = {
type: 'pair',
range: pair.range,
key: pair.key,
value: newChild,
}
}
return node
})
}, [pair, index, node, ctx])
const fieldCtx = useMemo(() => {
return { ...ctx, makeEdit: makeFieldEdit }
}, [ctx, makeFieldEdit])
return <div class="node" data-category={category}>
<div class="node-header">
<Errors type={childType} node={child} ctx={ctx} />
{canToggle && (isCollapsed
? <button class="toggle tooltipped tip-se" aria-label={`${locale('expand')}\n${locale('expand_all', 'Ctrl')}`} onClick={expand}>{Octicon.chevron_right}</button>
: <button class="toggle tooltipped tip-se" aria-label={`${locale('collapse')}\n${locale('collapse_all', 'Ctrl')}`} onClick={collapse}>{Octicon.chevron_down}</button>
)}
<button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={() => makeFieldEdit(() => undefined)}>
{Octicon.trashcan}
</button>
<Key label={fieldKey} raw={field.key.kind === 'string'} />
{!isCollapsed && <Head type={childType} node={child} ctx={fieldCtx} />}
</div>
{!isCollapsed && (childType.kind === 'struct' && category
? <div class="node-body-flat">
<StructBody type={childType} node={child} ctx={fieldCtx} />
</div>
: <Body type={childType} node={child} ctx={fieldCtx} />)}
</div>
}
interface UnknownFieldProps extends Props {
pair: JsonPairNode
index: number
fieldKey: string
node: JsonObjectNode
}
function UnknownField({ pair, index, fieldKey, node, ctx }: UnknownFieldProps) {
const { locale } = useLocale()
const removeField = useCallback(() => {
ctx.makeEdit(() => {
node.children.splice(index, 1)
return node
})
}, [index, node, ctx])
return <div class="node">
<div class="node-header">
<Errors type={{ kind: 'any' }} node={pair} ctx={ctx} />
<button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={removeField}>
{Octicon.trashcan}
</button>
<Key label={fieldKey} />
</div>
</div>
}
function ListHead({ type, node, ctx }: Props<ListType | PrimitiveArrayType>) {
const { locale } = useLocale()
const canAdd = (type.lengthRange?.max ?? Infinity) > (node?.children?.length ?? 0)
const onAddTop = useCallback(() => {
if (canAdd) {
ctx.makeEdit((range) => {
const itemType = simplifyType(getItemType(type), ctx)
const newValue = getDefault(itemType, range, ctx)
const newItem: core.ItemNode<JsonNode> = {
type: 'item',
range,
children: [newValue],
value: newValue,
}
newValue.parent = newItem
if (JsonArrayNode.is(node)) {
node.children.unshift(newItem)
newItem.parent = node
return node
}
const newArray: JsonArrayNode = {
type: 'json:array',
range,
children: [newItem],
}
newItem.parent = newArray
return newArray
})
}
}, [type, node, ctx, canAdd])
return <button class="add tooltipped tip-se" aria-label={locale('add_top')} onClick={() => onAddTop()} disabled={!canAdd}>
{Octicon.plus_circle}
</button>
}
function ListBody({ type: outerType, node, ctx }: Props<ListType | PrimitiveArrayType>) {
if (!JsonArrayNode.is(node)) {
return <></>
}
const { locale } = useLocale()
const { expand, collapse, isToggled } = useToggles()
const [maxShown, setMaxShown] = useState(50)
const type = node.typeDef && isListOrArray(node.typeDef) ? node.typeDef : outerType
const itemType = getItemType(type)
const category = getCategory(itemType)
const childType = simplifyType(itemType, ctx)
const canAdd = (type.lengthRange?.max ?? Infinity) > (node?.children?.length ?? 0)
const onAddBottom = useCallback(() => {
if (canAdd) {
ctx.makeEdit((range) => {
const itemType = simplifyType(getItemType(type), ctx)
const newValue = getDefault(itemType, range, ctx)
const newItem: core.ItemNode<JsonNode> = {
type: 'item',
range,
children: [newValue],
value: newValue,
}
newValue.parent = newItem
if (JsonArrayNode.is(node)) {
node.children.push(newItem)
newItem.parent = node
return node
}
const newArray: JsonArrayNode = {
type: 'json:array',
range,
children: [newItem],
}
newItem.parent = newArray
return newArray
})
}
}, [type, node, ctx, canAdd])
return <>
{node.children.map((item, index) => {
if (index === maxShown) {
return <div class="node-header">
<label>{locale('entries_hidden', `${node.children.length - maxShown}`)}</label>
<button onClick={() => setMaxShown(Math.min(maxShown + 50, node.children.length))}>{locale('entries_hidden.more', '50')}</button>
<button onClick={() => setMaxShown(node.children.length)}>{locale('entries_hidden.all')}</button>
</div>
}
if (index > maxShown) {
return <></>
}
const key = index.toString()
return <ListItem key={key} item={item} index={index} category={category} type={childType} isToggled={isToggled(key)} expand={expand(key)} collapse={collapse(key)} node={node} ctx={ctx} />
})}
{node.children.length > 0 && <div class="node-header">
<button class="add tooltipped tip-se" aria-label={locale('add_bottom')} onClick={() => onAddBottom()} disabled={!canAdd}>
{Octicon.plus_circle}
</button>
</div>}
</>
}
interface ListItemProps extends Props {
item: core.ItemNode<JsonNode>
index: number
category: string | undefined
isToggled: boolean | undefined
expand: (e: MouseEvent) => void
collapse: (e: MouseEvent) => void
node: JsonArrayNode
}
function ListItem({ item, index, category, type, isToggled, expand, collapse, node, ctx }: ListItemProps) {
const { locale } = useLocale()
const [active, setActive] = useFocus()
const child = item.value
const canToggle = JsonObjectNode.is(child)
const isCollapsed = canToggle && (isToggled === false || (isToggled === undefined && node.children.length > 20))
const canMoveUp = node.children.length > 1 && index > 0
const canMoveDown = node.children.length > 1 && index < (node.children.length - 1)
const onRemove = useCallback(() => {
ctx.makeEdit(() => {
node.children.splice(index, 1)
return node
})
}, [ctx, node, index])
const onMoveUp = useCallback(() => {
if (node.children.length <= 1 || index <= 0) {
return
}
ctx.makeEdit(() => {
const moved = node.children.splice(index, 1)
node.children.splice(index - 1, 0, ...moved)
return node
})
}, [ctx, node, index])
const onMoveDown = useCallback(() => {
if (node.children.length <= 1 || index >= node.children.length - 1) {
return
}
ctx.makeEdit(() => {
const moved = node.children.splice(index, 1)
node.children.splice(index + 1, 0, ...moved)
return node
})
}, [ctx, node, index])
const onDuplicate = useCallback(() => {
ctx.makeEdit(() => {
node.children.splice(index + 1, 0, node.children[index])
return node
})
}, [ctx, node, index])
const makeItemEdit: MakeEdit = useCallback((edit) => {
ctx.makeEdit(() => {
const newChild = edit(child?.range ?? item.range)
node.children[index] = {
type: 'item',
range: item.range,
value: newChild,
}
return node
})
}, [ctx, child, item, node])
const itemCtx = useMemo(() => {
return { ...ctx, makeEdit: makeItemEdit }
}, [ctx, makeItemEdit])
const onContextMenu = (evt: MouseEvent) => {
evt.preventDefault()
setActive()
}
return <div class="node" data-category={category}>
<div class="node-header" onContextMenu={onContextMenu}>
<Errors type={type} node={child} ctx={ctx} />
{canToggle && (isCollapsed
? <button class="toggle tooltipped tip-se" aria-label={`${locale('expand')}\n${locale('expand_all', 'Ctrl')}`} onClick={expand}>{Octicon.chevron_right}</button>
: <button class="toggle tooltipped tip-se" aria-label={`${locale('collapse')}\n${locale('collapse_all', 'Ctrl')}`} onClick={collapse}>{Octicon.chevron_down}</button>
)}
<button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={onRemove}>
{Octicon.trashcan}
</button>
{(canMoveUp || canMoveDown) && <div class="node-move">
<button class="move tooltipped tip-se" aria-label={locale('move_up')} disabled={!canMoveUp} onClick={onMoveUp}>
{Octicon.chevron_up}
</button>
<button class="move tooltipped tip-se" aria-label={locale('move_down')} disabled={!canMoveDown} onClick={onMoveDown}>
{Octicon.chevron_down}
</button>
</div>}
{active && <div class="node-menu">
<div class="menu-item">
<Btn icon="duplicate" onClick={onDuplicate}/>
<span>{locale('duplicate')}</span>
</div>
</div>}
<Key label="entry" />
{!isCollapsed && <Head type={type} node={child} ctx={itemCtx} />}
</div>
{!isCollapsed && (type.kind === 'struct'
? <div class="node-body-flat">
<StructBody type={type} node={child} ctx={itemCtx} />
</div>
: <Body type={type} node={child} ctx={itemCtx} />)}
</div>
}
function TupleHead({ type, optional, node, ctx }: Props<TupleType>) {
const { locale } = useLocale()
const isInline = isInlineTuple(type)
const onRemove = useCallback(() => {
ctx.makeEdit(() => {
return undefined
})
}, [ctx])
const onSetDefault = useCallback(() => {
ctx.makeEdit((range) => {
return getDefault(type, range, ctx)
})
}, [type, ctx])
return <>
{optional
? (JsonArrayNode.is(node)
? <button class="remove tooltipped tip-se" aria-label={locale('remove')} onClick={onRemove}>
{Octicon.trashcan}
</button>
: <button class="add tooltipped tip-se" aria-label={locale('expand')} onClick={onSetDefault}>
{Octicon.plus_circle}
</button>)
: (!JsonArrayNode.is(node)
? <button class="add tooltipped tip-se" aria-label={locale('reset')} onClick={onSetDefault}>
{Octicon.history}
</button>
: <></>
)}
{isInline && JsonArrayNode.is(node) && type.items.map((itemType, index) => {
const item = node?.children?.[index]
const child = item?.value
const childType = simplifyType(itemType, ctx)
return <TupleHeadItem child={child} childType={childType} index={index} type={type} node={node} ctx={ctx} />
})}
</>
}
interface TupleHeadItemProps extends Props {
child: JsonNode | undefined
childType: SimplifiedMcdocType
index: number
node: JsonArrayNode
}
function TupleHeadItem({ child, childType, index, node, ctx }: TupleHeadItemProps) {
const makeItemEdit = useCallback<MakeEdit>((edit) => {
ctx.makeEdit((range) => {
const newChild = edit(child?.range ?? node?.range ?? range)
if (newChild === undefined) {
return node
}
node.children[index] = {
type: 'item',
range: newChild.range,
value: newChild,
}
return node
})
}, [index, node, ctx])
const itemCtx = useMemo(() => {
return { ...ctx, makeEdit: makeItemEdit }
}, [ctx, makeItemEdit])
return <Head type={childType} node={child} ctx={itemCtx} />
}
function TupleBody({ type, node, ctx }: Props<TupleType>) {
if (!JsonArrayNode.is(node)) {
return <></>
}
return <>
{type.items.map((itemType, index) => {
const item = node?.children?.[index]
const child = item?.value
const childType = simplifyType(itemType, ctx)
return <TupleBodyItem child={child} childType={childType} index={index} type={type} node={node} ctx={ctx} />
})}
</>
}
interface TupleBodyItemProps extends Props {
child: JsonNode | undefined
childType: SimplifiedMcdocType
index: number
node: JsonArrayNode
}
function TupleBodyItem({ child, childType, index, node, ctx }: TupleBodyItemProps) {
const makeItemEdit = useCallback<MakeEdit>((edit) => {
ctx.makeEdit(() => {
const newChild = edit(child?.range ?? node.range)
if (newChild === undefined) {
return node
}
node.children[index] = {
type: 'item',
range: newChild.range,
value: newChild,
}
return node
})
}, [index, node, ctx])
const itemCtx = useMemo(() => {
return { ...ctx, makeEdit: makeItemEdit }
}, [ctx, makeItemEdit])
return <div key={index} class="node">
<div class="node-header">
<Errors type={childType} node={child} ctx={itemCtx} />
<Key label="entry" />
<Head type={childType} node={child} ctx={itemCtx} />
</div>
<Body type={childType} node={child} ctx={itemCtx} />
</div>
}
function LiteralHead({ type, optional, node, ctx }: Props<LiteralType>) {
return <UnionHead type={{ kind: 'union', members: [type] }} optional={optional} node={node} ctx={ctx} />
}
const ANY_TYPES: SimplifiedMcdocType[] = [
{ kind: 'boolean' },
{ kind: 'double' },
{ kind: 'string' },
{ kind: 'list', item: { kind: 'any' } },
{ kind: 'struct', fields: [ { kind: 'pair', key: { kind: 'string' }, type: { kind: 'any' } }] },
]
function AnyHead({ optional, node, ctx }: Props) {
const { locale } = useLocale()
const selectedType = selectAnyType(node)
const onSelect = useCallback((newValue: string) => {
ctx.makeEdit((range) => {
const newSelected = ANY_TYPES.find(t => t.kind === newValue)
if (!newSelected) {
return undefined
}
return getDefault(newSelected, range, ctx)
})
}, [ctx])
return <>
<select value={selectedType ? selectedType.kind : SPECIAL_UNSET} onInput={(e) => onSelect((e.target as HTMLSelectElement).value)}>
{(!selectedType || optional) && <option value={SPECIAL_UNSET}>{locale('unset')}</option>}
{ANY_TYPES.map((type) =>
<option value={type.kind}>{formatIdentifier(type.kind)}</option>
)}
</select>
{selectedType && <Head type={selectedType} node={node} ctx={ctx} />}
</>
}
function AnyBody({ optional, node, ctx }: Props) {
const selectedType = selectAnyType(node)
if (!selectedType) {
return <></>
}
return <Body type={selectedType} optional={optional} node={node} ctx={ctx} />
}
function selectAnyType(node: JsonNode | undefined) {
switch (node?.type) {
case 'json:boolean': return ANY_TYPES[0]
case 'json:number': return ANY_TYPES[1]
case 'json:string': return ANY_TYPES[2]
case 'json:array': return ANY_TYPES[3]
case 'json:object': return ANY_TYPES[4]
default: return undefined
}
}
interface KeyProps {
label: string | number | boolean
doc?: string
raw?: boolean
}
function Key({ label, doc, raw }: KeyProps) {
const [shown, setShown] = useFocus()
const cleanDoc = useMemo(() => {
if (!doc) {
return doc
}
return DOMPurify.sanitize(marked(doc), { FORBID_ATTR: ['style'] })
}, [doc])
return <label onClick={() => setShown(true)}>
<span class={doc ? `underline ${shown ? '' : 'decoration-dotted hover:decoration-solid'}` : ''}>{raw ? label.toString() : formatIdentifier(label.toString())}</span>
{cleanDoc && <div class={`node-doc ${shown ? '' : 'hidden'}`} onClick={e => e.stopPropagation()} dangerouslySetInnerHTML={{ __html: cleanDoc }}></div>}
</label>
}
interface ErrorsProps {
type: SimplifiedMcdocType
node: core.AstNode | undefined
ctx: McdocContext
}
function Errors({ type, node, ctx }: ErrorsProps) {
const errors = useMemo(() => {
if (node === undefined) {
return []
}
const errors = ctx.err.errors
// Get all errors inside the current node
.filter(e => core.Range.containsRange(node.range, e.range, true))
// Unless they are inside a child node
.filter(e => !node.children?.some(c => (c.type === 'item' || c.type === 'pair') && core.Range.containsRange(c.range, e.range, true)))
// Filter out "Missing key" errors
.filter(e => !(core.Range.length(e.range) === 1 && (type.kind === 'struct' || (type.kind === 'union' && JsonNode.is(node) && (selectUnionMember(type, node) ?? type.members[0]).kind === 'struct'))))
// Hide warnings if there are errors
return errors.find(e => e.severity === 3)
? errors.filter(e => e.severity === 3)
: errors
}, [type, node, ctx])
return <>
{errors.map(e => <ErrorIndicator error={e} />)}
</>
}
interface ErrorIndicatorProps {
error: core.LanguageError
}
function ErrorIndicator({ error }: ErrorIndicatorProps) {
const [active, setActive] = useFocus()
return <div class={`node-icon ${error.severity === 2 ? 'node-warning' : 'node-error'} ${active ? 'show' : ''}`} onClick={() => setActive()}>
{Octicon.issue_opened}
<span class="icon-popup">{error.message.replace(/ \(rule: [a-zA-Z]+\)$/, '')}</span>
</div>
}
function useToggles() {
const [toggleState, setToggleState] = useState(new Map<string, boolean>())
const [toggleAll, setToggleAll] = useState<boolean | undefined>(undefined)
const expand = useCallback((key: string) => (evt: MouseEvent) => {
if (evt.ctrlKey) {
setToggleState(new Map())
setToggleAll(true)
} else {
setToggleState(state => new Map(state.set(key, true)))
}
}, [])
const collapse = useCallback((key: string) => (evt: MouseEvent) => {
if (evt.ctrlKey) {
setToggleState(new Map())
setToggleAll(false)
} else {
setToggleState(state => new Map(state.set(key, false)))
}
}, [])
const isToggled = useCallback((key: string) => {
if (!(toggleState instanceof Map)) return false
return toggleState.get(key) ?? toggleAll
}, [toggleState, toggleAll])
return { expand, collapse, isToggled }
}