UPM release 3.1.0

git-upm-publisher · starikcetin · commit a66a2df2af03 · 2023-07-08T16:21:25.000+03:00
diff --git a/.assets/settings.png b/.assets/settings.png
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -19,6 +19,16 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 
 
 
+## [3.1.0] - 2023-07-08
+
+### Added
+- Log level of the editor logger can now be controlled with the new setting `Logging/Editor Log Level`.
+
+### Removed
+- Removed the suggestion to output generated files as indented for source control reasons. This is because we are suggesting to ignore the generated files.
+
+
+
 ## [3.0.0] - 2023-07-07
 
 This release introduces support for addressable scenes.
diff --git a/Editor/EditorLogger.cs b/Editor/EditorLogger.cs
@@ -0,0 +1,32 @@
+﻿namespace Eflatun.SceneReference.Editor
+{
+    /// <summary>
+    /// Logger for editor code.
+    /// </summary>
+    internal static class EditorLogger
+    {
+        public static void Debug(string msg)
+        {
+            if (SettingsManager.Logging.EditorLogLevel.value <= LogLevel.Debug)
+            {
+                UnityEngine.Debug.Log($"{Constants.LogPrefixBase} {msg}");
+            }
+        }
+
+        public static void Warn(string msg)
+        {
+            if (SettingsManager.Logging.EditorLogLevel.value <= LogLevel.Warning)
+            {
+                UnityEngine.Debug.LogWarning($"{Constants.LogPrefixBase} {msg}");
+            }
+        }
+
+        public static void Error(string msg)
+        {
+            if (SettingsManager.Logging.EditorLogLevel.value <= LogLevel.Error)
+            {
+                UnityEngine.Debug.LogError($"{Constants.LogPrefixBase} {msg}");
+            }
+        }
+    }
+}
diff --git a/Editor/EditorLogger.cs.meta b/Editor/EditorLogger.cs.meta
diff --git a/Editor/MapGeneratorTriggers/AddressablesChangeListener.cs b/Editor/MapGeneratorTriggers/AddressablesChangeListener.cs
@@ -28,7 +28,7 @@ private static void OnAddressablesChange(AddressableAssetSettings s, Addressable
                 }
                 else
                 {
-                    Logger.Warn($"Skipping scene data maps generation after addressables changes. It is recommended to enable map generation after addressables changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                    EditorLogger.Warn($"Skipping scene data maps generation after addressables changes. It is recommended to enable map generation after addressables changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
                 }
             }
         }
