SDML Mode for Emacs

This package provides an Emacs tree-sitter based major mode for SDML - the Simple Domain Modeling Language.

Installing

Install is easiest from MELPA, here's how with use-package.

(use-package sdml-ts-mode)
;; or
(use-package sdml-ts-mode
  :vc (:url "https://github.com/sdm-lang/emacs-sdml-ts-mode"))

Or, interactively; M-x package-install RET sdml-ts-mode RET

Usage

Once installed the major mode should be used for any file ending in .sdm or .sdml with highlighting and indentation support.

Ctags Support

Using Universal Ctags and the sdml-ctags package provides an identifier tagging solution for SDML source. The sdml-ts-mode-ctags-mode will determine if company-mode installed and add SDML as a supported tag backend. Additionally, this minor mode provides a command to re-create the project's tag file. The image below shows company used as the completion UI for type completion when editing.

Command sdml-ts-mode-ctags-generate has the default binding C-c C-s T. It uses the variables sdml-ts-mode-ctags-command and sdml-ts-mode-ctags-output-file-name to generate the tag file.

Tool Commands

A number of the tools provided by the SDML command-line tool are exposed as Emacs commands. The following image shows two tools in use, the module dependency tree and the validation tool.

Dependency Tree

• Command sdml-ts-mode-current-buffer-dependency-tree has the default binding C-c C-s t.
• The command will prompt for the maximum depth of the tree where 0 means unbounded. This is a command prefix and can therefore be specified with the usual C-u binding.
• The resulting tree view can be refreshed using the common binding of g and quit with q.

Dependency Graph

If running under a window-sytem it is also possible to display the current buffer's dependencies as a directed graph. The tool will generate an SVG and display in a read-only window.

• Command sdml-ts-mode-current-buffer-dependency-graph has the default binding C-c C-s M-t.

Full Validation

• Command sdml-ts-mode-validate-current-buffer has the default binding C-c C-s v.
• Command sdml-ts-mode-validate-file has the default binding C-c C-s M-v.
• The variable sdml-ts-mode-validation-level denotes the level of messages produced by the validator, with a default of warnings.
• The output uses the standard compilation-mode with all the common bindings are available.

Abbreviations and Skeletons

TBD

Prettify Symbol

TBD

Default Key Bindings

TBD

Add-Ons

TBD

License(s)

The contents of this repository are made available under the following licenses:

Apache-2.0

Copyright 2025 Simon Johnston <[email protected]>

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

See the enclosed file LICENSE-Apache.

MIT

Copyright 2025 Simon Johnston <[email protected]>

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the “Software”), to deal
in the Software without restriction, including without limitation the rights to
use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of
the Software, and to permit persons to whom the Software is furnished to do so,
subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED,
INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A
PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

See the enclosed file LICENSE-MIT.

Contributions

Unless you explicitly state otherwise, any contribution intentionally submitted for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any additional terms or conditions.

Changes

Version 0.1.0

Initial release.