feat: implement icons, closes #8

Author: THEGOLDENPRO

suap.example.toml

@@ -1,7 +1,16 @@
 version = 1
-
 # Using Roseate (https://github.com/cloudy-org/roseate) as an example.
-display-name = "Roseate" # TODO: add support for display name
+
+# If display name is not specified the 
+# strict lower-case app name will be used instead
+display-name = "Roseate"
+
+# The icons folder is where you'll place your icons.
+# 
+# The name of the image files must be specific like so:
+# "windows.ico" - windows specific app icon
+# "original.png" - when there's no platform specific icon suap falls back to
+icons = "./assets/icons"
 
 [project.cargo]
 bin-crate = "roseate" # The name of the cargo binary crate to target

suap/commands/packaging/icons.py

@@ -0,0 +1,74 @@
+from typing import Optional
+
+import shutil
+import logging
+from pathlib import Path
+
+from ...platform_format import PlatformFormat
+
+__all__ = ()
+
+logger = logging.getLogger(__name__)
+
+def get_platform_icon_path(icons_path: Path, platform_format: PlatformFormat) -> Optional[Path]:
+    """
+    Returns `None` if an icon can't be found / doesn't exist. Otherwise a `Path` is returned.
+    """
+    icon_file_name = None
+
+    if platform_format & PlatformFormat.LINUX:
+        icon_file_name = "linux.png"
+
+    elif platform_format & PlatformFormat.WINDOWS:
+        icon_file_name = "windows.ico"
+
+    elif platform_format & PlatformFormat.MACOS:
+        icon_file_name = "macos.icns"
+
+    if icon_file_name is not None:
+        icon_image_path = icons_path.joinpath(icon_file_name)
+
+        if icon_image_path.exists():
+            logger.debug(f"Platform specific icon was found at '{icon_image_path}'.")
+
+            return icon_image_path
+
+        original_icon_path = icons_path.joinpath("original.png")
+
+        if original_icon_path.exists():
+            logger.warning(
+                "No platform specific icons were found! Falling " \
+                f"back to 'original' icon ({original_icon_path})..."
+            )
+
+            if platform_format & PlatformFormat.WINDOWS:
+                logger.warning(
+                    "You will MOST LIKELY want a platform specific icon for Windows "\
+                        "(e.g: 'windows.ico') as support for PNGs are a gray area and can cause problems."
+                )
+
+            return original_icon_path
+
+    return None
+
+def format_icon_with_project_name(
+    icon_path: Path,
+    temp_folder_path: Path,
+    project_name: str
+) -> Path:
+    logger.debug(
+        "Formatting icon with project name and " \
+            "copying it over to the './temp' directory..."
+    )
+
+    temp_folder_path.mkdir(exist_ok = True)
+
+    icon_temp_destination_path = temp_folder_path.joinpath(
+        f"{project_name}{icon_path.suffix}"
+    )
+
+    logger.debug(f"Copying icon to temp directory at '{icon_temp_destination_path}'...")
+
+    shutil.copy(icon_path, icon_temp_destination_path)
+
+    return icon_temp_destination_path

suap/commands/packaging/nsis.py

@@ -1,4 +1,5 @@
-import shutil
+from typing import Optional
+
 import logging
 from typer import Exit
 from pathlib import Path