diff --git a/Editor/MapGeneratorTriggers/BuildPreProcessor.cs b/Editor/MapGeneratorTriggers/BuildPreProcessor.cs
@@ -12,7 +12,7 @@ public void OnPreprocessBuild(BuildReport report)
         {
             if (!SettingsManager.SceneDataMaps.IsGenerationTriggerEnabled(SceneDataMapsGeneratorTriggers.BeforeBuild))
             {
-                Logger.Warn($"Skipping scene data maps generation before build. It is recommended to enable map generation before build, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                EditorLogger.Warn($"Skipping scene data maps generation before build. It is recommended to enable map generation before build, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
 
                 return;
             }
@@ -25,13 +25,13 @@ public void OnPreprocessBuild(BuildReport report)
             {
                 if (SettingsManager.SceneDataMaps.FailBuildIfGenerationFails.value)
                 {
-                    Logger.Error($"Failing the build due to failure during scene data maps generation. It is recommended to keep this behaviour enabled, as a failed map generation can result in broken scene references in runtime. However, if you know what you are doing, you can disable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                    EditorLogger.Error($"Failing the build due to failure during scene data maps generation. It is recommended to keep this behaviour enabled, as a failed map generation can result in broken scene references in runtime. However, if you know what you are doing, you can disable it in {SettingsManager.SettingsMenuPathForDisplay}.");
 
                     // Only a BuildFailedException fails the build, so wrapping the original exception.
                     throw new BuildFailedException(ex);
                 }
 
-                Logger.Error($"Scene data maps generation failed, but not failing the build. It is recommended to enable failing the build if the map generation fails, as a failed map generation can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                EditorLogger.Error($"Scene data maps generation failed, but not failing the build. It is recommended to enable failing the build if the map generation fails, as a failed map generation can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
 
                 // Only a BuildFailedException fails the build, therefore rethrowing does not.
                 throw;
diff --git a/Editor/MapGeneratorTriggers/PackagesChangeListener.cs b/Editor/MapGeneratorTriggers/PackagesChangeListener.cs
@@ -21,7 +21,7 @@ private static void OnRegisteredPackages(PackageRegistrationEventArgs obj)
             }
             else
             {
-                Logger.Warn($"Skipping scene data maps generation after packages resolve. It is recommended to enable map generation after packages resolve, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                EditorLogger.Warn($"Skipping scene data maps generation after packages resolve. It is recommended to enable map generation after packages resolve, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
             }
         }
     }
diff --git a/Editor/MapGeneratorTriggers/PlayModeListener.cs b/Editor/MapGeneratorTriggers/PlayModeListener.cs
@@ -23,7 +23,7 @@ private static void EditorApplication_OnPlayModeStateChanged(PlayModeStateChange
                     // DESIGN: If 'Clear On Play' is enabled, this will get cleared before user gets a chance to see 
                     // it. It is easy to fix: just log in EnteredPlayMode. But that is overengineering and I don't want
                     // to do it.
-                    Logger.Warn($"Skipping scene data maps generation before play mode. It is recommended to enable map generation before play mode, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                    EditorLogger.Warn($"Skipping scene data maps generation before play mode. It is recommended to enable map generation before play mode, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
                 }
             }
         }
diff --git a/Editor/MapGeneratorTriggers/SceneAssetPostprocessor.cs b/Editor/MapGeneratorTriggers/SceneAssetPostprocessor.cs
@@ -22,7 +22,7 @@ private static void OnPostprocessAllAssets(string[] importedAssets, string[] del
                 }
                 else
                 {
-                    Logger.Warn($"Skipping scene data maps generation after scene asset changes. It is recommended to enable map generation after scene asset changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
+                    EditorLogger.Warn($"Skipping scene data maps generation after scene asset changes. It is recommended to enable map generation after scene asset changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");
                 }
             }
         }
diff --git a/Editor/SceneDataMapsGenerator.cs b/Editor/SceneDataMapsGenerator.cs
@@ -30,7 +30,7 @@ public static void Run()
         {
             try
             {
-                Logger.Debug("Generating scene data maps.");
+                EditorLogger.Debug("Generating scene data maps.");
 
                 WriteScaffolding();
 
diff --git a/Editor/SettingsManager.cs b/Editor/SettingsManager.cs
@@ -66,10 +66,10 @@ public static class SceneDataMaps
 
             /// <summary>
             /// Controls the Scene Data Maps Generator's JSON formatting.<br/>
-            /// It is recommended to leave this option at <c>Indented</c>, as it will help with version control and make the generated files human-readable.
+            /// It is recommended to leave this option at <c>Indented</c> as it will make the generated files human-readable.
             /// </summary>
             /// <remarks><inheritdoc cref="SettingsManager"/></remarks>
-            [field: UserSetting(CategoryName, "JSON Formatting", "Controls the Scene Data Maps Generator's JSON formatting.\n\nIt is recommended to leave this option at _Indented_, as it will help with version control and make the generated files human-readable.")]
+            [field: UserSetting(CategoryName, "JSON Formatting", "Controls the Scene Data Maps Generator's JSON formatting.\n\nIt is recommended to leave this option at 'Indented' as it will make the generated files human-readable.")]
             public static ProjectSetting<Formatting> JsonFormatting { get; }
                 = new ProjectSetting<Formatting>("SceneDataMaps.JsonFormatting", Formatting.Indented);
 
@@ -79,7 +79,7 @@ public static class SceneDataMaps
             /// It is recommended to leave this option at <c>true</c>, as a failed map generation can result in broken scene references in runtime.
             /// </summary>
             /// <remarks><inheritdoc cref="SettingsManager"/></remarks>
-            [field: UserSetting(CategoryName, "Fail Build If Generation Fails", "Should we fail a build if scene data maps generation fails?\n\nOnly relevant if 'Before Build' generation trigger is enabled.\n\nIt is recommended to leave this option at _true_, as a failed map generation can result in broken scene references in runtime.")]
+            [field: UserSetting(CategoryName, "Fail Build If Generation Fails", "Should we fail a build if scene data maps generation fails?\n\nOnly relevant if 'Before Build' generation trigger is enabled.\n\nIt is recommended to leave this option at 'true', as a failed map generation can result in broken scene references in runtime.")]
             public static ProjectSetting<bool> FailBuildIfGenerationFails { get; }
                 = new ProjectSetting<bool>("SceneDataMaps.FailBuildIfGenerationFails", true);
 
@@ -117,7 +117,7 @@ public static class PropertyDrawer
             /// It is recommended to leave this option at 'true', as it will help you identify many potential runtime errors.
             /// </summary>
             /// <remarks>
-            /// This setting does not apply to addressable scenes. They have their own coloring mechanism. It is controlled by the _Color Addressable Scenes_ setting under the _Addressables Support_ category.<br/>
+            /// This setting does not apply to addressable scenes. They have their own coloring mechanism. It is controlled by the <see cref="AddressablesSupport.ColorAddressableScenes"/> setting under the <see cref="AddressablesSupport"/> category.<br/>
             /// <inheritdoc cref="SettingsManager"/>
             /// </remarks>
             [field: UserSetting(CategoryName, "Color Based On Scene-In-Build State", "Should we color the property to draw attention for scenes that are either not in build or disabled in build?\n\nUnity only bundles scenes that are added and enabled in build settings. Therefore, you would want to validate whether the scene you assign to a SceneReference is added and enabled in build settings.\n\nIt is recommended to leave this option at 'true', as it will help you identify many potential runtime errors.\n\nNote: This setting does not apply to addressable scenes. They have their own coloring mechanism. It is controlled by the 'Color Addressable Scenes' setting under the 'Addressables Support' category.")]
@@ -143,7 +143,7 @@ public static class AddressablesSupport
             /// It is recommended to leave this option at <c>true</c>, as it will help you easily distinguish addressable scenes.
             /// </summary>
             /// <remarks>
-            /// This setting does not apply to regular scenes. They have their own coloring mechanism. It is controlled by the _Color Based On Scene-In-Build State_ setting under the _Property Drawer_ category.<br/>
+            /// This setting does not apply to regular scenes. They have their own coloring mechanism. It is controlled by the <see cref="PropertyDrawer.ColorBasedOnSceneInBuildState"/> setting under the <see cref="PropertyDrawer"/> category.<br/>
             /// <inheritdoc cref="SettingsManager"/>
             /// </remarks>
             [field: UserSetting(CategoryName, "Color Addressable Scenes", "Should we color the property to draw attention for addressable scenes?\n\nAddressable scenes should be handled differently than regular scenes in runtime, through the addressables API. Therefore, you would want quickly identify if a SceneReference references an addressable scene or not.\n\nIt is recommended to leave this option at 'true', as it will help you easily distinguish addressable scenes.\n\nNote: This setting does not apply to regular scenes. They have their own coloring mechanism. It is controlled by the 'Color Based On Scene-In-Build State' setting under the 'Property Drawer' category.")]
@@ -163,5 +163,29 @@ private static void Draw(string searchContext)
                 }
             }
         }
