58 releases
new 0.4.0 | Nov 4, 2024 |
---|---|
0.3.3 | Aug 30, 2024 |
0.3.2 | Jul 2, 2024 |
0.2.16 | Jan 19, 2024 |
0.1.26 | Jul 28, 2023 |
#45 in Text editors
682 downloads per month
Used in 5 crates
(4 directly)
510KB
18K
SLoC
Tree-Sitter grammar for SDML
A tree-sitter grammar for the Simple Domain Modeling Language (SDML). For more information on the language, see the documentation.
Example
module campaign base <https://advertising.amazon.com/api-model> is
import [dc skos xsd]
@skos:prefLabel = "Campaign sub-domain"@en
@skos:version = xsd:decimal(2)
datatype Name <- xsd:string is
@xsd:minLength = 5
@xsd:maxLength = 25
end
datatype Identifier <- opaque xsd:string is
@xsd:length = 20
end
property CampaignId -> Identifier is
@skos:prefLabel = [
"Campaign Identifier"@en
"Identified de campagne"@fr
]
@skos:description = "The globally unique identifier for a Campaign entity"@en
end
structure Tag is
key -> xsd:NMTOKEN
value -> {0..} rdfs:langStrings
end
entity Campaign is
identity ref CampaignId
name -> Name is
@skos:definition = "the name of the campaign"@en
end
tag -> {0..} Tag
target -> {1..} Target
end
entity Target
end
Bindings
The following bindings are built and released along with any version upgrade of the source version. The tree-sitter tool also generates bindings for C, Go, and Swift that are not built and released to any repository.
Node bindings are published to npmjs and can be installed using the npm command directly, or by making it a project dependency.
〉npm install -g tree_sitter_sdml
Python bindings are published to PyPI and can be installed using any
standard tool, such as pip
.
〉pip3 install tree_sitter_sdml
Rust bindings are published to crates.io and can be installed via cargo in the usual manner.
〉cargo install tree_sitter_sdml
License
This package is released under the Apache License, Version 2.0. See LICENSE file for details.
Changes
Version: 0.4.0
The primary aim of this release is to introduce a new definition type, a dimension. This may be seen as a violation of SDML's goal of being technology or implementation independent however it is a pragmatic decision based on usage experience. Modeling the data managed by a business in terms of entities solves many operational purposes but ignores a major purpose of this data -- reporting.
module example is
import [ sales stores xsd ]
dimension Region is
;; define an identifier for this dimension
identity region -> long
;; add members
name -> string
end
dimension Location is
;; tightly bind this dimension to the Sale entity
source sales:Sale
;; define a hierarchy by noting one or more parent dimensions
parent region -> Region
;; reuse members from the source entity
store from sales:Sale
city from sales:Sale
;; add additional members not on the source entity
state -> stores:State
country -> stores:Country
end
end
Detailed changes:
- Add
dimension_def
to the choice group indefinition
. - Add new
dimension_def
with name and optionaldimension_body
. - New
dimension_body
allows for either a source clause, or an identity clause. - New
dimension_body
allows a set ofparent_dimension
clauses before a set ofdimension_member
clauses. - A
parent_dimension
is a simplified name to identifier reference member with the keywordparent
. - A
dimension_member
is either an existingmember_def
,property_ref
or the newmember_from
clause that allows reuse of members from source entities.
Breaking Change: the grammar moves the source
keyword and identifier reference
from the event_def
rule to a new event_body
rule. Old code, note that the source
clause was required even for empty events.
module example is
entity Thing
event NewThing source Thing
end
New code, now an empty event looks more like other empty definitions, and adding
a source clause requires is
and end
.
module example is
entity Thing
event Empty
event NewThing is
source Thing
end
end
Additionally, this version of the grammar allows module's to rename imports,
both modules and members. This allows then client module to avoid always using
qualified names, and to use short, or more meaningful, names as appropriate.
``` sdml
module example is
import rentals_billing as billing
import billing:Invoice as Invoice
end
Version: 0.3.4
- Fix missing
byte
nodes in grammar for binary literals.
Version: 0.3.3
- Build: update version of dependent packages
cc
andtree-sitter
.
Version: 0.3.2
- Feature: change
module
's well-formedness rules to disallow the definitionsrdf_def
andtype_class_def
be added to a non-library module. - Feature: remove the rule
feature_reference
entirely, and it's reference in ruletype_reference
.
type_reference: $ => choice(
$.unknown_type,
$.identifier_reference,
$.builtin_simple_type,
$.mapping_type
),
Version: 0.3.1
- Fix: regular expression for characters inside a string.
- Added
examples/escaped_strings.sdm
file for basic testing. - Added
test/corpus/escaped_strings.sdm
file for more complete testing.
- Added
Version: 0.3.0
- Feature: simplified property definitions.
- Removed notion of role, a
property_def
is singular. - Removed "in" keyword,
property_ref
uses "ref". - Removed inverse names.
- Removed notion of role, a
property_def: $ => seq(
keyword('property'),
$.member_def
),
- Feature: unified single definition of
member
.- Changed member, is now either
property_ref
ormember_def
. - Changed
property_def
to simply bemember_def
. - Changed
entity_identity
to bemember
. - Expect to add warning for unbounded cardinality for entity identities.
- Changed member, is now either
entity_identity: $ => seq(
keyword('identity'),
$.member
),
member: $ => choice(
$.member_def,
$.property_ref,
),
member_def: $ => seq(
field('name', $.identifier),
$._type_expression_to,
optional(field('body', $.annotation_only_body))
),
property_ref: $ => seq(
keyword('ref'),
field('property', $.identifier_reference),
),
Version: 0.2.14-16
- Feature: simplified form of
rdf_def
.
Version: 0.2.13
- Feature: add
rdf_super_types
optional rule tordf_def
.
Version: 0.2.12
- Refactor: simplify the
rdf_thing_def
rule intordf_def
.
Version: 0.2.11
- Fix: rename field
uri
toversion_uri
on rulemodule_import
. - Refactor: clean-up test case names to match those in sdml-parse Rust crate.
Version: 0.2.10
- Feature: add version support to modules.
- Remove
base
keyword. - Add optional
version
keyword and string/IRI version information. - Add optional IRI after identifier for module imports.
- Remove
Version: 0.2.8/0.2.9
- Feature: better support for RDF generation.
- Add direct support for RDF structures and properties rather than using SDML
structures.
- see file
examples/rdf_schema.sdm
- see file
- Remove keyword
"base"
, add new version clause on module definitions.- see file
test/corpus/module_empty_with_version.sdm
- see file
- Add direct support for RDF structures and properties rather than using SDML
structures.
Version: 0.2.7
- Remove member group from grammar, can't find a use that isn't better done by moving members to a structure of their own.
Version: 0.2.6
- Fix: test case typos.
Version: 0.2.5
- Feature: Inline type variables in type classes.
Version: 0.2.4
- Fix: tidy grammar for type classes.
Version: 0.2.3
- Feature: expand rule
sequence_of_predicate_values
to matchsequence_of_values
with value constructor, mapping value, and identifier reference choices. - Feature: simplify rule
value_variant
to remove the assignment to an unsigned value. - Feature: change rule
feature_reference
to contain the identifier reference, update the rule_type_expression_to
to have a choice offeature_reference
ortype_reference
. - Fix: add field
byte
to rulebinary
to aid in parser and highlighting.
Along with minor changes in highlighting and examples.
Version: 0.2.2
- Feature: add rule
optional
for the operator "?" to allow for optional values. Also added to type reference rules. - Fix: minor updates to type classes:
- Add: name
parameters
to the rule referencetype_class_parameters
in ruletype_class_def
. - Rename: rule
type_variable_subtype
totype_variable_restriction
. - Remove: wildcard from top of rule
type_variable_restriction
. - Add: ability to have multiple types in a restriction separated by "+".
- Add: name
Version: 0.2.1
This release is primarily to implement type classes that allow a better description of the standard library for constraints. Adding this support identified some simplifications in functional terms and sequence builders.
module example is
class Typed(T) is
def has_type(v -> T) → Type is
@skos:definition = "Returns the SDML type of the passed value."@en
@skos:example = "~type_of(rentals:Customer) = sdml:Entity~"
end
end
end
- Feature: add type classes for managing the constraint language library.
- Add: rule
type_class_def
and list it as an alternative indefinition
. - Add: rule
method_def
and include as member oftype_class_def
. - Remove: choice
wildcard
from rulefunction_type_reference
, wildcards are only allowed on type class parameters.
- Add: rule
- Feature: simplify the rule
quantified_sentence
to only have a single quantified variable binding.- Alter: field
binding
inquantified_sentence
to remove the repeat. - Alter: field
body
from_quantified_body
toconstraint_sentence
. - Rename: rule
quantifier_bound_names
toquantified_variable
to denote singular. - Alter: field
source
inquantified_variable
to use existingterm
. - Remove: rules
type_iterator
andsequence_iterator
.
- Alter: field
- Feature: simplify the structure of sequence builder to use
quantified_sentence
as body.- Alter: field
body
in rulesequence_builder
from_variable_binding
tosequence_builder_body
. - Remove: rule
_variable_binding
. - Add: rule
sequence_builder_body
which is simply a reference to rulequantified_sentence
.
- Alter: field
- Feature: add rule
actual_aruments
for use in rulesatomic_sentence
andfunctional_term
. - Refactor: rename boolean constants.
- Rename:
_boolean_true
toboolean_truth
. - Rename:
_boolean_false
toboolean_falsity
.
- Rename:
Version: 0.2.0
This is a significant refactor intended to simplify the grammar, and reduce the number of constructs used where the differentiation is not as significant as it looked previously.
- Refactor: simplify model overall, especially members and features.
- Refactor: combine byvalue and byreference member types.
- Remove: rules
member_by_value
androle_by_value
. - Rename: rule
member_by_reference
tomember
androle_by_reference
tomember_role
. - Remove: keyword the
ref
from rulesmember
andmember_role
. - Rename: rule
identity_member
toentity_identity
.
- Remove: rules
- Refactor: combine structured type groups.
- Rename: rule
structure_body
tostructured_body
. - Rename: rule
structure_group
tomember_group
. - Move: common parts of structure and entity bodies into common
_structured_body_inner
rule.
- Rename: rule
- Refactor: move feature from a definition to a member modifier.
- Remove: rule
feature_set_def
, and updatedefinition
accordingly. - Add: optional keyword
features
into the rule_type_expression_to
.
- Remove: rule
- Refactor: combine byvalue and byreference member types.
- Feature: add new keyword
opaque
to datatype definition. - Style: Use
:=
throughout for assignment /by definition/.- Add: silent rule
_by_definition
. - Alter: rules
value_variant
,function_def
, andconstant_def
to use_by_definition
.
- Add: silent rule
- Style: rename rule
_property_member
to_property_reference
.
Version: 0.1.42
- Feature: simplified
features
definition to be or/xor only.- Replace: separate bodies with
UnionBody
. - Add: cardinality now used to determine or/xor.
- Replace: separate bodies with
FeatureSetDef
::= "features" Identifier Cardinality? UnionBody?
Version: 0.1.41
-! Feature: add support for features from Product Line Engineering.
- Add new definition rule
feature_set_def
to ruledefinition
. - Add and, or, xor bodies to
feature_set_def
. - Add basic documentation to book.
- Feature: updates to builtin simple types.
- Add the new type
unsigned
. - Add the new type
binary
. - Rename type
iri_reference
toiri
.
- Add the new type
Version: 0.1.40
- Feature: add the Unicode character
↦
to the rule_has_type
which works better for some typesetting. - Feature: add rule for
inequation
alongsideequation
.- Add new rule
inequation
and make it a choice withinsimple_sentence
. - Add new rules for inequality relations;
not_equal
,less_than
,less_than_or_equal
,greater_than
, andgreater_than_or_equal
.
- Add new rule
- Refactor: restructure rule
boolean_sentence
into a choice ofunary_boolean_sentence
andbinary_boolean_sentence
.- Add rule
unary_boolean_sentence
for negation only. - Add rule
binary_boolean_sentence
for logical connectives. - Add rules for each logical connective keyword/operator symbols.
- Add rule
- Refactor: rename field
variable_binding
to ``bindingin rule
quantieid_sentence`. - Refactor: use the same rule for empty set in value sequences.
- Refactor: rename rule
_function_type_expression_to
to_function_type
. - Refactor: add rules
_has_type
and_type_restriction
and allow both ASCII and Unicode arrows.- Add rule
_has_type
for values*>
and→
. - Add rule
_type_restriction
for values<*
and←
.
- Add rule
- Fix: rules for new shared bindings had confusing names.
- Add rule
quantified_variable_binding
. - Rename rule
quantifier_binding
toquantifier_bound_names
.
- Add rule
- Docs: add appendix with details of Unicode usage.
Version: 0.1.39
- Feature: allow multiple bindings at the head of quantified sentences.
- Feature: made progress on local scopes in highlighting.
- Rename rule
_constant_def
toconstant_def
. - To*do: currently references are not picking up their definition formatting.
- Rename rule
- Refactor: rename rule
name_path
tofunction_composition
. - Refactor: combine components of the two rules
quantified_sentence
andsequence_builder
.- Add new shared rule
quantifier_binding
(along with_bound_name_set
) now used in both sentence and builder. - Add the ability to have more than one name in a binding.
- Add the ability for sequence builders to have more than one quantified binding.
- Change the field
expression
into a field namedbody
of typeconstraint_sentence
. - Remove rules
expression
andconjunctive_expression
.
- Add new shared rule
- Style: change the order of choices in rule
predicate_value
to matchvalue
and corresponding sequences.
Version: 0.1.38
- Feature: Update naming for iterators to make them consistent.
- Rename rule
iterator_target
toiterator_source
. - Rename field
from
intype_iterator
tosource
. - Rename field
from
insequence_iterator
tosource
.
- Rename rule
Version: 0.1.37
- Feature: update rule
function_cardinality_expression
to allow sequence constraints.- Rename rule
any_type
towildcard
. - Remove rule
any_cardinality
and replace withwildcard
.
- Rename rule
- Feature: rename lists to sequences.
- Rename rule
list_of_predicate_values
tosequence_of_predicate_values
. - Rename rule
list_of_values
tosequence_of_values
.
- Rename rule
- Feature: make rule
property_role
private as_property_role
. - Feature: allow sequence constraints on sequence values.
- Add rule
_sequence_value_constraints
. - Add optional
_sequence_value_constraints
to rulesequence_of_predicate_values
. - Add optional
_sequence_value_constraints
to rulesequence_of_values
.
- Add rule
Version: 0.1.36
- Feature: alter the rule
sequence_comprehension
to be more flexible.- Rename rule
sequence_comprehension
tosequence_builder
. - Rename rule
returned_value
tovariables
and re-write as a choice of: - Add rule
tuple_variable
to return distinct variables. - Add rule
sequence_variable
to return distinct variables as a sequence. - Add rule
mapping_variable
to return two variables as a mapping.
- Rename rule
Version: 0.1.35
- Feature: alter the rule
_property_member
to allow property names to beidentifier_reference
.- New interpretation, field
name
in a member will be the name of a role. - Renamed keyword
in
, notas
. - Renamed field
role
toproperty
and made it's typeidentifier_reference
.
- New interpretation, field
Version: 0.1.34
- Feature: update property definitions to look more like members.
- Update rule
property_role
to be a choice of three new rules. - Add rule
identity_role
which is a subset ofidentity_member
. - Add rule
role_by_value
which is a subset ofmember_by_value
. - Add rule
role_by_reference
which is a subset ofmember_by_reference
.
- Update rule
Version: 0.1.33
- Feature: renamed quantifier binding targets to be more consistent.
- Rename rule
binding_target
toiterator_target
. - Rename rule
binding_type_reference
totype_iterator
and field namefrom_type
tofrom
. - Rename rule
binding_seq_iterator
tosequence_iterator
and field namefrom_sequence
tofrom
.
- Rename rule
- Feature: simplified the rule
environment_definition
and made naming more consistent.- Remove optional
signature
field - Remove assignment operators
- Rename field name
rhs
tobody
and change to a choice offunction_def
or_value_def
. - Add rule
function_def
to hold the signature and operators removed from the environment definition. - Rename rule
fn_parameter
tofunction_parameter
. - Rename rule
_fn_type
to_function_type_expression_to
. - Add rules
function_cardinality_expression
andany_cardinality
to capture cardinality or wildcard. - Add rule
function_type_reference
to allow wildcards.
- Remove optional
- Feature: update queries
highlights
,locals
, andtags
for all changes above. - Docs: update BNF syntax and diagrams for all changes above.
Version: 0.1.32
- Feature: update environment definition sequence types to use the same syntax as member type and cardinality.
Version: 0.1.31
- Feature: update highlighting queries for constraints with support for locals.
- Feature: add a
locals.scm
file with scopes for formal constraints. - Feature: add
∅
(empty set) as a synonym for[]
in constraints. - Fix: update the mapping value test case to use domain/range field names.
Version: 0.1.30
- Feature (minor): added field names for the domain and range of mapping types and values.
Version: 0.1.29
- Fix: an apparent regression, the value for a constructor changed from
simple_value
tovalue
. This changes it back.
Version: 0.1.28
- Feature: add a mapping type and corresponding value syntax.
Version: 0.1.27
- Feature: add ordering and uniqueness constraints into the cardinality expression. Used to constrain the sequence type of a member.
Version: 0.1.26
- Feature: applied same change as 0.1.25 but for property roles as well.
Version: 0.1.25
- Feature: changed grammar for reference members:
- The production
source_cardinality
has been removed. - The production
member_inverse_name
has been added.
- The production
Version: 0.1.24
- Feature: constraint grammar changes
- Add a language-tag to informal constraints.
- Add a wildcard type for the constraint language.
Version: 0.1.23
- Feature: add highlighting test for constraints, had to tweak a few things.
Version: 0.1.22**
- Feature: clarify rules and associated meaning.
- Rename the grammar rule
type_definition
todefinition
to address the fact that property definitions aren't types. - Rename the grammar rule
enum_variant
tovalue_variant
to align withtype_variant
on unions.
- Rename the grammar rule
Version: 0.1.21
- Feature: add support for sequence builder support(set builder) syntax.
- Fix: highlighting/indent/fold updated for constraints.
- Style: a number of cosmetic changes to formal constraints.
Version: 0.1.19/0.1.20
- Fix: minor change to add a field name to the '..' range operator.
Version: 0.1.18
- Feature: added a constraint assertion construct. This allows for specific
constraints to be documented for any model element.
- The grammar rule
annotation
has been renamedannotation_property
- The grammar rule
constraint
has been added. - A new grammar rule named
annotation
is defined as a choice ofannotation_property
orconstraint
. - This allows the use of the old rule to be subsumed by the new definition.
- The grammar rule
- Feature: constraints may now be written in informal unstructured fashion or an
embedded formalism.
- The informal representation is simply a string.
- The formal representation is a syntax that maps to a subset of ISO/IEC 24707:2018 Common Logic.
- Docs: more documentation added on the RDF mapping and the domain modeling process.
module example is
import tag
structure Thing is
inner -> {0..} InnerThing is
;; informal
assert same_tags = "All inner tags contain a tag value \"This\"."
;; formal
assert same_tags_formal is
forall self ( not_empty(self) and contains(self.tags "This") )
end
end
end
structure InnerThing is
tags -> {0..} tag:Tag
end
end
Version: 0.1.17
- Fixed: highlighting for properties.
Version: 0.1.16
- Feature: Adjusted property grammar.
- Docs: Started on property documentation.
module ddict is
import account
property accountId is
@skos:prefLabel = "accountId"@en
@skos:altLabel = "account_id"@en
identifier -> {1} account:AccountId is
@skos:definition = "Used as an identifier for account-scoped things"@en
end
reference ref {1} -> {1} account:AccountId
end
structure Account is
accountId as identifier
name -> string
end
end
Version: 0.1.15
- Feature: Added new structure to the grammar to allow data-dictionary style reusable property definitions.
module ddict is
import account
property accountId -> account:AccountId is
@skos:prefLabel = "accountId"@en
@skos:altLabel = "account_id"@en
identifier is
@skos:definition = "Used as ..."@en
end
default = {1..1}
end
structure Account is
accountId as default
name -> string
end
end
Version: 0.1.14
- Added new rule named
builtin_simple_type
(choice ofstring
,double
,decimal
,integer
,boolean
, andiri
):- replaced
identifier_reference
with new ruledata_type_base
fordata_type_def
, - added to the
type_reference
choice used for the membertarget
field.
- replaced
Allows both:
module example is
datatype mystring <- string
structure Person is
name -> string
age -> integer
end
end
Where the keywords string
and integer
will be expanded into the qualified
identifiers sdml:string
and sdml:integer
respectively.
Version: 0.1.13
- Added explicit
base
grammar for module rather than usingxml:base
as an attribute. - Expanded grammar for
Identifier
to allow decimal digits in any position after the first. - Clarified the grammar for
TypeVariant
.
Introduces:
module example base <https://example.org/v/example> is
end
Which replaces the annotation form:
module example is
import xml
@xml:base = <https://example.org/v/example>
end
Version: 0.1.12
- Fixed highlight issue for annotations with
IdentifierReference
values - Added field for
TypeVariant
name
Version: 0.1.11
- Added a rename to optional value to
TypeVariant
- Fixed
annotation
andlanguage_tag
grammar rule conflict
Introduces:
module example is
union Example is
Variant1
Variant1 as Alternative
end
end
This allows the use of the same type as a variant more than once if the new
identifier is unique within the same union
.
Version: 0.1.10
- Cleaned up queries.
Version: 0.1.9
- Simplified the disjoint
UnionDef
type.
Version: 0.1.8
- Added a disjoint
UnionDef
type.
Version: 0.1.7
- Made field name
sourceCardinality
intosource_cardinality
. - Made field name
targetCardinality
intotarget_cardinality
. - Added versioning annotations
Version: 0.1.6
- Made
_simple_value
intosimple_value
named rule. - Made
_type_reference
intotype_reference
named rule.
Additional Links
Dependencies
~2.7–4MB
~75K SLoC