From df0e2060c6cd3471fb1964b99b8dc5bacd36c10e Mon Sep 17 00:00:00 2001
From: Noah765 <noland62007@gmail.com>
Date: Fri, 18 Apr 2025 17:05:57 +0200
Subject: [PATCH] languages/dart: add flutter-tools.flutterPackage option

Previously, flutter-tools was dependent on the flutter SDK, which it found in the PATH. Having such undeclared and non-reproducible dependencies is against the principles of nix.
The flutterPackage option has been made optional for people who have installed the flutter SDK differently and want to keep it that way.
The enableNoResolvePatch option has been retained for people who have installed the flutter SDK using nix outside the scope of nvf and do not want to have to install it twice. The default value has been changed to false, assuming that most people who use nix to install flutter will use the flutterPackage option instead.
---
 docs/release-notes/rl-0.8.md       |  3 ++-
 modules/plugins/languages/dart.nix | 16 ++++++++++++----
 2 files changed, 14 insertions(+), 5 deletions(-)

diff --git a/docs/release-notes/rl-0.8.md b/docs/release-notes/rl-0.8.md
index f17ca59e..312b1896 100644
--- a/docs/release-notes/rl-0.8.md
+++ b/docs/release-notes/rl-0.8.md
@@ -332,4 +332,5 @@
 [Noah765](https://github.com/Noah765):
 
 - Add missing `flutter-tools.nvim` dependency `plenary.nvim`.
-- Add necessary dependency of `flutter-tools.nvim` on lsp
+- Add necessary dependency of `flutter-tools.nvim` on lsp.
+- Add the `vim.languages.dart.flutter-tools.flutterPackage` option.
diff --git a/modules/plugins/languages/dart.nix b/modules/plugins/languages/dart.nix
index b3747099..b61585d4 100644
--- a/modules/plugins/languages/dart.nix
+++ b/modules/plugins/languages/dart.nix
@@ -81,16 +81,23 @@ in {
         description = "Enable flutter-tools for flutter support";
       };
 
+      flutterPackage = mkOption {
+        type = nullOr package;
+        default = pkgs.flutter;
+        description = "Flutter package, or null to detect the flutter path at runtime instead.";
+      };
+
       enableNoResolvePatch = mkOption {
         type = bool;
-        default = true;
+        default = false;
         description = ''
           Whether to patch flutter-tools so that it doesn't resolve
           symlinks when detecting flutter path.
 
-          This is required if you want to use a flutter package built with nix.
-          If you are using a flutter SDK installed from a different source
-          and encounter the error "`dart` missing from PATH", disable this option.
+          This is required if flutterPackage is set to null and the flutter
+          package in your PATH was built with nix. If you are using a flutter
+          SDK installed from a different source and encounter the error "`dart`
+          missing from PATH", leave this option disabled.
         '';
       };
 
@@ -147,6 +154,7 @@ in {
 
       pluginRC.flutter-tools = entryAfter ["lsp-setup"] ''
         require('flutter-tools').setup {
+          ${optionalString (ftcfg.flutterPackage != null) "flutter_path = \"${ftcfg.flutterPackage}/bin/flutter\","}
           lsp = {
             color = { -- show the derived colours for dart variables
               enabled = ${boolToString ftcfg.color.enable}, -- whether or not to highlight color variables at all, only supported on flutter >= 2.10