+
+        /// <summary>
+        /// Settings regarding logging.
+        /// </summary>
+        /// <remarks>
+        /// Exceptions will always be logged.<p/>
+        /// <inheritdoc cref="SettingsManager"/>
+        /// </remarks>
+        [PublicAPI]
+        public static class Logging
+        {
+            private const string CategoryName = "Logging";
+
+            /// <summary>
+            /// Log level for the editor logger. It is recommended to leave this at <see cref="LogLevel.Debug"/>.
+            /// </summary>
+            /// <remarks>
+            /// Exceptions will always be logged.<p/>
+            /// <inheritdoc cref="SettingsManager"/>
+            /// </remarks>
+            [field: UserSetting(CategoryName, "Editor Log Level", "Log level for the editor logger. It is recommended to leave this at 'Debug'.")]
+            public static ProjectSetting<LogLevel> EditorLogLevel { get; }
+                = new ProjectSetting<LogLevel>("Logging.EditorLogLevel", LogLevel.Debug);
+        }
     }
 }
diff --git a/README.md b/README.md
@@ -46,13 +46,13 @@ openupm add com.eflatun.scenereference
 
 ### With Git URL
 
-Add the following line to the `dependencies` section of your project's `manifest.json` file. Replace `3.0.0` with the version you want to install.
+Add the following line to the `dependencies` section of your project's `manifest.json` file. Replace `3.1.0` with the version you want to install.
 
 ```json
-"com.eflatun.scenereference": "git+https://github.com/starikcetin/Eflatun.SceneReference.git#3.0.0"
+"com.eflatun.scenereference": "git+https://github.com/starikcetin/Eflatun.SceneReference.git#3.1.0"
 ```
 
