ontype

Ontype is a simple schema language similar to TypeScript.

Below is a valid Ontype schema, highlighted using TypeScript syntax:

type User {
    id: char
    password: string @hidden
    passwordSalt: string @hidden
}

type Todo {
    id: char
    title: string(10)
    deadline?: datetime @nullable
    authorId: User[id]
    status: TodoStatus
}

enum TodoStatus {
    READY
    IN_PROGRESS
    DONE
}

• type User {} defines a User type.
• id: char declares that the id property is of type char.
• password: string @hidden defines a property with a decorator @hidden.
• deadline?: datetime @nullable declares an optional property deadline.
• authorId: User[id] indicates that authorId references the id property of User.
• enum TodoStatus defines an enum named TodoStatus.
• READY is a member of the enum.

Parser

This repository includes an Ontype parser, available as an npm package.

npm i ontype

import { parse } from "ontype";

const readStream = fs.createReadStream('./example.ontype', "utf-8");

const { errors, result } = await parse(readStream, {
  enableSemanticTokens: true,
  semanticTokens: [],
});

console.log(result.semanticTokens);
console.log(errors);

LSP

• vscode