Mentor RDF for Visual Studio Code

This extension provides powerful editing support for RDF ontologies, thesauri and knowledge graph projects in Visual Studio Code.

Features

Tip: Try it with GitHub Copilot for the best code editing experience.

This extension provides the following features:

Workspace Tree

• Navigate all ontology and SPARQL files in the project
• Easily identify problems in all ontologies in the workspace

Workspace Index

• Creates an index of all ontologies in the workspace
• Find all references to a subject in the workspace
• Provides code lenses that show reference statistics for a subject
• Jump to definitions of subjects in other files

Definitions Tree

• Showing the definitions in RDFS or OWL ontologies
  • Ontologies
  • Classes
  • Properties
  • Individuals
• Showing the definitions of SHACL shapes
  • Quickly jump to shapes associated with a class or property
  • Node Shapes
  • Property Shapes with property path labels
  • Rules
  • Validators
• Showing the definitions in SKOS thesauri
  • Concept Schemes
  • Concepts
  • Collections
• Grouping of definitions by concept scheme, ontology or rdfs:isDefinedBy
• Quickly jump to definitions
• RDFS and structural OWL reasoning
• Find all references in the current document
• Open URIs in web browser
• Show definitions in multiple languages ^NEW
  • Select language tag of the displayed labels and definitions
  • Highlight the terms missing in the selected language (optional)

Supports N3, Turtle, Trig and SPARQL

