Sinter

A Cargo-like build tool for Scala projects.

📖 Documentation: English | 中文

Features

• Project initialization with sinter new <name>
• Workspace initialization with sinter init
• Building Scala projects with sinter build
• Running Scala applications with sinter run
• Adding dependencies with sinter add <dep>
• Running tests with sinter test
• Workspace management with sinter workspace
• Internationalization support with sinter i18n
• Configurable project settings via project.toml

Installation

From Source

git clone https://github.com/s0raLin/sinter.git
cd sinter
cargo build --release
# Add target/release/sinter to your PATH

Prerequisites

• Rust (latest stable)
• Scala CLI (for Scala compilation and execution)
• Coursier (for dependency management, optional but recommended)

Quick Start

# Create a new project
sinter new hello-scala
cd hello-scala

# Add a dependency
sinter add cats

# Build and run
sinter build
sinter run

Usage

Getting Help

sinter --help          # Show all commands
sinter [command] --help # Show help for specific command

Initialize a workspace

mkdir my-workspace
cd my-workspace
sinter init

This creates a workspace configuration file workspace.project.toml.

Create a new project

sinter new my-scala-project
cd my-scala-project

This creates a new Scala project with the following structure:

my-scala-project/
├── project.toml          # Project configuration
└── src/main/scala/
    └── Main.scala       # Main application file

Manage workspace

sinter workspace add path/to/project

Adds a project to the workspace.

Build the project

sinter build

Compiles all Scala sources in src/main/scala and places compiled classes in the target_dir specified in project.toml.

Run the project

sinter run
sinter run path/to/MyFile.scala
sinter run --lib

• Without arguments: Runs the main file specified in project.toml
• With a file path: Runs the specified Scala file
• --lib: Forces library mode (compile only, no execution)

Add dependencies

sinter add cats
sinter add org.typelevel::cats-core_2.13:2.10.0
sinter add [email protected]:2.10.0
sinter add io.get-coursier:coursier_2.13:2.1.25-M19

Dependency format: group::artifact[@scala-version][:version] (Scala) or group:artifact:version (Java)

• cats: Adds the latest stable version of cats-core for the project's Scala version
• org.typelevel::cats-core_2.13:2.10.0: Full specification with group, artifact, Scala version, and version
• [email protected]:2.10.0: Short form with Scala version and version
• io.get-coursier:coursier_2.13:2.1.25-M19: Java dependency format (single colon) for Java libraries like coursier

Run tests

sinter test
sinter test path/to/TestFile.scala

Runs tests in the project or a specific test file.

Configuration

Project configuration is stored in project.toml:

[package]
name = "my-project"
version = "0.1.0"
main = "Main"
scala_version = "2.13"
source_dir = "src/main/scala"
target_dir = "target"

[dependencies]
"org.typelevel::cats-core_2.13" = "2.10.0"

Troubleshooting

Common Issues

• Scala CLI not found: Make sure Scala CLI is installed and available in your PATH
• Coursier not found: Coursier is optional but recommended for better dependency management. Install it from https://get-coursier.io/
• Build fails: Check that all dependencies are correctly specified in project.toml
• Run fails: Ensure your main file has a proper entry point (extends App or has a main method)

Getting More Help

• Run sinter --help for command overview
• Check the Scala CLI documentation for Scala-specific issues
• Report issues on the GitHub repository

License

This project is licensed under the MIT License - see the LICENSE file for details.