https://github.com/ghik/zerowaste

Scala compiler plugin to detect unused expressions
https://github.com/ghik/zerowaste

compiler-plugin purely-functional scala static-analysis

Last synced: about 13 hours ago
JSON representation

Scala compiler plugin to detect unused expressions

• Host: GitHub
• URL: https://github.com/ghik/zerowaste
• Owner: ghik
• License: mit
• Created: 2022-08-27T11:34:42.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2025-01-13T21:09:29.000Z (10 days ago)
• Last Synced: 2025-01-16T02:12:42.139Z (8 days ago)
• Topics: compiler-plugin, purely-functional, scala, static-analysis
• Language: Scala
• Homepage:
• Size: 88.9 KB
• Stars: 65
• Watchers: 3
• Forks: 12
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Zerowaste

Scala compiler plugin to detect unused expressions (non-`Unit`).

Zerowaste is currently available for Scala 2.12.17+, 2.13.10+, 3.2.1+, 3.3.0+, and 3.4.0+

Compiler plugins must be cross-built for every minor and patch version of Scala. If `zerowaste` is not available for a Scala version that you want to use (most likely some freshly released one), please file an issue or submit a PR.

### How to submit a PR with a new Scala version

1. Add your desired Scala version to `crossScalaVersions` in `build.sbt`

1. Run `sbt githubWorkflowGenerate`

1. Commit the changes in `build.sbt` and github workflows

1. Submit a PR

## Introduction

Pure functional programming operates under the principle that expressions are free from side-effects.

Side-effects are instead handled through an IO-like type, such as Cats Effect's IO, and are only executed upon explicit,

unsafe `runX` invocation, usually hidden somewhere in library code.

As a consequence, discarding a result of an expression in purely functional code can always be assumed to be a mistake, e.g.

```scala

val number = {

  discardedExpression // pointless!

  42

}

```

This is an easy mistake and it can lead to tricky bugs, such as when an important IO action is unintentionally discarded.

The Scala compiler cannot detect this issue as Scala is not a purely functional language and cannot assume all expressions are pure.

This plugin addresses this problem by reporting a warning for every discarded expression whose type is different than `Unit`.

## Usage

Enable the plugin in `build.sbt`:

```scala

libraryDependencies += compilerPlugin("com.github.ghik" % "zerowaste" % "" cross CrossVersion.full)

```

The plugin issues warnings, but it is often a good idea to turn them into compilation errors:

```scala

scalacOptions += "-Werror"

```

Note that these warnings, despite being converted to errors, can be suppressed with the `@nowarn` annotation:

```scala

import scala.annotation.nowarn

val number = {

  discardedExpression: @nowarn("msg=discarded expression")

  42

}

```