Merge pull request #3 from myunitytools/feature/template-preview

[Feature] Add namespace module and preview

Author: joaoborks

CHANGELOG.md

@@ -3,6 +3,11 @@ Change Log
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [3.0.0] - 2022-10-03
+- Added: Namespace settings module.
+- Added: Live preview of namespace and signature changes.
+- Changed: Cached data is now a single entry instead of multiple entries in EditorPrefs.
+
 ## [2.2.0] - 2022-09-13
 - Added: Support for ISO date format by default.
 
@@ -42,6 +47,7 @@ All notable changes to this project will be documented in this file. This projec
 ## [1.0.0] - 2019-07-27
 - Initial Asset Store release.
 
+[3.0.0]: https://github.com/myunitytools/script-template/compare/2.2.0...3.0.0
 [2.2.0]: https://github.com/myunitytools/script-template/compare/2.1.0...2.2.0
 [2.1.0]: https://github.com/myunitytools/script-template/compare/2.0.1...2.1.0
 [2.0.1]: https://github.com/myunitytools/script-template/compare/2.0.0...2.0.1

Editor/IndentPattern.cs

@@ -0,0 +1,14 @@
+/**
+ * IndentPattern.cs
+ * Created by: João Borks [[email protected]]
+ * Created on: 2021-10-02
+ */
+
+namespace MyUnityTools.ScriptTemplates
+{
+    public enum IndentPattern
+    {
+        Spaces,
+        Tabs
+    };
+}

Editor/IndentPattern.cs.meta

