Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/vladimiralexiev/shaclc-mode


https://github.com/vladimiralexiev/shaclc-mode

Last synced: 19 days ago
JSON representation

Awesome Lists containing this project

README 

        
# Editing SHACLC with shaclc-mode



- Source: https://github.com/VladimirAlexiev/shaclc-mode

- Author: Vladimir Alexiev, Ontotext Corp



## Intro



Many people think that semantic models should be described with RDF Shapes, not just ontologies.

[SHACL](https://www.w3.org/TR/shacl/) is the W3C standard for specifying shapes, and [SHEX](http://shex.io/) is a popular competitive standard.



SHACL is very verbose because it expresses shapes as RDF triples.

[SHACL Compact Syntax](https://w3c.github.io/shacl/shacl-compact-syntax/) (SHACLC) is a dedicated syntax modeled after SHEX that is a lot more compact and nicer to work with.



Just like there is [shexc-mode](https://github.com/ericprud/shexc-mode-for-emacs) for editing SHEX in Emacs,

this creates a `shaclc-mode` (in fact this mostly borrows from `shexc-mode`).



## Why SHACLC?



The easiest way to understand the benefits of SHACLC compared to SHACL is by looking at some example shapes from the [euBusinessGraph semantic model](https://github.com/euBusinessGraph/eubg-data/tree/master/model):



- SHEX has a compact dedicated syntax (in addition to JSON and RDF representations): see [ebg-shapes.shex](ebg-shapes.shex), 143 lines



![](ebg-shex.png)



- SHACL is very verbose because all constructs are represented in triples: see [ebg-shapes.shacl](ebg-shapes.shacl), 504 lines (the shot below shows only 6 properties of Company)



![](ebg-shacl.png)



- SHACLC adds a compact dedicated syntax, so SHACLC schemas are easy to understand: see [ebg-shapes.shaclc](ebg-shapes.shaclc), 183 lines (35 lines are prefixes)



![](ebg-shaclc.png)



## Features



- Syntax highlighting



![](shaclc-schema.png)



- Syntax checking using `flycheck` and `shaclconvert` (see [TQ SHACL](#tq-shacl) below)



![](shaclc-flyCheck-validation.png)



- Comment/uncomment block with `M-;`

- Index of shape definitions (`imenu`) and panel on the right (`imenu-list`)



![](shaclc-imenuList.png)



## Installing



- Optionally, byte compile `shaclc-mode.el`

- Add this to `.emacs`



```elisp

(add-to-list 'load-path "{path-to-shaclc}")

(autoload 'shaclc-mode "shaclc-mode" "Major mode for SHACLC (SCHACL Compact Syntax)" t)

(add-to-list 'auto-mode-alist '("\\.\\(shaclc\\|shc\\)$" . shaclc-mode))

```



## TQ SHACL



The TQ SHACL API implements SHACLC since June 2000.



Ontotext's [shaclconvert](https://gitlab.ontotext.com/yasen.marinov/shaclconvert) tool is a simple CLI on top of the TQ API.

It is not open sourced yet but we hope to merge it to TQ SHACL in the future.



Bugs and issues: https://github.com/TopQuadrant/shacl/search?q=shaclc&type=issues



## Jena SHACL



Starting June 2020, Jena now includes SHACL and SHACLC processing in `riot` and a new command `shacl`:

- Documentation: https://jena.apache.org/documentation/shacl/

- Source: https://github.com/apache/jena/tree/main/jena-shacl

- Tests: https://github.com/apache/jena/tree/main/jena-shacl/src/test

  - SHACLC tests: https://github.com/apache/jena/tree/main/jena-shacl/src/test/files/shaclc-valid



Bugs and issues: https://issues.apache.org/jira/issues/?jql=text~shaclc



## Todo



- Make an ELPA package

- Use [SHACLC.g4](https://github.com/w3c/shacl/blob/master/shacl-compact-syntax/SHACLC.g4) grammar to make highlighting better

- Merge `shaclconvert` to [TopQuadrant SHACL](https://github.com/TopQuadrant/shacl/)

- Fix bugs in `shaclconvert` reading and writing

- Make SHACLC (see [TopQuadrant/shacl#98](https://github.com/TopQuadrant/shacl/issues/98)) nearly lossless so it can be round-tripped with SHACL



Help wanted!