just-spinner v0.1.0

Author: kevin-lee

build.sbt

@@ -18,7 +18,8 @@ ThisBuild / scmInfo :=
     s"https://github.com/${props.GitHubUsername}/${props.RepoName}.git",
   ).some
 
-lazy val root = (project in file("."))
+lazy val justSpinner = (project in file("."))
+  .enablePlugins(DevOopsGitHubReleasePlugin)
   .settings(
     name := props.ProjectName,
     crossScalaVersions := props.CrossScalaVersions,
@@ -124,8 +125,8 @@ lazy val props =
 lazy val libs =
   new {
 
-    lazy val catsCore     = Def.setting("org.typelevel" %%% "cats-core"     % props.CatsVersion)
-    lazy val effectieCats = Def.setting("io.kevinlee"   %%% "effectie-cats" % props.EffectieVersion)
+    lazy val catsCore     = Def.setting("org.typelevel" %%% "cats-core" % props.CatsVersion)
+    lazy val effectieCats = Def.setting("io.kevinlee" %%% "effectie-cats" % props.EffectieVersion)
 
     lazy val tests = new {
       lazy val hedgehog = Def.setting(

changelogs/0.1.0.md

@@ -0,0 +1,52 @@
+## [0.1.0](https://github.com/kevin-lee/just-spinner/issues?q=is%3Aissue+is%3Aclosed+-label%3Ainvalid+milestone%3Am1) ([RPs](https://github.com/kevin-lee/just-spinner/pulls?q=is%3Aissue+is%3Apr+is%3Aclosed+-label%3Ainvalid+milestone%3Am1)) - 2026-03-28
+
+## Done
+
+* Initial release of `just-spinner`
+
+### 🚀 Features
+
+- **Cross-Platform Spinner Library**: Terminal spinner support for JVM, Scala.js, and Scala Native from a shared core implementation.
+- **Effect-Friendly API**: Main API centered on `SpinnerHandle[F]` so spinner operations can stay abstract over effects, with `cats.Id` support for direct side-effecting usage. For now, it has only the side-effect version, but it will support Cats Effect `IO` and possibly `Future`
+- **Runtime Spinner Controls**: Update text, prefix, suffix, color, spinner type, indentation, and enabled state while the spinner is running.
+- **Completion Helpers**: Built-in `succeed`, `fail`, `warn`, `info`, `stop`, and `stopAndPersist` operations for common command-line workflow outcomes.
+- **Rich Spinner Presets**: Includes multiple built-in animations such as `dots`, `moon`, `arrow`, `bouncingBar`, `clock`, `earth`, `star`, and `tableFlip`, with support for custom frame sets and intervals.
+
+### 🏗️ Architecture
+
+- **Shared Core, Platform Adapters**: Common spinner logic lives in shared sources, while platform-specific timer, terminal output, and Unicode support are implemented separately for JVM, JS, and Native.
+- **Functional Design**: Immutable configuration and state models with effect-polymorphic interfaces and pure value types where possible.
+- **Terminal-Aware Rendering**: Handles interactive vs non-interactive terminals, ANSI cursor control, Unicode log symbols, and ANSI-safe string width calculation.
+
+### 📦 Project Structure
+
+```text
+modules/
+├── core/            # Shared spinner logic plus JVM/JS/Native platform adapters
+├── example-js/      # Scala.js demo application
+├── example-native/  # Scala Native demo application
+├── example-java/    # Scala JVM demo application
+```
+
+### ➕ Added
+
+- Initial release of `just-spinner`, a cross-platform terminal spinner library for Scala with shared support for Scala `2.13.18` and Scala `3.3.7`.
+- Core spinner API built around `Spinner`, `SpinnerHandle[F]`, `SpinnerConfig`, `SpinnerType`, `PersistOptions`, and platform-aware `TerminalOutput` and `SpinnerTimer` abstractions.
+- Runtime controls for spinner text, prefix and suffix text, color, indentation, cursor visibility, silent mode, and explicit enablement for interactive and non-interactive terminals.
+- Built-in spinner presets including `dots`, `dots2`, `dots3`, `dots12`, `line`, `moon`, `arrow`, `bouncingBar`, `arc`, `toggle`, `clock`, `earth`, `star`, `aesthetic`, and `tableFlip`, plus support for custom spinner definitions.
+- Outcome helpers for `succeed`, `fail`, `warn`, `info`, `stop`, `stopAndPersist`, and cooperative `println` output while a spinner is running.
+- ANSI-aware rendering helpers, Unicode-aware log symbols, and string-width handling for better terminal output across JVM, Scala.js, and Scala Native.
+
+### 📺 Examples
+
+- Added runnable example applications for Scala.js and Scala Native showing different spinner styles, colors, text updates, and completion states.
+
+### 🦔 Testing
+
+- Added Hedgehog-based specs covering ANSI code generation, colors, log symbols, spinner configuration, spinner state transitions, spinner types, string width calculation, and spinner handle behavior.
+
+### 🛠️ Tooling
+
+- Added sbt cross-project build setup, release metadata, and publishing support for JVM, Scala.js, and Scala Native modules.
+- Added repository automation with GitHub Actions for build, checks, coverage, release, PR labeling, and Dependabot updates.
+- Added formatting, linting, and quality tooling with Scalafmt, Scalafix, WartRemover, scoverage, and `sbt-ci-release`.