Merge branch 'feature/add-qol-fixes' into develop

András Kurai · András Kurai · commit 05c7a0eb6158 · 2021-10-14T15:47:10.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -1,6 +1,11 @@
-# 0.1.1
+# 0.2.0
 - Add documentation website
-- Reference website in `package.json`
+- Reference documentation in `package.json`
+- Make using namespaces optional
+- Configure using directives
+- Remove `IsResource` property from `IResourceData`. Scene path generation now depends on file extension
+- Handle spaces in filenames
+- Add known issues and update guide in the documentation
 
 # 0.1.0
 - Add initial project
diff --git a/Documentation/articles/Customization.md b/Documentation/articles/Customization.md
@@ -27,6 +27,9 @@ The data section describes the automatically generated file mappings. The data i
 
 The default mappings are created from the [Unity documentation](https://docs.unity3d.com/Manual/BuiltInImporters.html). If you know of any valid file mapping that the documentation does not state, please fork and create a Pull Request, or create an [Issue](https://github.com/AutSoft/UnityResourceGenerator/issues/new).
 
+> [!WARNING]
+> Scenes have special handling during the file generation, because of the way scenes paths are used by the SceneManager. Scenes are identified by the file ending `.unity`
+
 ## Extending the generated classes
 
 The generated classes are `partial` by default. This means that if you want to add custom methods, simply create another `partial` class and add your code there.
diff --git a/Documentation/articles/Extensibility.md b/Documentation/articles/Extensibility.md
@@ -11,3 +11,7 @@ A module is single string that is placed inside the main generated class. To cre
 A post processor is a piece of code that is run after all modules are produced, and the final file text is created. To create a post processor implement the [IResourcePostProcessor](xref:AutSoft.UnityResourceGenerator.Editor.Generation.IResourcePostProcessor) interface. The implementation must provide a parameterless constructor.
 
 The input of the processor is the current state of the generated file and it returns the new state of the generated file. Post processors also provide a Priority property which determines the ordering of them.
+
+## Using directives
+
+The generated using directives are also customizable under the settings window. If your custom generated code will require other using directives, there is no need to generate them, simply add them in the settings
diff --git a/Documentation/articles/KnownIssues.md b/Documentation/articles/KnownIssues.md
@@ -0,0 +1,16 @@
+# Known issues
+
+## 0.1.0 - *
+
+- SpecialCharacters can break generated names.
+  - Numbers at the end of the files are supported, but not at the start
+  - Any character in the filename which would not be a valid C# filed/property/method name will break the generated code
+  - Spaces get removed
+  - For Example:
+    - `Coin1` works
+    - `Coin 1` works
+    - `1Coin` does not
+    - `!Coin` does not
+    - `Coin!` does not
+
+- Duplicate file names in the same class module will break the generated file. The solution for this requires further investigation
diff --git a/Documentation/articles/UpgradeGuide.md b/Documentation/articles/UpgradeGuide.md
@@ -0,0 +1,6 @@
+# Upgrade Guide
+
+Always update using the Unity Package Manager
+
+## 0.1.0 - *
+- If default file mappings or namespaces change, and you have custom ones, it is advised that you create a copy of your old settings, press the `Reset file mappings` button in the `Project Settings` window and then manually recreate your custom mappings.
diff --git a/Documentation/articles/toc.yml b/Documentation/articles/toc.yml
@@ -4,3 +4,7 @@
   href: Customization.md
 - name: Extensibility
   href: Extensibility.md
+- name: Known Issues
+  href: KnownIssues.md
+- name: Upgrade Guide
+  href: UpgradeGuide.md
diff --git a/Documentation/images/Customization/DefaultSettings.png b/Documentation/images/Customization/DefaultSettings.png
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/ResourcePaths.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/ResourcePaths.cs
@@ -31,7 +31,7 @@ public static partial class Materials
         }
         public static partial class AudioClips
         {
-            public const string CoinSpin = "CoinSpin";
+            public const string CoinSpin = "Coin Spin";
             public static AudioClip LoadCoinSpin() => Resources.Load<AudioClip>(CoinSpin);
             public const string Coin = "Coin";
             public static AudioClip LoadCoin() => Resources.Load<AudioClip>(Coin);
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/Resources/Coin Spin.mp3 b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/Resources/Coin Spin.mp3
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/Resources/Coin Spin.mp3.meta b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/Resources/Coin Spin.mp3.meta
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/IResourceData.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/IResourceData.cs
@@ -6,7 +6,6 @@ public interface IResourceData
     {
         string ClassName { get; }
         IReadOnlyList<string> FileExtensions { get; }
-        bool IsResource { get; }
         string DataType { get; }
     }
 }
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/Modules/AllResources.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/Modules/AllResources.cs
@@ -32,8 +32,8 @@ public static partial class {data.ClassName}
                 .SelectMany(ext => Directory.EnumerateFiles(context.AssetsFolder, ext, SearchOption.AllDirectories))
                 .Select(filePath =>
                 {
-                    var (canLoad, baseFolder) = GetBaseFolder(filePath, data.IsResource, context);
-                    if (!canLoad) return (null, null);
+                    var (canLoad, baseFolder) = GetBaseFolder(filePath, context, data);
+                    if (!canLoad) return (null, null, null);
 
                     var resourcePath = filePath
                         .Replace(baseFolder, string.Empty)
@@ -46,10 +46,12 @@ public static partial class {data.ClassName}
                             Path.GetFileNameWithoutExtension(resourcePath)
                         )
                         .Replace('\\', '/');
+
                     return
                     (
-                        name: Path.GetFileNameWithoutExtension(filePath),
-                        path: resourcePath
+                        name: Path.GetFileNameWithoutExtension(filePath).Replace(" ", string.Empty),
+                        path: resourcePath,
+                        fileExtension: Path.GetExtension(filePath)
                     );
                 })
                 .Where(p => p.name != null)
