docs

codemirror-json-schema

codemirror-json-schema

Table of contents

Bundled Codemirror Extensions

• jsonSchema

Codemirror Extensions

• jsonCompletion
• jsonSchemaHover
• jsonSchemaLinter

Utilities

• getJsonPointers
• jsonPointerForPosition
• parseJSONDocument
• parseJSONDocumentState

Classes

• JSONCompletion
• JSONHover
• JSONValidation

Functions

• getJSONSchema
• getJsonPointerAt
• handleRefresh
• resolveTokenName
• stateExtensions
• updateSchema

Interfaces

• JSONCompletionOptions
• JSONValidationOptions

Type Aliases

• CursorData
• FoundCursorData
• HoverOptions
• JSONPartialPointerData
• JSONPointerData
• JSONPointersMap

Variables

• schemaStateField

Bundled Codemirror Extensions

jsonSchema

▸ jsonSchema(schema?): Extension[]

Full featured cm6 extension for json, including @codemirror/lang-json

Parameters

Name	Type
schema?	JSONSchema7

Returns

Extension[]

Defined in

json/bundled.ts:15

Codemirror Extensions

jsonCompletion

▸ jsonCompletion(opts?): (ctx: CompletionContext) => never[] | CompletionResult

provides a JSON schema enabled autocomplete extension for codemirror

Parameters

Name	Type
opts	JSONCompletionOptions

Returns

fn

▸ (ctx): never[] | CompletionResult

Parameters

Name	Type
ctx	CompletionContext

Returns

never[] | CompletionResult

Defined in

features/completion.ts:1062

---

jsonSchemaHover

▸ jsonSchemaHover(options?): (view: EditorView, pos: number, side: Side) => Promise<null | Tooltip>

provides a JSON schema enabled tooltip extension for codemirror

Parameters

Name	Type
options?	HoverOptions

Returns

fn

▸ (view, pos, side): Promise<null | Tooltip>

Parameters

Name	Type
view	EditorView
pos	number
side	Side

Returns

Promise<null | Tooltip>

Defined in

features/hover.ts:46

---

jsonSchemaLinter

▸ jsonSchemaLinter(options?): (view: EditorView) => Diagnostic[]

Helper for simpler class instantiaton

Parameters

Name	Type
options?	JSONValidationOptions

Returns

fn

▸ (view): Diagnostic[]

Parameters

Name	Type
view	EditorView

Returns

Diagnostic[]

Defined in

features/validation.ts:46

Utilities

getJsonPointers

▸ getJsonPointers(state, mode): JSONPointersMap

retrieve a Map of all the json pointers in a document

Parameters

Name	Type
state	EditorState
mode	JSONMode

Returns

JSONPointersMap

Defined in

utils/json-pointers.ts:89

---

jsonPointerForPosition

▸ jsonPointerForPosition(state, pos, side?, mode): string

retrieve a JSON pointer for a given position in the editor

Parameters

Name	Type	Default value
state	EditorState	undefined
pos	number	undefined
side	Side	-1
mode	JSONMode	undefined

Returns

string

Defined in

utils/json-pointers.ts:72

---

parseJSONDocument

▸ parseJSONDocument(jsonString): Object

Mimics the behavior of json-source-map's parseJSONDocument function using codemirror EditorState

Parameters

Name	Type
jsonString	string

Returns

Object

Name	Type
data	any
pointers	JSONPointersMap

Defined in

parsers/json-parser.ts:29

---

parseJSONDocumentState

▸ parseJSONDocumentState(state): Object

Return parsed data and json pointers for a given codemirror EditorState

Parameters

Name	Type
state	EditorState

Returns

Object

Name	Type
data	any
pointers	JSONPointersMap

Defined in

parsers/json-parser.ts:11

Functions

getJSONSchema

▸ getJSONSchema(state): void | JSONSchema7

Parameters

Name	Type
state	EditorState

Returns

void | JSONSchema7

Defined in

features/state.ts:25

---

getJsonPointerAt

▸ getJsonPointerAt(docText, node, mode): string

Parameters

Name	Type
docText	Text
node	SyntaxNode
mode	JSONMode

Returns

string

Defined in

utils/json-pointers.ts:31

---

handleRefresh

▸ handleRefresh(vu): boolean

Parameters

Name	Type
vu	ViewUpdate

Returns

boolean

Defined in

features/validation.ts:36

---

resolveTokenName

▸ resolveTokenName(nodeName, mode): string

Parameters

Name	Type
nodeName	string
mode	JSONMode

Returns

string

Defined in

utils/json-pointers.ts:18

---

stateExtensions

▸ stateExtensions(schema?): Extension[]

Parameters

Name	Type
schema?	JSONSchema7

Returns

Extension[]

Defined in

features/state.ts:29

---

updateSchema

▸ updateSchema(view, schema?): void

Parameters

Name	Type
view	EditorView
schema?	JSONSchema7

Returns

void

Defined in

features/state.ts:19

Type Aliases

CursorData

Ƭ CursorData: Object

Type declaration

Name	Type
pointer	string
schema?	JsonSchema

Defined in

features/hover.ts:19

---

FoundCursorData

Ƭ FoundCursorData: Required<CursorData>

Defined in

features/hover.ts:21

---

HoverOptions

Ƭ HoverOptions: Object

Type declaration

Name	Type
formatHover?	(data: HoverTexts) => HTMLElement
getHoverTexts?	(data: FoundCursorData) => HoverTexts
mode?	JSONMode
parser?	(text: string) => any

Defined in

features/hover.ts:25

---

JSONPartialPointerData

Ƭ JSONPartialPointerData: Object

Type declaration

Name	Type
keyFrom	number
keyTo	number

Defined in

types.ts:6

---

JSONPointerData

Ƭ JSONPointerData: Object

Type declaration

Name	Type
keyFrom	number
keyTo	number
valueFrom	number
valueTo	number

Defined in

types.ts:11

---

JSONPointersMap

Ƭ JSONPointersMap: Map<string, JSONPointerData | JSONPartialPointerData>

Defined in

types.ts:20

Variables

schemaStateField

• Const schemaStateField: StateField<void | JSONSchema7>

Defined in

features/state.ts:6