std/vyx.editor

3 exports, from std/vyx.editor.vyrn.

Editor support for the .vyx files std/vyx claims.

No program links this module, so a program that uses std/vyx pays nothing for it. A tool finds it beside std/vyx by its name.

Dependencies

The import graph shows the whole library.

Imports: vyx strings json strpred
Imported by: ui.editor

vyrnCompleteVyx fn

gen fn vyrnCompleteVyx(root: String, path: String, line: Int64, col: Int64) -> String

Completion items at 1-based line and col of the .vyx at path: a tag name offers the capitalized sibling components and, for a lowercase prefix, element names; an attribute name offers a component's props or an element's attributes and the directives; @ offers the DOM events. root is the directory the generator was pointed at and path the file, both spelled from the importer. Returns a JSON array of {label, kind, detail, from}, empty where the editor's forward map answers instead.

vyrnSourceVyx fn

gen fn vyrnSourceVyx(path: String) -> String

The Vyrn a tool reads in the component at path: its <script> at the file's own positions, then the view function its <template> compiles to.

vyrnDefinitionVyx fn

gen fn vyrnDefinitionVyx(root: String, path: String, line: Int64, col: Int64) -> String

The definition of the component tag at 1-based line and col of the .vyx at path, as an anchor in //@origin notation: the sibling <Name>.vyx at its first line, for a cursor on <Name or </Name in the template. root is the directory the generator was pointed at. Returns "" anywhere else, or when no such sibling exists.

Tests

6 test blocks in std/vyx.editor.vyrn. CI runs all of them.

Test names

a cursor right after a closed value is no attribute-name slot
an apostrophe inside an HTML comment opens no quote
a tag name, an event and the script classify apart
the script view keeps the script at its own lines and columns
a component view ends in the function its template compiles to
a component without a template provides nothing

Examples

No example program imports this module.