@@ -77,7 +79,7 @@ public static partial class {data.ClassName}
                     {
                         sb.Append("            public const string ").Append(s.name).Append(" = \"").Append(s.path).AppendLine("\";");
 
-                        if (data.DataType == "Scene")
+                        if (s.fileExtension == ".unity")
                         {
                             sb.Append("            public static ").Append("void").Append(" Load").Append(s.name).Append("(LoadSceneMode mode = LoadSceneMode.Single) => SceneManager.LoadScene(").Append(s.name).AppendLine(", mode);");
                             sb.Append("            public static ").Append("AsyncOperation").Append(" LoadAsync").Append(s.name).Append("(LoadSceneMode mode = LoadSceneMode.Single) => SceneManager.LoadSceneAsync(").Append(s.name).AppendLine(", mode);");
@@ -99,9 +101,9 @@ public static partial class {data.ClassName}
             void LogFinished() => context.Info($"Finished generating {data.ClassName}");
         }
 
-        private static (bool canLoad, string baseFolder) GetBaseFolder(string filePath, bool isResource, ResourceContext context)
+        private static (bool canLoad, string baseFolder) GetBaseFolder(string filePath, ResourceContext context, IResourceData data)
         {
-            if (!isResource) return (true, context.AssetsFolder);
+            if (Path.GetExtension(filePath) == ".unity") return (true, context.AssetsFolder);
 
             var parents = GetAllParentDirectories(filePath);
             var resourcesFolder = parents.LastOrDefault(p => p.Name == "Resources");
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/ResourceContext.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/ResourceContext.cs
@@ -13,7 +13,8 @@ public ResourceContext
             string className,
             Action<string> info,
             Action<string> error,
-            IReadOnlyList<IResourceData> data)
+            IReadOnlyList<IResourceData> data,
+            IReadOnlyList<string> usings)
         {
             AssetsFolder = assetsFolder;
             FolderPath = folderPath;
@@ -22,6 +23,7 @@ public ResourceContext
             Info = info;
             Error = error;
             Data = data;
+            Usings = usings;
         }
 
         public string AssetsFolder { get; }
