feat: add support for display name for nsis and fix uninstaller not removing shortcut.

closes #5, closes #12

Author: THEGOLDENPRO

pyproject.toml

@@ -14,16 +14,16 @@ suap = "suap.main:app"
 
 [dependency-groups]
 dev = [
-    "ty>=0.0.17",
-    "ruff>=0.15.1"
+    "ty>=0.0.21",
+    "ruff>=0.15.5"
 ]
 
 [build-system]
 requires = ["setuptools >= 77.0.3"]
 build-backend = "setuptools.build_meta"
 
 [tool.setuptools.dynamic]
-version = { attr = "suap.version.__version__" }
+version = { attr = "suap.__version__" }
 
 [tool.setuptools.package-data]
-suap = ["templates/*"]
+suap = ["templates/*"]

suap/commands/packaging/nsis.py

@@ -21,6 +21,7 @@ def format_config_and_make_nsis_installer(
     binary_suffix: str,
     dist_folder_path: Path,
     temp_folder_path: Path,
+    display_name: str,
     project_data: ProjectData,
 ):
     logger.debug(
@@ -52,6 +53,7 @@ def format_config_and_make_nsis_installer(
         "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-project-name": project_data.name,
         "suap-project-version": f"{semver.major}.{semver.minor}.{semver.patch}" \

suap/commands/packaging/package.py

@@ -53,6 +53,8 @@ def package(
     if config_data is None:
         raise Exit(1)
 
+    display_name: Optional[str] = config_data.get("display-name", None)
+
     if project == ProjectType.CARGO:
         projects_data: Optional[ConfigProjectData] = config_data.get("project", None)
 
@@ -119,6 +121,7 @@ def package(
                 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,
                 project_data = project_data
             )
 

suap/config/config.py

@@ -28,6 +28,6 @@ def get_config_data(project_root_dir: Path) -> Optional[ConfigData]:
 
     with open(config_path, mode = "rb") as file:
         logger.debug("Parsing toml config...")
-        config_data = tomllib.load(file) # ty: ignore[invalid-assignment]
+        config_data = tomllib.load(file)
 
     return config_data

suap/config/data.py

@@ -14,6 +14,11 @@
 class ConfigProjectData(TypedDict):
     cargo: ConfigCargoProjectData
 
-class ConfigData(TypedDict):
-    version: int
-    project: ConfigProjectData
+ConfigData = TypedDict(
+    "ConfigData",
+    {
+        "version": int,
+        "display-name": str,
+        "project": ConfigProjectData
+    }
+)

suap/templates/nsis_installer_script.nsi

@@ -1,15 +1,11 @@
 !include "MUI2.nsh"
 
-# TODO: All "suap-project-name" keys except "InstallDir" and 
-# "CreateShortcut" need to be changed to "suap-display-name" 
-# when that is available.
-
-Name "{suap-project-name}"
+Name "{suap-display-name}"
 OutFile "{suap-binary-dist-path}"
 InstallDir "$PROGRAMFILES64\cloudy-org\{suap-project-name}"
 
 VIProductVersion "{suap-project-version}"
-VIAddVersionKey "ProductName" "{suap-project-name}"
+VIAddVersionKey "ProductName" "{suap-display-name}"
 VIAddVersionKey "FileDescription" "{suap-project-description}"
 VIAddVersionKey "FileVersion" "{suap-project-version}"
 
@@ -33,7 +29,7 @@ Section "MainSection"
     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-project-name}"
+    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"
@@ -45,5 +41,7 @@ Section "Uninstall"
     Delete "$INSTDIR\uninstall.exe"
     RMDir "$INSTDIR"
 
+    Delete "$DESKTOP\{suap-project-name}.lnk"
+
     DeleteRegKey HKLM "Software\Microsoft\Windows\CurrentVersion\Uninstall\{suap-project-name}"
 SectionEnd

ty.toml

@@ -1,2 +1,2 @@
 [rules]
-missing-typed-dict-key = "ignore"
+# missing-typed-dict-key = "ignore"