Improve user experience with better manifest errors messages

.github/workflows/ci-macos.yml

@@ -15,7 +15,7 @@ jobs:
   build:
     name: CI on macOS
 
-    runs-on: macos-latest
+    runs-on: macos-10.15
 
     steps:
     - name: Check out repository

.github/workflows/ci-toolchain.yml

@@ -21,7 +21,7 @@ jobs:
     strategy:
       matrix:
         os: 
-          - macos-latest
+          - macos-10.15
           - ubuntu-latest
           - windows-latest
 

src/alire/alire-conditional_trees-toml_load.adb

@@ -67,11 +67,13 @@ package body Alire.Conditional_Trees.TOML_Load is
                      then
                         if Strict then
                            Case_Table.Recoverable_Error
-                             ("invalid enumeration value: " & Item_Key);
+                             ("invalid enumeration value: '" & Item_Key &
+                                "'." & Map.Base.Suggestion (Item_Key));
                         else
                            Trace.Debug
                              (Errors.Stack
-                                ("unknown enumeration value: " & Item_Key));
+                                ("unknown enumeration value: " & Item_Key &
+                                   "'." & Map.Base.Suggestion (Item_Key)));
                         end if;
                      end if;
                   end loop;

src/alire/alire-expressions-enums.adb

@@ -10,6 +10,14 @@ package body Alire.Expressions.Enums is
    function Is_Valid (This : Enum_Values; Image : String) return Boolean
    is (This.Values.Contains (TOML_Adapters.Tomify (Image)));
 
+   overriding
+   function Possible_Values (This : Enum_Values) return AAA.Strings.Vector is
+      Result : AAA.Strings.Vector;
+   begin
+      Result.Prepend (This.Values);
+      return Result;
+   end Possible_Values;
+
 begin
    declare
       Values : Enum_Values;

src/alire/alire-expressions.adb

@@ -3,6 +3,7 @@ with Ada.Containers.Indefinite_Ordered_Maps;
 with Alire.Errors;
 with Alire.TOML_Adapters;
 with Alire.Utils;
+with Alire.Utils.Did_You_Mean;
 
 package body Alire.Expressions is
 
@@ -43,6 +44,16 @@ package body Alire.Expressions is
              Key_Variables_Image (Variables) & ")")
        else Variable_Values (Key (This)).Is_Valid (Value));
 
+   ----------------
+   -- Suggestion --
+   ----------------
+
+   function Suggestion (This : Variable; Value : String) return String is
+   begin
+      return Utils.Did_You_Mean.Suggestion
+        (Value, Variable_Values (Key (This)).Possible_Values);
+   end Suggestion;
+
    -----------------------
    -- Register_Variable --
    -----------------------

src/alire/alire-expressions.ads

@@ -21,6 +21,9 @@ package Alire.Expressions with Preelaborate is
    function Is_Valid (This : Variable; Value : String) return Boolean;
    --  Says if Value is among the values in This
 
+   function Suggestion (This : Variable; Value : String) return String;
+   --  Return a " Did you mean?" message for a given invalid value
+
    function Key (This : Variable) return String;
    --  The key that is used in TOML files for this variable
 
@@ -58,6 +61,8 @@ private
    function Is_Valid (V : Values; Image : String) return Boolean is abstract;
    --  Say if a value, given as its string image, matches a value of a type
 
+   function Possible_Values (V : Values) return AAA.Strings.Vector is abstract;
+
    procedure Register (Var_Key    : String;
                        Var_Name   : String;
                        Var_Values : Values'Class);

src/alire/alire-properties-actions-runners.adb

@@ -1,4 +1,5 @@
 with AAA.Enum_Tools;
+with Alire.Utils.Did_You_Mean;
 
 package body Alire.Properties.Actions.Runners is
 
@@ -61,6 +62,11 @@ package body Alire.Properties.Actions.Runners is
          Moment   : Moments;
 
          function Is_Valid is new AAA.Enum_Tools.Is_Valid (Moments);
+
+         function Suggestion
+         is new Utils.Did_You_Mean.Enum_Suggestion
+           (Moments, Utils.Did_You_Mean.Tomify);
+
       begin
          if not From.Pop (TOML_Keys.Action_Type, Kind) then
             From.Checked_Error ("action type missing");
@@ -81,7 +87,8 @@ package body Alire.Properties.Actions.Runners is
          end if;
 
          if not Is_Valid (TOML_Adapters.Adafy (Kind.As_String)) then
-            From.Checked_Error ("action type is invalid: " & Kind.As_String);
+            From.Checked_Error ("action type is invalid: '" & Kind.As_String &
+                               "'." & Suggestion (Kind.As_String));
          else
             Moment := Moments'Value (TOML_Adapters.Adafy (Kind.As_String));
          end if;

src/alire/alire-properties-build_profiles.adb

@@ -1,9 +1,32 @@
 with Alire.TOML_Keys;
 
 with Alire.Utils.Switches; use Alire.Utils.Switches;
+with Alire.Utils.Did_You_Mean;
 
 package body Alire.Properties.Build_Profiles is
 
+   function Profile_Kind_Suggestion
+   is new Utils.Did_You_Mean.Enum_Suggestion
+     (Profile_Kind, Utils.Did_You_Mean.Lower_Case);
+
+   -----------------------
+   -- Check_Profile_Str --
+   -----------------------
+
+   procedure Check_Profile_Str (From : TOML_Adapters.Key_Queue;
+                                Str, Crate_Str : String)
+   is
+      Unused : Profile_Kind;
+   begin
+      Unused := Profile_Kind'Value (Str);
+   exception
+      when Constraint_Error =>
+         From.Checked_Error
+           ("Invalid build profile name: '" & Str
+            & "' for '" & Crate_Str & "'." &
+              Profile_Kind_Suggestion (Str));
+   end Check_Profile_Str;
+
    -----------
    -- Image --
    -----------
@@ -72,6 +95,7 @@ package body Alire.Properties.Build_Profiles is
                        ("Multiple definition of wildcard (""*"")" &
                           " build profile");
                   else
+                     Check_Profile_Str (From, Profile_Str, Crate_Str);
                      Var.Wildcard_Found := True;
                   end if;
 
@@ -81,16 +105,8 @@ package body Alire.Properties.Build_Profiles is
                        Error_In_Name (Crate_Str) & ")");
                else
 
-                  declare
-                     Unused : Profile_Kind;
-                  begin
-                     Unused := Profile_Kind'Value (Profile_Str);
-                  exception
-                     when Constraint_Error =>
-                        From.Checked_Error
-                          ("Invalid build profile name: '" & Profile_Str
-                           & "' for '" & Crate_Str & "'");
-                  end;
+                  Check_Profile_Str (From, Profile_Str, Crate_Str);
+
                end if;
             end;