https://github.com/sdm-lang/emacs-ob-sdml
Org-Babel integration for SDML source files.
https://github.com/sdm-lang/emacs-ob-sdml
emacs org-mode sdml
Last synced: 4 months ago
JSON representation
Org-Babel integration for SDML source files.
- Host: GitHub
- URL: https://github.com/sdm-lang/emacs-ob-sdml
- Owner: sdm-lang
- License: apache-2.0
- Created: 2024-06-24T22:32:08.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-08-21T18:48:31.000Z (almost 2 years ago)
- Last Synced: 2025-01-22T06:12:26.160Z (over 1 year ago)
- Topics: emacs, org-mode, sdml
- Language: Emacs Lisp
- Homepage:
- Size: 29.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# SDML Mode for Emacs
This package provides support for SDML (the [Simple Domain Modeling Language](https://github.com/johnstonskj/tree-sitter-sdml)) in
[Org-Babel](https://orgmode.org/worg/org-contrib/babel/) blocks.
## Installing
Install is easiest from MELPA, here's how with `use-package`. Note the hook clause
to ensure this minor mode is always enabled for SDML source files.
```elisp
(use-package ob-sdml
:after (ob sdml-mode)
:init (ob-sdml-setup))
```
Or, interactively; `M-x package-install RET sdml-ispell RET` and then
run `M-x ob-sdml-setup RET` to add SDML to the Babel list of languages.
You will also need to install the SDML command-line tool to execute commands
against source blocks.
```sh
〉cargo install sdml-cli
```
## Usage
For example, the following source block calls the CLI to draw a concept diagram
for the enclosed module.
```org
#+NAME: lst:rentals-example
#+CAPTION: Rentals Concepts
#+BEGIN_SRC sdml :cmdline draw --diagram concepts :file ./rentals-concepts.svg :exports both
module rentals is
entity Vehicle
entity Location
entity Customer
entity Booking
end
#+END_SRC
```
The results block then references the resulting image.
```
#+NAME: fig:rentals-example-concepts
#+CAPTION: Rentals Concepts
#+RESULTS: lst:rentals-example
[[file:./rentals-concepts.svg]]
```
To simply show the source in a document the following does not require the
command-line tool at all.
```org
#+BEGIN_SRC sdml :exports code :eval never
module rentals is
;; ...
end
#+END_SRC
```
But, what if we want to produce more than one diagram from the same source? By
using the built-in /[noweb](https://orgmode.org/manual/Noweb-Reference-Syntax.html)/ syntax we can create a new source block, but
reference the original content. This source block has different command-line
parameters and has it's own results block as well.
```org
#+NAME: fig:rentals-example-erd
#+BEGIN_SRC sdml :cmdline draw --diagram concepts :file ./rentals-erd.svg :exports results :noweb yes
<>
#+END_SRC
```
## Contributing
This package includes an [Eldev](https://github.com/emacs-eldev/eldev) file and the following MUST be run before
creating any PR.
- `eldev lint`
- `eldev doctor`
- `eldev package --load-before-compiling --stop-on-failure --warnings-as-errors`
- `eldev test`
- `eldev test --undercover auto,coveralls,merge,dontsent -U simplecov.json`
- `eldev release -nU 9.9.9`
The script [eldev-check.sh](https://gist.github.com/johnstonskj/6af5ef6866bfb1288f4962a6ba3ef418) may be useful to you if you do not have your own Eldev workflow.
## License(s)
The contents of this repository are made available under the following
licenses:
### Apache-2.0
> ```text
> Copyright 2023-2025 Simon Johnston
>
> 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](https://github.com/sdm-lang/emacs-ob-sdml/blob/main/LICENSE-APACHE).
### MIT
> ```text
> Copyright 2023-2025 Simon Johnston
>
> 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](https://github.com/sdm-lang/emacs-ob-sdml/blob/main/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
The `0.1.x` series are all pre-release and do not appear in ELPA/MELPA.