-_Although it is highly discouraged, you can replace `3.0.0` with `upm` to get the latest version instead of a specific one._
+_Although it is highly discouraged, you can replace `3.1.0` with `upm` to get the latest version instead of a specific one._
 
 ## Ignore Auto-Generated Map Files in Version Control
 
@@ -217,6 +217,17 @@ It is recommended to leave this option at 'true', as it will help you easily dis
 > **Note**<br/>
 > This setting does not apply to regular scenes. They have their own coloring mechanism. It is controlled by the _Color Based On Scene-In-Build State_ setting under the _Property Drawer_ category.
 
+## Logging
+
+Settings regarding logging.
+
+> **Note**<br/>
+> Exceptions will always be logged.
+
+### Editor Log Level
+
+Log level for the editor logger. It is recommended to leave this at `Debug`.
+
 ## Property Drawer
 
 Settings regarding the property drawer.
@@ -267,7 +278,7 @@ It is recommended that you leave this option at _All_ unless you are debugging s
 
 Controls the Scene Data Maps Generator's JSON formatting.
 
-It is recommended to leave this option at _Indented_, as it will help with version control and make the generated files human-readable.
+It is recommended to leave this option at _Indented_ as it will make the generated files human-readable.
 
 ### Fail Build If Generation Fails
 
diff --git a/Runtime/LogLevel.cs b/Runtime/LogLevel.cs
@@ -0,0 +1,34 @@
+﻿// NOTE: This file is placed in the runtime assembly to make sure we don't need to introduce a breaking change in case
+// we implement log levels for the runtime logger in the future.
+
+using JetBrains.Annotations;
+
+namespace Eflatun.SceneReference
+{
+    /// <summary>
+    /// Determines which types of logs are printed to the console.
+    /// </summary>
+    [PublicAPI]
+    public enum LogLevel
+    {
+        /// <summary>
+        /// All logs.
+        /// </summary>
+        Debug = 10,
+
+        /// <summary>
+        /// Warnings and errors.
+        /// </summary>
+        Warning = 20,
+
+        /// <summary>
+        /// Only errors.
+        /// </summary>
+        Error = 30,
+
+        /// <summary>
+        /// None.
+        /// </summary>
+        Silent = 40,
+    }
+}
diff --git a/Runtime/LogLevel.cs.meta b/Runtime/LogLevel.cs.meta
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
 	"name": "com.eflatun.scenereference",
-	"version": "3.0.0",
+	"version": "3.1.0",
 	"displayName": "Eflatun.SceneReference",
 	"description": "Scene References for Runtime and Editor. Strongly typed, robust, and reliable. Provides Asset GUID, Scene Path, Build Index, and Scene Name.\nhttps://github.com/starikcetin/Eflatun.SceneReference",
 	"documentationUrl": "https://github.com/starikcetin/Eflatun.SceneReference/blob/main/README.md",

