Skip to content
Syntax support for the Ampersand Definition Language
TypeScript
Branch: development
Clone or download
hanjoosten Merge pull request #45 from AmpersandTarski/dependabot/npm_and_yarn/l…
…odash-4.17.15

Bump lodash from 4.17.11 to 4.17.15
Latest commit 90830ad Dec 6, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.vscode Enabling launch extention code Mar 1, 2019
images version 0.0.4 Jul 18, 2018
snippets support for new PROPBUTTON extensions Nov 13, 2019
src MacOS fix Aug 23, 2019
syntaxes Support for (deprecated!!) `PATTERN`/`ENDPATTERN`, `PROCESS`/`ENDPROC… Dec 4, 2019
test delete obsolete examples Mar 4, 2019
themes specify color for markdown texts Jan 5, 2019
.gitattributes remove the ampersand directory. This will help with deploying this ex… Jul 13, 2018
.gitignore New version - bugfixes, snippet enhancements (#37) May 7, 2019
.travis.yml disable npm test Mar 7, 2019
.vscodeignore cleaning up tests Feb 26, 2019
CHANGELOG.md Support for (deprecated!!) `PATTERN`/`ENDPATTERN`, `PROCESS`/`ENDPROC… Dec 4, 2019
LICENSE
README.md Checker output better integrated. Mar 28, 2019
ampersand-configuration.json Remove comments in json file. They are not permitted Jul 14, 2018
package-lock.json Bump lodash from 4.17.11 to 4.17.15 Nov 1, 2019
package.json MacOS fix Aug 23, 2019
tsconfig.json

README.md

Ampersand-Language-Support

This extension provides langauge support for the Ampersand Definition Language (ADL). This is a language that allows one to define an application in terms of state (expressed in terms of concepts, relations and relation algebraic invariant rules), and interfaces that allow for state changes. The tooling takes an ADL-script, and generates a complete web-application.

Features

  • syntax coloring grammar
  • syntax coloring theme (ampersand)
  • snippets that help you write the common language constructs
  • syntax and type checking as you type

Requirements

  • In order to use the ampersand commands, it is required that you have the ampersand executable in your path. Make sure it is a recent version.

  • In order to get syntax coloring, select the Ampersand coloring theme as the default theme for .adl files. The reason for this is that default syntax coloring is designed for traditional languages (e.g. PHP), and Ampersand is far from that.

How to use this extension

Ampersand: checker

A cool feature is the syntax- and typechecking of your ampersand script. To use this, you should be working in a workspace. The workspace has a root directory. In that directory, you should create a file named .ampersand. That file must contain a single line, which contains the relative path to your root ampersand file.

The checker should load automatically, when the extension is activated. If for some reason this doesn't work, you can spin it off manually by using the command Ampersand: Start checker. The checker will read the content of the .ampersand file. Then it will check that file and all included files. Errors or warnings will show up each time you save the file. In combination with autosave, this helps you to find errors as you type.

Syntax colouring

This works best with the ampersand theme: Select theme `Ampersand` (File > Preferences > Color Theme > Ampersand)

Known Issues

Features are currently testable, and may contain bugs. Please create an issue if you find a mistake.

Acknowledgements

The way the syntax- and typechecking of Ampersand is made available to the VScode extention was very much inspired by the awsome work Neil Mitchell did for the ghcid extension. I shamelessly copied and modified parts of his work. Thanks Neil!

Release Notes

The releasenotes can be found here.

Enjoy!

You can’t perform that action at this time.