addSbtPlugin("africa.shuwari.sbt" % "sbt-shuwari-core" % "0.14.1")

• Automatically sets common settings such as organizationName, organizationHomepage, and versionScheme.
• Includes developer information and other organisational settings for standardisation.
• Ensures projects can be omitted from publishing if required.

• shuwariProject:
  • Adds organisational defaults like organizationName, organizationHomepage, and developers.
  • Default settings:

    organizationName := "Shuwari Africa Ltd."
    organizationHomepage := Some(url("https://shuwari.africa"))
    versionScheme := Some("semver-spec")
    developers := List(
      Developer(
        "shuwari-dev",
        "Shuwari Africa Ltd. Developer Team",
        "developers at shuwari dot africa",
        url("https://shuwari.africa")
      )
    )

• notPublished:
  • Configures the project to skip all publishing tasks.
  • Default settings:

    publish / skip := true
    publish := {}
    publishLocal := {}
    publishArtifact := false

• dependsOn:
  • Simplified utility to depend on external libraries.

Example usage:

lazy val myProject = project
  .shuwariProject
  .notPublished

addSbtPlugin("africa.shuwari.sbt" % "sbt-shuwari-header" % "0.14.1")

• Automatically detects the licensing model used in your project.
• Supports custom, Apache 2.0, or GPLv3-style licence headers.
• Includes configurable copyright holders.

• headerCopyrightHolder:

  • Defines the entity owning the copyright.
  • Default: None.

• headerLicense:

  • The licence header included in source files.
  • Default: Automatically detects from the project configuration.
    • Defaults to an internal licence if no licence is specified.
    • Can be explicitly set to Apache 2.0 or GPLv3 headers.

Example:

lazy val project = (project in file("."))
  .settings(apacheLicensed)

addSbtPlugin("africa.shuwari.sbt" % "sbt-shuwari-mode" % "0.14.1")

• Dynamically resolves the buildMode from the BUILD_MODE environment variable.
• Configures different behaviours for development, integration, and release builds.

• buildMode:
  • Configures the current build mode.
  • Default: Automatically detects from BUILD_MODE, defaults to Development. Valid values:
    • "DEVELOPMENT" → Mode.Development.
    • "INTEGRATION" → Mode.Integration.
    • "RELEASE" → Mode.Release.

Example:

ThisBuild / buildMode := Mode.Release

addSbtPlugin("africa.shuwari.sbt" % "sbt-shuwari-scalac" % "0.14.1")

• Seamlessly integrates with BuildModePlugin and TpolecatPlugin, enabling dynamic assignment of scalac options.

• Adjusts configurations for stricter linting and compilation optimisations based on the active build mode.

• tpolecatOptionsMode:

  • Dynamically maps TpolecatPlugin modes to the current build mode, as provided by sbt-shuwari-mode. This ensures tailored compiler flags for various scenarios:
    • VerboseMode corresponds to Mode.Development, promoting detailed feedback for debugging.
    • CiMode aligns with Mode.Integration, focusing on consistency and maintainability.
    • ReleaseMode associates with Mode.Release, ensuring production-ready builds.

  For more details, refer to the section on sbt-shuwari-mode.

• basePackages:

  • A list of base package names used to tune deeper optimisations across the project.
  • Default: List.empty.

• tpolecatDevModeOptions, tpolecatCiModeOptions, tpolecatReleaseModeOptions:

  • These keys provide customisation points for scalac options unique to each build mode. Use them to override or extend default configurations.

addSbtPlugin("africa.shuwari.sbt" % "sbt-shuwari-js" % "0.14.1")

• scalaJSLinkerConfig:
  • Configures the linker for Scala.js builds, automatically adjusting based on the current buildMode.

• Development Mode:
  Configured for faster builds and easier debugging. Uses ES modules for compatibility with modern JavaScript environments and applies the FewestModules strategy for minimal module splitting.

• Release/Integration Mode:
  Optimised for production and integration builds. Uses the SmallestModules splitting strategy for reducing bundle sizes and enables Closure Compiler for advanced optimisations.

• tpolecatExcludeOptions:

  • Excludes Scala.js-incompatible scalac options, such as:
    • explicitNulls
    • JVM-specific checks like checkMods.