Original file line number	Diff line number	Diff line change
`@@ -28,7 +28,7 @@ private static void OnAddressablesChange(AddressableAssetSettings s, Addressable`
`28`	`28`	`}`
`29`	`29`	`else`
`30`	`30`	`{`
`31`		`- Logger.Warn($"Skipping scene data maps generation after addressables changes. It is recommended to enable map generation after addressables changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`31`	`+ EditorLogger.Warn($"Skipping scene data maps generation after addressables changes. It is recommended to enable map generation after addressables changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`32`	`32`	`}`
`33`	`33`	`}`
`34`	`34`	`}`
Original file line number	Diff line number	Diff line change
`@@ -12,7 +12,7 @@ public void OnPreprocessBuild(BuildReport report)`
`12`	`12`	`{`
`13`	`13`	`if (!SettingsManager.SceneDataMaps.IsGenerationTriggerEnabled(SceneDataMapsGeneratorTriggers.BeforeBuild))`
`14`	`14`	`{`
`15`		`- Logger.Warn($"Skipping scene data maps generation before build. It is recommended to enable map generation before build, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`15`	`+ EditorLogger.Warn($"Skipping scene data maps generation before build. It is recommended to enable map generation before build, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`16`	`16`
`17`	`17`	`return;`
`18`	`18`	`}`
`@@ -25,13 +25,13 @@ public void OnPreprocessBuild(BuildReport report)`
`25`	`25`	`{`
`26`	`26`	`if (SettingsManager.SceneDataMaps.FailBuildIfGenerationFails.value)`
`27`	`27`	`{`
`28`		`- Logger.Error($"Failing the build due to failure during scene data maps generation. It is recommended to keep this behaviour enabled, as a failed map generation can result in broken scene references in runtime. However, if you know what you are doing, you can disable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`28`	`+ EditorLogger.Error($"Failing the build due to failure during scene data maps generation. It is recommended to keep this behaviour enabled, as a failed map generation can result in broken scene references in runtime. However, if you know what you are doing, you can disable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`29`	`29`
`30`	`30`	`// Only a BuildFailedException fails the build, so wrapping the original exception.`
`31`	`31`	`throw new BuildFailedException(ex);`
`32`	`32`	`}`
`33`	`33`
`34`		`- Logger.Error($"Scene data maps generation failed, but not failing the build. It is recommended to enable failing the build if the map generation fails, as a failed map generation can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`34`	`+ EditorLogger.Error($"Scene data maps generation failed, but not failing the build. It is recommended to enable failing the build if the map generation fails, as a failed map generation can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`35`	`35`
`36`	`36`	`// Only a BuildFailedException fails the build, therefore rethrowing does not.`
`37`	`37`	`throw;`
Original file line number	Diff line number	Diff line change
`@@ -21,7 +21,7 @@ private static void OnRegisteredPackages(PackageRegistrationEventArgs obj)`
`21`	`21`	`}`
`22`	`22`	`else`
`23`	`23`	`{`
`24`		`- Logger.Warn($"Skipping scene data maps generation after packages resolve. It is recommended to enable map generation after packages resolve, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`24`	`+ EditorLogger.Warn($"Skipping scene data maps generation after packages resolve. It is recommended to enable map generation after packages resolve, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`25`	`25`	`}`
`26`	`26`	`}`
`27`	`27`	`}`
Original file line number	Diff line number	Diff line change
`@@ -23,7 +23,7 @@ private static void EditorApplication_OnPlayModeStateChanged(PlayModeStateChange`
`23`	`23`	`// DESIGN: If 'Clear On Play' is enabled, this will get cleared before user gets a chance to see`
`24`	`24`	`// it. It is easy to fix: just log in EnteredPlayMode. But that is overengineering and I don't want`
`25`	`25`	`// to do it.`
`26`		`- Logger.Warn($"Skipping scene data maps generation before play mode. It is recommended to enable map generation before play mode, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`26`	`+ EditorLogger.Warn($"Skipping scene data maps generation before play mode. It is recommended to enable map generation before play mode, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`27`	`27`	`}`
`28`	`28`	`}`
`29`	`29`	`}`
Original file line number	Diff line number	Diff line change
`@@ -22,7 +22,7 @@ private static void OnPostprocessAllAssets(string[] importedAssets, string[] del`
`22`	`22`	`}`
`23`	`23`	`else`
`24`	`24`	`{`
`25`		`- Logger.Warn($"Skipping scene data maps generation after scene asset changes. It is recommended to enable map generation after scene asset changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
	`25`	`+ EditorLogger.Warn($"Skipping scene data maps generation after scene asset changes. It is recommended to enable map generation after scene asset changes, as an outdated map can result in broken scene references in runtime. You can enable it in {SettingsManager.SettingsMenuPathForDisplay}.");`
`26`	`26`	`}`
`27`	`27`	`}`
`28`	`28`	`}`
Original file line number	Diff line number	Diff line change
`@@ -30,7 +30,7 @@ public static void Run()`
`30`	`30`	`{`
`31`	`31`	`try`
`32`	`32`	`{`
`33`		`- Logger.Debug("Generating scene data maps.");`
	`33`	`+ EditorLogger.Debug("Generating scene data maps.");`
`34`	`34`
`35`	`35`	`WriteScaffolding();`
`36`	`36`