@@ -32,5 +34,6 @@ public ResourceContext
         public Action<string> Error { get; }
 
         public IReadOnlyList<IResourceData> Data { get; }
+        public IReadOnlyList<string> Usings { get; }
     }
 }
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/ResourceFileGenerator.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/ResourceFileGenerator.cs
@@ -10,22 +10,28 @@ public static class ResourceFileGenerator
         public static string CreateResourceFile(ResourceContext context)
         {
             // ReSharper disable once MissingIndent
-            const string fileBegin =
+            const string fileBeginHasNamespace =
 @"
-using UnityEngine;
-using UnityEngine.SceneManagement;
-
 namespace {0}
 {
     // ReSharper disable PartialTypeWithSinglePart
     public static partial class {1}
     {";
 
             // ReSharper disable once MissingIndent
-            const string fileEnd =
+            const string fileEndHasNamespace =
 @"    }
 }";
 
+            // ReSharper disable once MissingIndent
+            const string fileBeginNoNamespace =
+@"
+// ReSharper disable PartialTypeWithSinglePart
+public static partial class {1}
+{";
+
+            const string fileEndNoNamespace = "}";
+
             var builder = new StringBuilder();
 
             var allConcreteTypes = AppDomain
@@ -35,18 +41,20 @@ public static partial class {1}
                 .Where(t => !t.IsAbstract && !t.IsGenericType && !t.IsInterface)
                 .ToArray();
 
+            builder.AppendMultipleLines(context.Usings.Select(u => $"using {u};"));
+
             builder.AppendLine(
-                fileBegin
-                    .Replace("{0}", context.BaseNamespace)
-                    .Replace("{1}", context.ClassName));
+                (string.IsNullOrWhiteSpace(context.BaseNamespace) ? fileBeginNoNamespace : fileBeginHasNamespace)
+                .Replace("{0}", context.BaseNamespace)
+                .Replace("{1}", context.ClassName));
 
             allConcreteTypes
                 .Where(t => t.GetInterfaces().Any(i => typeof(IModuleGenerator).IsAssignableFrom(i)))
                 .Select(t => (IModuleGenerator)Activator.CreateInstance(t))
                 .Select(m => m.Generate(context))
                 .ForEach(m => builder.AppendLine(m));
 
-            builder.AppendLine(fileEnd);
+            builder.AppendLine(string.IsNullOrWhiteSpace(context.BaseNamespace) ? fileEndNoNamespace : fileEndHasNamespace);
 
             var fileContent = builder.ToString();
 
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/ResourceFileMenu.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/ResourceFileMenu.cs
@@ -23,7 +23,8 @@ public static void GenerateResources()
                 settings.ClassName,
                 settings.LogInfo ? Debug.Log : LogEmpty,
                 settings.LogError ? Debug.LogError : LogEmpty,
-                settings.Data
+                settings.Data,
+                settings.Usings
             );
 
             context.Info("Resource Path generation started");
diff --git a/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/ResourceGeneratorSettings.cs b/UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/ResourceGeneratorSettings.cs
@@ -14,24 +14,21 @@ public sealed class ResourceData : IResourceData
         {
             [SerializeField] private string _className = default;
             [SerializeField] private string[] _fileExtensions = default;
-            [SerializeField] private bool _isResource = default;
             [SerializeField] private string _dataType = default;
 
             public ResourceData()
             {
             }
 
-            public ResourceData(string className, string[] fileExtensions, bool isResource, string dataType)
+            public ResourceData(string className, string[] fileExtensions, string dataType)
             {
                 _className = className;
                 _fileExtensions = fileExtensions;
-                _isResource = isResource;
                 _dataType = dataType;
             }
 
             public string ClassName => _className;
             public IReadOnlyList<string> FileExtensions => _fileExtensions;
-            public bool IsResource => _isResource;
             public string DataType => _dataType;
         }
 
@@ -46,13 +43,15 @@ public ResourceData(string className, string[] fileExtensions, bool isResource,
 
         [SerializeField] private bool _logInfo;
         [SerializeField] private bool _logError;
+        [SerializeField] private List<string> _usings;
         [SerializeField] private List<ResourceData> _data;
 
         public string FolderPath => _folderPath;
         public string BaseNamespace => _baseNamespace;
         public string ClassName => _className;
         public bool LogInfo => _logInfo;
         public bool LogError => _logError;
+        public IReadOnlyList<string> Usings => _usings;
         public IReadOnlyList<ResourceData> Data => _data;
 
         public static ResourceGeneratorSettings GetOrCreateSettings()
@@ -63,31 +62,41 @@ public static ResourceGeneratorSettings GetOrCreateSettings()
             settings = CreateInstance<ResourceGeneratorSettings>();
 
             settings._folderPath = string.Empty;
-            settings._baseNamespace = "Resources";
+            settings._baseNamespace = string.Empty;
             settings._className = "ResourcePaths";
             settings._logInfo = false;
             settings._logError = true;
 
-            settings._data = CreateDefaultFileMappings();
+            var (data, usings) = CreateDefaultFileMappings();
+
+            settings._data = data;
+            settings._usings = usings;
 
             AssetDatabase.CreateAsset(settings, SettingsPath);
             AssetDatabase.SaveAssets();
 
             return settings;
         }
 
-        private static List<ResourceData> CreateDefaultFileMappings() =>
+        private static (List<ResourceData> data, List<string> usings) CreateDefaultFileMappings() =>
             // https://docs.unity3d.com/Manual/BuiltInImporters.html
-            new List<ResourceData>
-            {
-                new ResourceData("Scenes", new[]{"*.unity"}, false, "Scene"),
-                new ResourceData("Prefabs", new[]{"*.prefab"}, true, "GameObject"),
-                new ResourceData("Materials", new[]{"*.mat"}, true, "Material"),
-                new ResourceData("AudioClips", new[]{"*.ogg", "*.aif", "*.aiff", "*.flac", "*.mp3", "*.mod", "*.it", "*.s3m", "*.xm", "*.wav"}, true, "AudioClip"),
-                new ResourceData("Sprites", new[]{"*.jpg", "*.jpeg", "*.tif", "*.tiff", "*.tga", "*.gif", "*.png", "*.psd", "*.bmp", "*.iff", "*.pict", "*.pic", "*.pct", "*.exr", "*.hdr"}, true, "Sprite"),
-                new ResourceData("TextAssets", new[]{"*.txt", "*.html", "*.htm", "*.xml", "*.bytes", "*.json", "*.csv", "*.yaml", "*.fnt"}, true, "TextAsset"),
-                new ResourceData("Fonts", new[]{"*.ttf", "*.dfont", "*.otf", "*.ttc"}, true, "Font")
-            };
+            (
+                new List<ResourceData>
+                {
+                    new ResourceData("Scenes", new[] { "*.unity" }, "Scene"),
+                    new ResourceData("Prefabs", new[] { "*.prefab" }, "GameObject"),
+                    new ResourceData("Materials", new[] { "*.mat" }, "Material"),
+                    new ResourceData("AudioClips", new[] { "*.ogg", "*.aif", "*.aiff", "*.flac", "*.mp3", "*.mod", "*.it", "*.s3m", "*.xm", "*.wav" }, "AudioClip"),
+                    new ResourceData("Sprites", new[] { "*.jpg", "*.jpeg", "*.tif", "*.tiff", "*.tga", "*.gif", "*.png", "*.psd", "*.bmp", "*.iff", "*.pict", "*.pic", "*.pct", "*.exr", "*.hdr" }, "Sprite"),
+                    new ResourceData("TextAssets", new[] { "*.txt", "*.html", "*.htm", "*.xml", "*.bytes", "*.json", "*.csv", "*.yaml", "*.fnt" }, "TextAsset"),
+                    new ResourceData("Fonts", new[] { "*.ttf", "*.dfont", "*.otf", "*.ttc" }, "Font")
+                },
+                new List<string>
+                {
+                    "UnityEngine",
+                    "UnityEngine.SceneManagement",
+                }
+            );
 
         [SettingsProvider]
         public static SettingsProvider CreateSettingsProvider() =>
@@ -104,8 +113,14 @@ public static SettingsProvider CreateSettingsProvider() =>
                     EditorGUILayout.PropertyField(settings.FindProperty(nameof(_logInfo)), new GUIContent("Log Infos"));
                     EditorGUILayout.PropertyField(settings.FindProperty(nameof(_logError)), new GUIContent("Log Errors"));
 
-                    if (GUILayout.Button("Reset file mappings")) settings.FindProperty(nameof(_data)).SetValue(CreateDefaultFileMappings());
+                    if (GUILayout.Button("Reset file mappings"))
+                    {
+                        var (data, usings) = CreateDefaultFileMappings();
+                        settings.FindProperty(nameof(_data)).SetValue(data);
+                        settings.FindProperty(nameof(_usings)).SetValue(usings);
+                    }
 
+                    EditorGUILayout.PropertyField(settings.FindProperty(nameof(_usings)), new GUIContent("Using directives"));
                     EditorGUILayout.PropertyField(settings.FindProperty(nameof(_data)), new GUIContent("Data"));
 
                     settings.ApplyModifiedProperties();
diff --git a/UnityResourceGenerator/Assets/ResourceGenerator.asset b/UnityResourceGenerator/Assets/ResourceGenerator.asset
@@ -17,21 +17,21 @@ MonoBehaviour:
   _folderPath: AutSoft.UnityResourceGenerator.Sample
   _logInfo: 1
   _logError: 1
+  _usings:
+  - UnityEngine
+  - UnityEngine.SceneManagement
   _data:
   - _className: Scenes
     _fileExtensions:
     - '*.unity'
-    _isResource: 0
     _dataType: Scene
   - _className: Prefabs
     _fileExtensions:
     - '*.prefab'
-    _isResource: 1
     _dataType: GameObject
   - _className: Materials
     _fileExtensions:
     - '*.mat'
-    _isResource: 1
     _dataType: Material
   - _className: AudioClips
     _fileExtensions:
@@ -45,7 +45,6 @@ MonoBehaviour:
     - '*.s3m'
     - '*.xm'
     - '*.wav'
-    _isResource: 1
     _dataType: AudioClip
   - _className: Sprites
     _fileExtensions:
@@ -64,7 +63,6 @@ MonoBehaviour:
     - '*.pct'
     - '*.exr'
     - '*.hdr'
-    _isResource: 1
     _dataType: Sprite
   - _className: TextAssets
     _fileExtensions:
@@ -77,13 +75,11 @@ MonoBehaviour:
     - '*.csv'
     - '*.yaml'
     - '*.fnt'
-    _isResource: 1
     _dataType: TextAsset
   - _className: Fonts
     _fileExtensions:
     - '*.ttf'
     - '*.dfont'
     - '*.otf'
     - '*.ttc'
-    _isResource: 1
     _dataType: Font

Original file line number	Diff line number	Diff line change
`@@ -31,7 +31,7 @@ public static partial class Materials`
`31`	`31`	`}`
`32`	`32`	`public static partial class AudioClips`
`33`	`33`	`{`
`34`		`- public const string CoinSpin = "CoinSpin";`
	`34`	`+ public const string CoinSpin = "Coin Spin";`
`35`	`35`	`public static AudioClip LoadCoinSpin() => Resources.Load<AudioClip>(CoinSpin);`
`36`	`36`	`public const string Coin = "Coin";`
`37`	`37`	`public static AudioClip LoadCoin() => Resources.Load<AudioClip>(Coin);`