@@ -0,0 +1,18 @@
+{
+    "name": "MyUnityTools.ScriptTemplates",
+    "rootNamespace": "",
+    "references": [
+        "GUID:2fa312fb52fb6b547b332c9fb4cb6d79"
+    ],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

Editor/MyUnityTools.ScriptTemplates.asmdef

@@ -0,0 +1,49 @@
+/**
+ * NamespaceSettings.cs
+ * Created by: João Borks [[email protected]]
+ * Created on: 2021-10-02
+ */
+
+using System;
+
+namespace MyUnityTools.ScriptTemplates
+{
+    [Serializable]
+    public struct NamespaceSettings
+    {
+        public bool Enabled;
+        public bool UseAssemblyDefinition;
+        public string DefaultNamespace;
+        public IndentPattern IndentPattern;
+        public int IndentMultiplier;
+
+        public override bool Equals(object obj)
+        {
+            return obj is NamespaceSettings settings &&
+                   Enabled == settings.Enabled &&
+                   UseAssemblyDefinition == settings.UseAssemblyDefinition &&
+                   DefaultNamespace == settings.DefaultNamespace &&
+                   IndentPattern == settings.IndentPattern &&
+                   IndentMultiplier == settings.IndentMultiplier;
+        }
+
+        public override int GetHashCode()
+        {
+            return HashCode.Combine(Enabled, UseAssemblyDefinition, DefaultNamespace, IndentPattern, IndentMultiplier);
+        }
+
+        public bool IsValid() => !Enabled || !string.IsNullOrWhiteSpace(DefaultNamespace);
+
+        public bool IsEmpty() => this == new NamespaceSettings();
+
+        public static bool operator ==(NamespaceSettings left, NamespaceSettings right)
+        {
+            return left.Equals(right);
+        }
+
+        public static bool operator !=(NamespaceSettings left, NamespaceSettings right)
+        {
+            return !(left == right);
+        }
+    }
+}

Editor/MyUnityTools.CustomScriptTemplate.Editor.asmdef.meta renamed to Editor/MyUnityTools.ScriptTemplates.asmdef.meta

@@ -1,43 +1,46 @@
 /**
- * ScriptKeywordProcessor.cs
+ * ScriptAssetProcessor.cs
  * Created by: João Borks [[email protected]]
  * Created on: 2019-02-19
  * Tips from https://forum.unity3d.com/threads/c-script-template-how-to-make-custom-changes.273191/
  */
 
-using UnityEngine;
+using System.IO;
 using UnityEditor;
-using System.Globalization;
+using UnityEngine;
 
 namespace MyUnityTools.ScriptTemplates
 {
     /// <summary>
     /// This class listens to <see cref="AssetModificationProcessor"/>'s <see cref="OnWillCreateAsset(string)"/> event that executes whenever a new asset is created
     /// and replaces the keywords on scripts to what we defined on our <see cref="ScriptTemplatesEditor"/>
     /// </summary>
-    public class ScriptKeywordProcessor : AssetModificationProcessor
+    public class ScriptAssetProcessor : AssetModificationProcessor
     {
         public static void OnWillCreateAsset(string path)
         {
             path = path.Replace(".meta", "");
-            int index = path.LastIndexOf(".");
+            var assetPath = path;
+            var index = path.LastIndexOf(".");
             if (index < 0)
                 return;
 
-            string file = path.Substring(index);
+            var file = path.Substring(index);
             if (file != ".cs")
                 return;
 
             index = Application.dataPath.LastIndexOf("Assets");
             path = Application.dataPath.Substring(0, index) + path;
-            if (!System.IO.File.Exists(path))
+            if (!File.Exists(path))
                 return;
 
-            string fileContent = System.IO.File.ReadAllText(path);
-            fileContent = fileContent.Replace("#AUTHOR#", $"{EditorPrefs.GetString(ScriptTemplatesEditor.AuthorNameKey)}{(EditorPrefs.HasKey(ScriptTemplatesEditor.AuthorEmailKey) ? $" [{EditorPrefs.GetString(ScriptTemplatesEditor.AuthorEmailKey)}]" : string.Empty)}");
-            fileContent = fileContent.Replace("#CREATIONDATE#", EditorPrefs.GetBool(ScriptTemplatesEditor.UseLocalDateKey, false) ? $"{System.DateTime.Now.ToString("d", CultureInfo.CurrentCulture)} ({CultureInfo.CurrentCulture.Name})" : System.DateTime.Now.ToString("yyyy-MM-dd"));
+            var keywordReplacer = new ScriptKeywordReplacer(ScriptTemplateSettings.FromEditorPrefs());
+
+            var fileContent = File.ReadAllText(path);
+
+            fileContent = keywordReplacer.ProcessScriptTemplate(fileContent, assetPath);
 
-            System.IO.File.WriteAllText(path, fileContent);
+            File.WriteAllText(path, fileContent);
             AssetDatabase.Refresh();
         }
     }

Editor/NamespaceSettings.cs

@@ -0,0 +1,88 @@
+/**
+ * ScriptKeywordReplacer.cs
+ * Created by: João Borks [[email protected]]
+ * Created on: 2022-09-21
+ */
+
+using System;
+using System.Globalization;
+using System.Text;
+using System.Text.RegularExpressions;
+using UnityEditor.Compilation;
+
+namespace MyUnityTools.ScriptTemplates
+{
+    public class ScriptKeywordReplacer
+    {
+        const string _scriptNameKeyword = "#SCRIPTNAME#";
+        const string _namespaceKeyword = "#NAMESPACE#";
+        const string _signatureKeyword = "#SIGNATURE#";
+        const string _authorKeyword = "#AUTHOR#";
+        const string _dateKeyword = "#CREATIONDATE#";
+
+        static readonly string _signatureTemplate =
+            "/**\n" +
+            " * " + _scriptNameKeyword + ".cs\n" +
+            " * Created by: " + _authorKeyword + "\n" +
+            " * Created on: " + _dateKeyword + "\n" +
+            " */\n\n";
+
+        public string AuthorString => $"{_templateSettings.Signature.AuthorName}{(!string.IsNullOrWhiteSpace(_templateSettings.Signature.AuthorEmail) ? $" [{_templateSettings.Signature.AuthorEmail}]" : string.Empty)}";
+        public string DateString => _templateSettings.Signature.UseLocalDateFormat ? $"{DateTime.Now.ToString("d", CultureInfo.CurrentCulture)} ({CultureInfo.CurrentCulture.Name})" : DateTime.Now.ToString("yyyy-MM-dd");
+
+        readonly ScriptTemplateSettings _templateSettings;
+
+        public ScriptKeywordReplacer(ScriptTemplateSettings templateSettings)
+        {
+            _templateSettings = templateSettings;
+        }
+
+        public string ProcessScriptTemplate(string scriptContent, string path)
+        {
+            Regex regex;
+            if (_templateSettings.Namespace.Enabled)
+            {
+                var namespaceString = string.Empty;
+                if (_templateSettings.Namespace.UseAssemblyDefinition)
+                {
+                    namespaceString = CompilationPipeline.GetAssemblyRootNamespaceFromScriptPath(path);
+                    if (string.IsNullOrWhiteSpace(namespaceString))
+                        namespaceString = CompilationPipeline.GetAssemblyNameFromScriptPath(path).Replace(".dll", string.Empty);
+                }
+                if (string.IsNullOrWhiteSpace(namespaceString) || namespaceString.StartsWith("Assembly-CSharp"))
+                    namespaceString = _templateSettings.Namespace.DefaultNamespace;
+
+                regex = new Regex(@"(?<=#NAMESPACE#)([\s\S]*?(\n|\r|\r\n)}(\n|\r|\r\n)?)");
+                if (regex.IsMatch(scriptContent))
+                {
+                    var match = regex.Match(scriptContent);
+                    var indentString = GetIndentReplacement();
+                    var indentedMatch = match.Value.Replace("\n", indentString);
+                    scriptContent = scriptContent
+                        .Replace(match.Value, indentedMatch)
+                        .Replace(_namespaceKeyword, "namespace " + namespaceString + "\n{" + indentString);
+
+                    scriptContent = scriptContent.Insert(scriptContent.Length, "\n}");
+                }
+            }
+
+            scriptContent = scriptContent.Replace(_namespaceKeyword, string.Empty);
+
+            var stringBuilder = new StringBuilder(scriptContent);
+            stringBuilder
+                .Replace(_signatureKeyword, _templateSettings.Signature.Enabled ? _signatureTemplate.Replace(_authorKeyword, AuthorString).Replace(_dateKeyword, DateString) : string.Empty)
+                .Replace(_scriptNameKeyword, System.IO.Path.GetFileNameWithoutExtension(path));
+            return Regex.Replace(stringBuilder.ToString(), @"\r\n|\n\r|\n|\r", Environment.NewLine);
+        }
+
+        string GetIndentReplacement()
+        {
+            string indentValue = _templateSettings.Namespace.IndentPattern == IndentPattern.Spaces ? " " : "\t";
+            var stringBuilder = new StringBuilder("\n");
+
+            for (int i = 0; i < _templateSettings.Namespace.IndentMultiplier; i++)
+                stringBuilder.Append(indentValue);
+            return stringBuilder.ToString();
+        }
+    }
+}