scala-garden/mima
58.6
Adequate · 6 November 2026
5.2k
lines of production code
Scala
primary language
4
measurements over time
What this system is
Features
Introduce MiMa CLI for binary compatibility checking
Added a new command-line interface (MimaCli) that allows users to run binary compatibility checks directly from the terminal. The CLI accepts old and new binary files (JARs or directories), supports filtering by forward or backward compatibility, and can display bytecode names, verbose descriptions, and suggested filter lines for problematic APIs.
repository · high confidence
Removals
Removal of legacy MiMa core implementation files
The core implementation files for the MiMa binary compatibility checker in \src/main/scala/ssol/tools/mima\ have been removed. This includes the class file parser, transformer, and fix logic (e.g., \ClassfileParser\, \ClassfileTransformer\, \Fix\), as well as supporting data structures and utilities (e.g., \BufferReader\, \ClassInfo\, \MemberInfo\, \MiMaClient\, \MiMaLib\).
src/main · high confidence
Behavioural changes
Add template-level compatibility checking for class hierarchy changes
The MiMa core now includes a new TemplateChecker that validates structural compatibility between old and new class definitions. This check detects breaking changes such as modifications to the trait/interface status, visibility reductions, unexpected abstraction or finality, cyclic type references, and the removal of superclasses or interfaces. It also verifies that parent type arguments in generic signatures remain compatible, ensuring that changes to class hierarchies are caught during binary compatibility analysis.
core/src/main/scala/com/typesafe/tools/mima/lib/analyze/template · high confidence
Core binary analysis engine refactored with new classfile parsing and API tracking
The core analysis engine has been rebuilt to improve binary compatibility checking accuracy and performance. A new classfile parser now handles modern bytecode features, including TASTy (Scala 3) and Java 9+ constant pool tags, while replacing the previous homegrown UTF-8 decoding with a dedicated codec. The internal model has been split into distinct \MethodInfo\ and \FieldInfo\ classes, and a new \BinaryApi\ system allows users to explicitly keep definitions in the API surface even if they are no longer exposed in source, preventing false positives for legacy or internal members. Additionally, the engine now correctly tracks escape routes for classes that clients can reach indirectly, improving the detection of binary incompatibilities in complex inheritance hierarchies.
core/src/main/scala/com/typesafe/tools/mima/core · high confidence
Introduce dedicated field compatibility checking
A new FieldChecker component has been added to the core analysis engine to specifically validate binary compatibility of class fields. This change introduces logic to detect missing fields, inaccessible fields, incompatible field types, and incorrect static/virtual modifiers, providing more granular and accurate reporting for field-level changes compared to previous generic checks.
core/src/main/scala/com/typesafe/tools/mima/lib/analyze/field · high confidence
Logging implementation moved to internal package with new log levels
The internal logging mechanism has been refactored into a new \com.typesafe.tools.mima.core.util.log\ package, introducing a \Logging\ trait and a \ConsoleLogging\ implementation. This change adds support for \verbose\ and \debug\ log levels (with debug output disabled by default) alongside existing \warn\ and \error\ methods, and restricts the logging API to internal use only.
core/src/main/scala/com/typesafe/tools/mima/core/util · high confidence
MiMa sbt plugin refactored for Scala 3 and sbt 1.x compatibility
The MiMa sbt plugin has been rewritten as an AutoPlugin to support Scala 3 and modern sbt versions (1.x/2.x), replacing the previous implementation. This change introduces new configuration keys for managing binary compatibility checks, including support for forward compatibility checks, versioned issue filters, and configurable dependency resolution. The plugin now differentiates between unset and empty previous artifacts, allows filtering issues via files in a specified directory, and provides better error reporting and logging for build failures.
sbtplugin/src/main · high confidence
MiMa settings are now configurable at the build level
Users can now define MiMa configuration keys such as \mimaPreviousArtifacts\ and \mimaBinaryIssueFilters\ using \ThisBuild\ scope, allowing these settings to be applied globally across all projects in a multi-project build rather than being restricted to individual project scopes. The test suite also verifies that \mimaReportSignatureProblems\ is available as a build-level setting, enabling users to control signature checking behavior consistently across the entire build.
sbtplugin/src/sbt-test/sbt-mima-plugin/build-level-keys · high confidence
MiMaLib now supports forward compatibility checks and configurable exclusion annotations
The MiMaLib core class has been refactored to support forward compatibility checks via a new \forwards\ parameter in \collectProblems\, which filters out problems that only guard later releases when comparing an earlier version against a newer one. Additionally, the class now accepts a \binaryApi\ specification and configurable exclusion annotations (\excludeAnnots\), allowing users to customize which API changes are ignored during the comparison. The class also handles POM-only modules by creating empty package definitions when a directory or JAR is not found, ensuring the analysis proceeds without failure for such modules.
core/src/main/scala/com/typesafe/tools/mima/lib · high confidence
Migrate build to sbt 1.13 and modernize plugin configuration
The project build has been upgraded from sbt 0.7.4 to sbt 1.13.0, accompanied by a significant restructuring of the build definition. The legacy \project/build/MimaProject.scala\ file has been removed in favor of a modern \project/MimaSettings.scala\ configuration that explicitly sets up MiMa binary compatibility checks against version 1.2.0 with specific filters for internal API changes. Additionally, \plugins.sbt\ has been updated to use current versions of \sbt-ci-release\ (1.12.1), \sbt-mima-plugin\ (1.2.1), \sbt-scalafmt\ (2.6.2), and Scala Native plugins, while enabling stricter compiler warnings like \-Xfatal-warnings\.
project · high confidence
Migrate functional tests to pure Scala code
The functional test infrastructure in \functional-tests/src/main\ has been rewritten from HOCON-based configuration to pure Scala code. This change introduces new test runners (\UnitTests\, \IntegrationTests\) and core test components (\TestCase\, \CollectProblemsTest\, \AppRunTest\) that handle compilation, execution, and binary compatibility checks directly in Scala, replacing the previous configuration-driven approach.
functional-tests/src/main · high confidence
Project reorganization and standardization of development tooling
The repository has been restructured to standardize development workflows and clarify project organization. A new \.scalafmt.conf\ file enforces code formatting rules (version 3.11.5) and excludes generated test fixtures from formatting checks, while \.git-blame-ignore-revs\ is introduced to ignore historical formatting commits. The project structure is now explicitly documented in \CONTRIBUTING.md\, detailing the separation into \mima-core\ and \sbt-mima-plugin\ modules, and defining the functional test suite structure (\functional-tests\) with specific oracle files (\problems.txt\) and app execution fixtures. Additionally, standard OSS governance files (\CODE\_OF\_CONDUCT.md\, \LICENSE\, \NOTICE\) and a \RELEASING.md\ checklist have been added, and \.scala-steward.conf\ is configured to pin the sbt version to 1.x to maintain compatibility with the Scala 2 community build.
(repo-wide) · high confidence
Refactored core analysis into specialized checkers
The core analysis logic has been restructured to separate concerns, with the Analyzer now delegating to specific checkers for templates, fields, and methods. This change introduces configurable exclusion annotations, allowing users to filter out problems based on annotations present on the old class, its outer chain, or its companion/module classes. The analyzer also now explicitly handles cases where a class is no longer checked due to visibility changes or missing bytecode, ensuring more accurate reporting of binary compatibility issues.
core/src/main/scala/com/typesafe/tools/mima/lib/analyze · high confidence
Refined binary compatibility checks for method signatures and hierarchy changes
MiMa now performs more precise analysis of method changes by parsing and comparing signatures rather than relying solely on descriptors, which reduces false positives for generic type changes. The tool also detects when a public method is narrowed to private (binary breaking), flags when a hierarchy becomes sealed (closed), and correctly identifies incompatible result types in overridden methods. Additionally, it handles edge cases such as mixin forwarders, deferred methods in traits, and new abstract methods inherited from new supertypes, providing clearer error messages for these specific binary incompatibilities.
core/src/main/scala/com/typesafe/tools/mima/lib/analyze/method · high confidence
Test coverage
Add test cases for filter file support; Added CLI validation tests for missing files and exit codes; Added Scala 3 compatibility test for sbt-mima-plugin; Added integration tests for Scala 2.12 binary compatibility; Added test for MIMA binary compatibility on POM-only projects; Added test for Scala 3 platform-specific artifact resolution; Added test for backward compatibility of abstract methods; Added test for inherited method detection in sbt-mima-plugin; Added test suite for core binary compatibility analysis logic; Added tests for backward, forward, and minimal binary compatibility filtering; Expanded functional tests for binary compatibility and API evolution; Test coverage for binary API filtering from file; Test coverage for mimaPreviousArtifacts configuration states; Test coverage for per-version backward filter directories; Test coverage for wildcard support in MiMA filter files.
Dependencies
Upgrade to MUnit 1.3.6 and update Scala 3.3.8
The build system now uses MUnit 1.3.6 for testing across the core, CLI, and test modules, replacing previous versions. Additionally, the default Scala 3 version for the core library and CLI has been updated to 3.3.8 (LTS), while the sbt plugin continues to target Scala 3.8.4 for compatibility with sbt 2. The functional and integration test modules also leverage the new MUnit version and support Scala 2.12.21 and 2.13.18.
(dependencies) · high confidence
Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.
How this codebase got here
Score
- CAI 55 → 59 (+3.3)
- Rubric changed (rubric-2026.10.5 → rubric-2026.11.2) — scores are not directly comparable.
Lenses
- Code Health 72 → 72 (+0.0)
- Architecture 99 → 99 (+0.0)
- Maturity 44 → 51 (+6.9)
- Readiness 53 → 53 (+0.0)
- Security 75 → 75 (+0.0)
Resolved (2)
- Off-boarding risk: anonymized user #1
- Overloaded method with ambiguous intent regarding 'binaryApi'. The second overload adds a binaryApi parameter, but it is not clear if this parameter overrides the default behavior derived from dir or if it is an alternative input source. This creates confusion about whether the user should provide the directory path or the pre-parsed binary API entries.
New (2)
- Off-boarding risk: anonymized user #1
- Orphaned file (core/src/main/scala/com/typesafe/tools/mima/core/Definitions.scala)
Changes since last survey
- 4 commits — 4 feature/other, 0 fixes
By area
- (repo) — 2 commits
- (root) — 1 commit
- project/build.properties — 1 commit
Notable commits
- change: Merge pull request #998 from scala-steward/update/scala3-library-3.3.9
- change: Merge pull request #999 from scala-steward/update/sbt-1.13.1
- change: Update sbt, scripted-plugin to 1.13.1
- change: Update scala3-library to 3.3.9
Architecture
- Unchanged — 0 containers · 1 contexts · 0 edges
Written by cca.canine.dev from the codebase's own history, inside the signed delivery this page is composed from.
Survey your own repository
scala-garden/mima was measured the same way every project in this corpus was: the same rubric, at a pinned commit, with the result published in full. Point a surveyor at a repository you know and see whether you agree with it.
About this page
- The score is its most recent published measurement, taken on 6 November 2026 at a pinned commit. It is not a live figure and does not change until the project is measured again.
- Measured at commit e5633f0d31a9dc2de46c5423a539b8283263b977 — the exact code this score is about.
- Scored under rubric-2026.11.2 — the same rubric and the same method as every other entry in this index.
- Measured by Canine Code Analyzer (cca.canine.dev) using cca measure-2026.11.3+preprod-60d1b390edf0.