@@ -21,7 +22,8 @@ def format_config_and_make_nsis_installer(
     binary_suffix: str,
     dist_folder_path: Path,
     temp_folder_path: Path,
-    display_name: str,
+    display_name: Optional[str],
+    icon_path: Path,
     project_data: ProjectData,
 ):
     logger.debug(
@@ -51,9 +53,11 @@ def format_config_and_make_nsis_installer(
 
     replace_map: dict[str, str] = {
         "suap-binary-name": binary_name,
-        "suap-binary-path": f"../{binary_path}",
-        "suap-binary-dist-path": str(binary_dist_path),
-        "suap-display-name": display_name,
+        "suap-binary-path": str(binary_path.absolute()),
+        "suap-binary-dist-path": str(binary_dist_path.absolute()),
+        "suap-display-name": display_name if display_name is not None else project_data.name,
+        "suap-icon-path": str(icon_path.absolute()),
+        "suap-icon-file-name": icon_path.name,
 
         "suap-project-name": project_data.name,
         "suap-project-version": f"{semver.major}.{semver.minor}.{semver.patch}" \
@@ -74,8 +78,4 @@ def format_config_and_make_nsis_installer(
     if not make_nsis_installer(nsis_installer_script_path):
         raise Exit(1)
 
-    logger.debug("Done making NSIS installer, installer executable should be in dist.")
-
-    logger.debug("Removing temp dir...")
-
-    shutil.rmtree(temp_folder_path)
+    logger.info("Done making NSIS installer, installer executable should be in dist.")

suap/commands/packaging/package.py

@@ -4,12 +4,14 @@
     from ...config.data import ConfigProjectData
 
 import os
+import shutil
 import logging
 from pathlib import Path
 from typer import Option, Typer, Exit
 
 from .binary import format_and_copy_binary_to_dist
 from .nsis import format_config_and_make_nsis_installer
+from .icons import get_platform_icon_path, format_icon_with_project_name
 
 from ...config import get_config_data
 from ...project_type import ProjectType
@@ -29,14 +31,14 @@ def package(
         Option(
             help = "The packaging format or platform we are targeting. Choose a less generic option if you only want to " \
                 "package towards ONE specific format such as 'windows-setup', otherwise all available formats " \
-                "of such platform will be automatically packaged."
+                "of such platform will be automatically packaged (as is the case with 'windows')."
         )
     ],
     bin_output_name: Annotated[
         Optional[str],
         Option(
             help = "Override the default binary name prefixed in front of the binary suffix " \
-                "(e.g: 'bin-name-linux-x86_64', 'bib-name-win-x86_64-setup.exe', 'bin-name-macos-x86_64')."
+                "(e.g: 'bin-name-linux-x86_64', 'bin-name-win-x86_64-setup.exe', 'bin-name-macos-x86_64')."
         )
     ] = None,
 ):
@@ -54,6 +56,31 @@ def package(
         raise Exit(1)
 
     display_name: Optional[str] = config_data.get("display-name", None)
+    icons_config_path: Optional[str] = config_data.get("icons", None)
+
+    if icons_config_path is None:
+        logger.error(
+            "Icons folder is required to be specific in the config and at " \
+                "least an original icon must be present (e.g: 'original.png')!" \
+                    '\n    icons = "./assets/icons"'
+        )
+        raise Exit(1)
+
+    icons_path = Path(icons_config_path)
+
+    if not icons_path.exists():
+        logger.error(f"Icons folder path does not exist ('{icons_path}')!")
+
+        raise Exit(1)
+
+    platform_icon_path = get_platform_icon_path(icons_path, platform_format)
+
+    if platform_icon_path is None:
+        logger.error(
+            "At least an original icon is required in your icons " \
+                f"path at '{icons_config_path}' (e.g: 'original.png')!"
+        )
+        raise Exit(1)
 
     if project == ProjectType.CARGO:
         projects_data: Optional[ConfigProjectData] = config_data.get("project", None)
@@ -115,14 +142,24 @@ def package(
         if platform_format & PlatformFormat.WINDOWS_SETUP:
             binary_path = cargo_release_path.joinpath(f"{project_data.name}.exe")
 
+            platform_icon_path = format_icon_with_project_name(
+                platform_icon_path,
+                temp_folder_path,
+                project_name = project_data.name
+            )
+
             format_config_and_make_nsis_installer(
                 binary_path,
                 binary_name = binary_name,
                 binary_suffix = "win-x86_64-setup.exe",
                 dist_folder_path = dist_folder_path,
                 temp_folder_path = temp_folder_path,
-                display_name = display_name if display_name is not None else project_data.name,
+                display_name = display_name,
+                icon_path = platform_icon_path,
                 project_data = project_data
             )
 
-    logger.info("WIP!")
+    logger.debug("Removing temp dir...")
+    shutil.rmtree(temp_folder_path, ignore_errors = True)
+
+    logger.info("This command is WIP!")

suap/config/data.py

@@ -19,6 +19,7 @@ class ConfigProjectData(TypedDict):
     {
         "version": int,
         "display-name": str,
+        "icons": str,
         "project": ConfigProjectData
     }
 )

suap/projects/cargo/building.py

@@ -1,5 +1,6 @@
 from typing import Optional
 
+import os
 import logging
 from subprocess import check_call, CalledProcessError
 
@@ -30,6 +31,9 @@ def build_cargo_project(toolchain_name: str, cargo_crate_name: str) -> bool:
     logger.debug(f"Invoking 'cargo build' with toolchain '{toolchain_name}'...")
 
     try:
+        default_env = os.environ.copy()
+        default_env["RUSTFLAGS"] = "-Awarnings" # hides warnings in console
+
         check_call(
             [
                 "cargo",
@@ -39,7 +43,8 @@ def build_cargo_project(toolchain_name: str, cargo_crate_name: str) -> bool:
                 cargo_crate_name,
                 "--target",
                 toolchain_name
-            ]
+            ],
+            env = default_env
         )
 
     except CalledProcessError as error:

suap/templates/nsis_installer_script.nsi

@@ -1,6 +1,7 @@
 !include "MUI2.nsh"
 
 Name "{suap-display-name}"
+BrandingText "{suap-display-name}"
 OutFile "{suap-binary-dist-path}"
 InstallDir "$PROGRAMFILES64\cloudy-org\{suap-project-name}"
 
@@ -11,6 +12,13 @@ VIAddVersionKey "FileVersion" "{suap-project-version}"
 
 SetCompressor /SOLID Lzma
 
+# Defining some MUI specific features, like icons for the installer executables
+!define MUI_ICON "{suap-icon-path}"
+!define MUI_UNICON "{suap-icon-path}"
+
+!define MUI_ABORTWARNING # good UX
+!define MUI_UNABORTWARNING
+
 # The typical installer pages a windows user will expect before installing software.
 !insertmacro MUI_PAGE_WELCOME
 !insertmacro MUI_PAGE_DIRECTORY
@@ -24,20 +32,24 @@ SetCompressor /SOLID Lzma
 Section "MainSection"
     # Where we place our application binary file and other files.
     SetOutPath "$INSTDIR"
+
+    # Where we add files from our environment, such as the application binary to the windows install directory.
     File "{suap-binary-path}"
+    File "{suap-icon-path}"
 
     WriteUninstaller "$INSTDIR\uninstall.exe"
 
     # Windows needs to know our application can be uninstalled via it's uninstall apps settings.
     WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}" "DisplayName" "{suap-display-name}"
     WriteRegStr HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}" "UninstallString" "$INSTDIR\uninstall.exe"
 
-    CreateShortcut "$DESKTOP\{suap-project-name}.lnk" "$INSTDIR\{suap-binary-name}.exe"
+    CreateShortcut "$DESKTOP\{suap-project-name}.lnk" "$INSTDIR\{suap-binary-name}.exe" "" "$INSTDIR\{suap-icon-file-name}" 0
 SectionEnd
 
 Section "Uninstall"
     # Where we remove our application binary file and other files.
     Delete "$INSTDIR\{suap-binary-name}.exe"
+    Delete "$INSTDIR\{suap-icon-file-name}"
     Delete "$INSTDIR\uninstall.exe"
     RMDir "$INSTDIR"