Magik-tools is a collection of tools for the Magik programming language used by the Smallworld 5 platform. It provides the following tools:
- Language server
- Debug adapter
- Linter
- Typing linter
- SonarQube plugin
By no means is this product fully tested and production-ready. Use at your own risk, your mileage may vary.
This project consists of several components.
After building, the artifact/jar will be created at sonar-magik-plugin/target/sonar-magik-plugin-<version>.jar.
Copy the plugin (sonar-magik-plugin-<version>.jar) to your sonarqube/extensions/plugins directory. (Re)start Sonar to activate the plugin.
Pre-built artifacts/jars can be found at magik-tools/releases.
Use sonar-scanner to analyze your projects. An example configuration, stored in sonar-project.properties, would be:
sonar.projectKey=test:test_project
sonar.projectName=Test project
sonar.sources=modules/
sonar.language=magik
sonar.coverageReportPaths=coverage.xmlA linter for Magik is available in the magik-lint directory. See magik-lint/README.md for more information.
A typing checker/linter for Magik is available in the magik-typed-lint directory. See magik-typed-lint/README.md for more information.
A language server for Magik is available in the magik-language-server directory. See magik-language-server/README.md for more information.
A debug adapter for Smallworld 5/Magik is available in the magik-debug-adapter directory. See magik-debug-adapter/README.md for more information.
You can build the plugin using maven, like so:
$ mvn clean verify test package
[INFO] Scanning for projects...
...Building without running tests:
$ mvn -Dmaven.test.skip=true clean verify test package
[INFO] Scanning for projects...
...Auto-formatting of Java sources:
$ mvn spotless:apply
[INFO] Scanning for projects...
...You can run the unit tests using maven, like so:
$ mvn clean test
[INFO] Scanning for projects...
...Results will be shown on the console.
You can update versions using the Versions Maven Plugin.
To update all projects:
$ mvn -B versions:set -DgenerateBackupPoms=false -DnewVersion=<version>
...Also update these files:
magik-language-server/client-vscode/package.jsonmagik-language-server/client-vscode/client/package.jsonmagik-language-server/client-vscode/client/src/const.ts
Then, create a release by pushing a new tag to Github.
Dependabot is used to keep versions up to date.
In case versions have to be updated manually, run the following to check if there are any new versions of maven-dependencies available:
$ mvn versions:display-dependency-updates
...This project can found at SonarCloud.
See CONTRIBUTING.md for instruction on how to contribute.
This project is licensed under GPLv3, see LICENSE.md.
Commercial use is allowed. By no means is this product fully tested. Use at your own risk, your mileage may vary.
If you do use this - commercially or not - please do inform me.