Tonto is an acronym with the words Textual and Ontology, because it is a written way of writing Ontology models. It was developed using the Langium tool, with Typescript, and creates a Visual Studio Code Extension with a Language server.
Tonto was designed as a friendly textual syntax for ontologies. It offers specialized support for constructs reflecting the UFO foundational ontology, which makes it possible to identify errors in the ontology that would otherwise pass unnoticed. The language was designed to allow transformation to a number of languages including UML (more specifically OntoUML), OWL (for gUFO-based ontologies), Alloy, Common Logic, and the TPTP syntax.
- Declaration of OntoUML constructs in a easy-to-read syntax
- Enumerations and custom datatypes
- High-order types for multi-level taxomies
As a textual syntax, the language can benefit from source control tools such as git, and ontologies can be viewed and edited without special tools. This VS Code extension is provided with support for syntax verification, syntax highlight, content assist and ontology visualization preview. The extension is integrated with the OntoUML server, to benefit from services designed for the language, such as transformation to OWL and generation of database schemas.
Here are some of the languages, frameworks, tools and libraries used in development of this application:
This project is divided in 3 packages, each of them responsible for a different part of Tonto.
- This package is where Tonto Grammar, the Language Server Protocol and the CLI is defined. All elements and commands are available in this package, and you can read more about it here:
- This package is responsible for the VSCode Extension
- This package is responsible for the
Tonto Package Manager (TPM). The TPM provides a way to manage ontologies as sepparate packages, simmilarly to how programming languages work.
The Tonto VS Code extension provides a rich editing experience with features like:
- Real-time syntax verification
- Syntax highlighting
- Autocompletion
- Code snippets
- Transformation to OntoUML (JSON) and gUFO-based OWL
- Visualization of diagrams
TPM enables managing dependencies between Tonto projects, facilitating code reuse and modular development.
This is the instructions on setting up your project locally. To get a local copy up and running follow these simple example steps:
This is all the tools you need installed to run the project and the versions that are preferred
- nodejs - v16.9.1 or higher
- npm - 7.21.1 or higher
- Yarn - 1.22.18 (not mandatory, but recommended)
This project defines tasks in order to be easier for vscode to build everything.
-
If you want to build all packages in watch mode just press
cmd+shift+bor the equivalent command to run the build task. -
After that, select at the debug tab the
Run Extensioncommand or pressF5to run the extension in a sepparate Extension Development Host. -
Create a new file with a file name suffix
.tontoand start using Tonto
With these commands you can generate a .vsix file to install the extension in your VS Code or to send privately to other people to test it, without publishing it to the Marketplace
# Run this to generate .vsix file
npm run package
# Or
vsce package --pre-release --baseContentUrl https://github.com/matheuslenke/Tonto
# Installing the extension in your vscode (requires the code extension in path)
code --install-extension tonto-x.x.x.vsixYou can Publish the tonto-cli to npm and the Visual Studio Code extension to the extension marketplace
In order to publish the extension, you need to configure your azure key and your npm key locally.
Then, inside the tonto or tonto-vscode folder, run the following command:
npm run publishDistributed under the MIT License. See LICENSE.txt for more information.
Matheus Lenke Coutinho - matheus.l.coutinho@edu.ufes.br - Linkedin - Github