Rework scene generation, remove IsResource

Author: András Kurai

CHANGELOG.md

@@ -3,6 +3,7 @@
 - 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
 
 # 0.1.0
 - Add initial project

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.

Documentation/images/Customization/DefaultSettings.png

@@ -6,7 +6,6 @@ public interface IResourceData
     {
         string ClassName { get; }
         IReadOnlyList<string> FileExtensions { get; }
-        bool IsResource { get; }
         string DataType { get; }
     }
 }

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/IResourceData.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)
@@ -49,7 +49,8 @@ public static partial class {data.ClassName}
                     return
                     (
                         name: Path.GetFileNameWithoutExtension(filePath),
-                        path: resourcePath
+                        path: resourcePath,
+                        fileExtension: Path.GetExtension(filePath)
                     );
                 })
                 .Where(p => p.name != null)
@@ -77,7 +78,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 +100,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");

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/Modules/AllResources.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;
         }
 
@@ -86,13 +83,13 @@ private static (List<ResourceData> data, List<string> usings) CreateDefaultFileM
             (
                 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 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>
                 {

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/ResourceGeneratorSettings.cs

@@ -24,17 +24,14 @@ MonoBehaviour:
   - _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:
@@ -48,7 +45,6 @@ MonoBehaviour:
     - '*.s3m'
     - '*.xm'
     - '*.wav'
-    _isResource: 1
     _dataType: AudioClip
   - _className: Sprites
     _fileExtensions:
@@ -67,7 +63,6 @@ MonoBehaviour:
     - '*.pct'
     - '*.exr'
     - '*.hdr'
-    _isResource: 1
     _dataType: Sprite
   - _className: TextAssets
     _fileExtensions:
@@ -80,13 +75,11 @@ MonoBehaviour:
     - '*.csv'
     - '*.yaml'
     - '*.fnt'
-    _isResource: 1
     _dataType: TextAsset
   - _className: Fonts
     _fileExtensions:
     - '*.ttf'
     - '*.dfont'
     - '*.otf'
     - '*.ttc'
-    _isResource: 1
     _dataType: Font