• Syntax highlighting
• Syntax validation
• Checking conformance of literal values to XSD specifications
• Checking if namespace IRIs end with separator (/,#, :, _, -)
• Highlight unused namespace prefixes
• Highlight duplicate namespace prefix definitions

Refactoring

• Rename prefixes
• Rename resource labels in prefixed names and URIs
• Refactor IRI references into prefixes names
• Auto implement undefined prefixes
• Sort prefix definitions
• Remove unused prefix definitions

Online Collaboration

• Runnable in the browser on vscode.dev
• Edit GitHub repositories online

News

Version 0.2.6: Minor bugfixes

Fixed two minor issues:

1. Auto declaration of prefixes is disabled when manually declaring prefixes in the file header. The auto-implement kicked-in as soon as the ':' was typed and began to resort the prefix definitions without moving the cursor. The new default behavior now is to not run the auto-implement command when manually declaring prefixes.

2. PNAME_NS tokens are now considered for reference counting if they are not part of a prefix declaration. In previous versions of Mentor these tokens were not counted as usages of the namespace and thus lead to invalid markings of namespaces as unused when the namespace prefix was used without a local part.

Version 0.2.5: Language Support in Definition Tree

This release introduces support for selecting the language tags to display in the definition tree. This ensures a consistent view of definitions across the definition tree and editor tooltips, which typically show labels and definitions in the currently selected language. Additionally, items in the definition tree without language-tagged labels can now be highlighted.

Version 0.2.3: Fixed labels in definition tree

Fixed a bug where the definition tree would ignore the settings for resource labels and initially only show the URI local part instead of annotated labels.

Version 0.2.2: Improved prefix management

This release adds editor functions to automatically define / implement missing prefix definitions in the document. The namespace IRIs for a prefix are looked up in other documents in the workspace first and if not found, are retreived from a local copy of prefix.cc. The editor also now highights unused prefix definitions and marks them as inactive similar to the behavior of unused imports in other programming languages. Duplicate prefix defintions are marked as a warning. Also some new refactoring methods for prefixes were added:

• Sort prefix definitions in the document header
• Remove unused prefix definitions
• Turn IRI references into prefixed names

There are new settings to adjust the prefix implementation behavior. Prefixes can be implemented by maintaing a sorted list of prefixes at the top of the document (default), or by appending the new prixes after the last prefix defintion. The auto-implementation of prefixes can also be turned off entirely.

Finally this release includes a fix, that addresses a bug caused by the Millan parser that sometimes includes trailing whitespaces in tokens where it should not. Now the find reference command has a more reliable highlighting of the prefix name or IRI.

Version 0.2.1: Support for SHACL shapes in Definitions Tree and vscode.dev

This release supports browsing SHACL shapes that are defined in ontologies. You can quickly jump to shape definitions that are associated with classes or properties from the definitions tree. Also supports SHACL datatype definitions for properties.

Greatly improved workspace indexing speed for reference resolution with added options for skipping files above a configurable size limit.

Mentor can be run as a pure web extension and supports collaboration in online portals such as vscode.dev.

Version 0.1.8: Fixed context menus not working in Definitions Tree

The context menus for resources in the definitions tree are now working again.

Version 0.1.7: SKOS + Improved Definitions Tree

This release includes support for SKOS thesauri resources in the definitions tree: Concept Schemes, Concepts and Collections. To harmonize the user experience of ontologies and thesauri, the definitions tree can now group classes, properties and invidiuals by definition source.

This means that ontology headers are now expandable nodes that show all classes, properties and individuals defined in its namespace. It also considers the rdfs:isDefinedBy property to create groups or to explicitly associate a definition with one or more ontologies that have a different namespace. This setting can be changed temporarily in the definitions tree context menu or permanently in the extension settings.

The next release will include support for SHACL shapes.

Version 0.1.6: Bugfixes

A minor bugfix release. Next release will feature an improved definitions tree view and SKOS support.

• Fixed syntax support for TriG files
• Fixed wrong reference counts in code lenses after opening a file in a Git diff view

Version 0.1.5: Prefix Definition Support

Added inline completion support for prefix definitions and quick fixes for implementing missing prefix definitions. The prefix URIs are resolved from the indexed files in the workspace as well as from a local database downloaded from prefix.cc. The local database can be updated manually using a built-in command.

Version 0.1.3: Global Workspace Index

Added support for indexing all ontology files in the workspace. This enables finding references, retrieving descriptions and going to defintions of subjects accross the entire workspace. A newly added code lens shows the number of references of a subject in the workspace. In addition, the workspace tree gained a new command for opening all the ontologies in the workspace to identify problems and show them in the problems tab.

Installation

You can install the Mentor extension directly from the Visual Studio Code marketplace. Follow these steps:

1. Open Visual Studio Code.
2. Click on the Extensions view icon on the Sidebar (or press Ctrl+Shift+X).
3. In the Extensions view, enter Mentor in the search form and press Enter.
4. Locate the Mentor extension in the search results and click on the install button.

Alternatively, if you have the .vsix file of the extension, you can install it manually:

1. Open Visual Studio Code.
2. Click on the Extensions view icon on the Sidebar.
3. Click on the ... at the top of the Extensions view, select Install from VSIX....
4. Locate the .vsix file and click Open.

After installation, you may need to reload Visual Studio Code to activate the extension.

Contributing

We appreciate contributions in all forms! By contributing to Mentor, you'll help make it a better tool for the RDF and knowledge graph community. Contributions can take many shapes, including:

• Bug reports: If you encounter an issue, please report it to us so we can investigate and fix it. Your feedback helps us understand what works well and what we can improve.

• Reviews and feedback: Share your experience with Mentor by leaving a review on the Visual Studio Marketplace.

• Code contributions: Help us improve the extension by submitting new features, bug fixes, or refactoring existing code.

Building

To get started, fork this repository on GitHub and then clone the fork to your local computer. Once cloned, add an upstream remote pointing to the primary toolkit repo.

git clone https://github.com/faubulous/mentor-vscode.git
cd mentor-vscode

Install the project dependencies.

npm install

Create a development build of the extension.

npm run build:watch

Debugging

To start debugging the 'Launch Extension' configuration, follow these steps:

1. Open Visual Studio Code.
2. Click on the Run view icon on the Sidebar (or press Ctrl+Shift+D).
3. At the top of the Run view, in the dropdown list of debug configurations, select 'Launch Extension'.
4. After the configuration is set, you can start debugging by clicking on the green 'Start Debugging' button (or press F5).

This will start a new instance of Visual Studio Code with the Mentor extension loaded. You can set breakpoints in your code to stop execution and inspect variables, call stack, and so on.

Packaging

npm install --global @vscode/vsce

npm run package:install

License

Distributed under the GPL Version 3 License. See LICENSE for more information.