Framework for supporting different programming languages in TMC.
TMC-langs provides an interface that encapsulates everything needed to support a new language in TMC. The framework provides CLI wrappers so that it's fairly convenient to call from other languages like Ruby.
Documentation for the latest release is available at https://rage.github.io/tmc-langs-rust
The specifications for various configuration files are included in the spec directory.
The student file policy of each plugin is explained in a README.md file in the plugin's subdirectory.
Install Rust according to https://www.rust-lang.org/tools/install
Install zstd. For example, on Ubuntu you need the package libzstd1. For Windows, download the appropriate archive from the releases, extract it and add the extracted directory to your PATH.
git clone git@github.com:rage/tmc-langs-rust.git
cd tmc-langs-rust
cargo buildIf you have any troubles building the project, please do make an issue!
cargo testcargo run -p tmc-langs-cli helpFormat using cargo fmt, use cargo clippy for linting. All crates should have the clippy lints print_stdout and print_stderr set to deny. The CLI has one function where writing to stdout is allowed.
If using vscode and rust-analyzer, be sure to turn on the setting loadOutDirsFromCheck to avoid a spurious unresolved import error from isolang.
In addition to the dependencies listed in each crate's Cargo.toml, the project bundles a few external dependencies such as tmc-checkstyle-runner, tmc-junit-runner and so on. When updating dependencies, you may want to check whether these projects have been updated.
tmc-langs-rust follows Rust-style semantic versioning, but only for the CLI (tmc-langs-cli). The library crates may go through breaking changes in any release as long as they don't cause any visible changes in functionality to a user of the CLI.
Documentation and binaries for the supported targets are built and the binaries deployed to Google Cloud when creating a GitHub release. The binaries are available at https://download.mooc.fi/tmc-langs-rust/, with each binary following the file name format tmc-langs-cli-{target}-{version}(.exe), with the .exe suffix added for the Windows binaries. For a list of targets see below. For example, The 64-bit Linux binary for version 0.5.0 is available at https://download.mooc.fi/tmc-langs-rust/tmc-langs-cli-x86_64-unknown-linux-gnu-0.5.0.
- Linux 64-bit (x86_64-unknown-linux-gnu)
- Linux 32-bit (i686-unknown-linux-gnu)
- Windows MSVC 64-bit (x86_64-pc-windows-msvc)
- Windows MSVC 32-bit (i686-pc-windows-msvc)
- MacOS 64-bit (x86_64-apple-darwin)
- ARM64 (aarch64-unknown-linux-gnu)
- Armv7 (armv7-unknown-linux-gnueabihf)
A "frontend" for tmc-langs. A binary CLI client for TMC-langs for IDEs. Intended to be used programmatically, for a CLI meant for manual use see tmc-cli-rust.
The "backend". A library that provides a convenient API for implementing different frontends. A frontend (such as a CLI) should only depend on this.
A library for communicating with the TMC server.
A library for creating language plugins.
A library that provides a convenient API for using all the different plugins.
A utility library that contains various kinds of useful functionality for other projects.
A TMC plugin for C#.
TMC plugins for Maven and Ant projects.
A TMC plugin for Make.
A TMC plugin for projects with no tests.
A TMC plugin for Python 3.
A TMC plugin for R.
Licensed under either of
- Apache License, Version 2.0 (LICENSE-APACHE or http://www.apache.org/licenses/LICENSE-2.0)
- MIT license (LICENSE-MIT or http://opensource.org/licenses/MIT)
at your option.
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.