Skip to content

nexusmods-app: add a warning about its experimental state #344251

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
MattSturgeon wants to merge 1 commit into from
Closed

nexusmods-app: add a warning about its experimental state #344251

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 21 additions & 1 deletion pkgs/by-name/ne/nexusmods-app/package.nix
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,28 @@
lib,
runCommand,
pname ? "nexusmods-app",
iKnowItsExperimental ? false,
}:
buildDotnetModule (finalAttrs: {
let
# TODO: Remove this warning once upstream stabilises
warningText = ''
`${pname}` is currently in an unstable and experimental state.
In particular, you will usually need to wipe its config & reset any modded games whenever this package updates.
This can normally be done by running `NexusMods.App uninstall-app` before updating.

See the upstream FAQ for more detail:
https://nexus-mods.github.io/NexusMods.App/users/faq/#why-do-i-have-to-uninstall-everything-to-update-the-app

Note: You can silence this warning by overriding the package:
pkgs.${pname}.override {
iKnowItsExperimental = true;
}
'';

# Use a wrapper to avoid unnecessary indentation changes when we eventually remove the warning
withWarning = fn: arg: lib.warnIfNot iKnowItsExperimental warningText (fn arg);
in
withWarning buildDotnetModule (finalAttrs: {
inherit pname;
version = "0.4.1";

Expand Down