customizable using directives

Author: András Kurai

CHANGELOG.md

@@ -2,6 +2,7 @@
 - Add documentation website
 - Reference documentation in `package.json`
 - Make using namespaces optional
+- Configure using directives
 
 # 0.1.0
 - Add initial project

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

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; }
     }
 }

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/ResourceFileGenerator.cs

@@ -12,9 +12,6 @@ public static string CreateResourceFile(ResourceContext context)
             // ReSharper disable once MissingIndent
             const string fileBeginHasNamespace =
 @"
-using UnityEngine;
-using UnityEngine.SceneManagement;
-
 namespace {0}
 {
     // ReSharper disable PartialTypeWithSinglePart
@@ -29,9 +26,6 @@ public static partial class {1}
             // ReSharper disable once MissingIndent
             const string fileBeginNoNamespace =
 @"
-using UnityEngine;
-using UnityEngine.SceneManagement;
-
 // ReSharper disable PartialTypeWithSinglePart
 public static partial class {1}
 {";
@@ -47,6 +41,8 @@ public static partial class {1}
                 .Where(t => !t.IsAbstract && !t.IsGenericType && !t.IsInterface)
                 .ToArray();
 
+            builder.AppendMultipleLines(context.Usings.Select(u => $"using {u};"));
+
             builder.AppendLine(
                 (string.IsNullOrWhiteSpace(context.BaseNamespace) ? fileBeginNoNamespace : fileBeginHasNamespace)
                 .Replace("{0}", context.BaseNamespace)

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");

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

@@ -46,13 +46,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()
@@ -68,26 +70,36 @@ public static ResourceGeneratorSettings GetOrCreateSettings()
             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" }, 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<string>
+                {
+                    "UnityEngine",
+                    "UnityEngine.SceneManagement",
+                }
+            );
 
         [SettingsProvider]
         public static SettingsProvider CreateSettingsProvider() =>
@@ -104,8 +116,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();

UnityResourceGenerator/Assets/ResourceGenerator.asset

@@ -17,6 +17,9 @@ MonoBehaviour:
   _folderPath: AutSoft.UnityResourceGenerator.Sample
   _logInfo: 1
   _logError: 1
+  _usings:
+  - UnityEngine
+  - UnityEngine.SceneManagement
   _data:
   - _className: Scenes
     _fileExtensions: