Merge pull request #2 from myunitytools/feature/iso-date

[Feature] Add ISO date format by default

Author: joaoborks

CHANGELOG.md

@@ -3,6 +3,9 @@ Change Log
 
 All notable changes to this project will be documented in this file. This project adheres to [Semantic Versioning](http://semver.org/).
 
+## [2.2.0] - 2022-09-13
+- Added: Support for ISO date format by default.
+
 ## [2.1.0] - 2022-09-13
 - Changed: Moved repository to My Unity Tools organization
 - Changed: Updated package name and author.
@@ -39,6 +42,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.
 
+[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
 [2.0.0]: https://github.com/myunitytools/script-template/compare/1.3.0...2.0.0

Editor/ScriptKeywordProcessor.cs

@@ -1,7 +1,7 @@
 /**
  * ScriptKeywordProcessor.cs
  * Created by: João Borks [[email protected]]
- * Created on: 2/19/2019 (en-US)
+ * Created on: 2019-02-19
  * Tips from https://forum.unity3d.com/threads/c-script-template-how-to-make-custom-changes.273191/
  */
 
@@ -12,10 +12,10 @@
 namespace MyUnityTools.ScriptTemplates
 {
     /// <summary>
-    /// This class listens to <see cref="UnityEditor.AssetModificationProcessor"/>'s <see cref="OnWillCreateAsset(string)"/> event that executes whenever a new asset is created
+    /// 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 : UnityEditor.AssetModificationProcessor
+    public class ScriptKeywordProcessor : AssetModificationProcessor
     {
         public static void OnWillCreateAsset(string path)
         {
@@ -34,8 +34,8 @@ public static void OnWillCreateAsset(string path)
                 return;
 
             string fileContent = System.IO.File.ReadAllText(path);
-            fileContent = fileContent.Replace("#AUTHOR#", $"{EditorPrefs.GetString(ScriptTemplatesEditor.AuthorNameField)}{(EditorPrefs.HasKey(ScriptTemplatesEditor.AuthorEmailField) ? $" [{EditorPrefs.GetString(ScriptTemplatesEditor.AuthorEmailField)}]" : string.Empty)}");
-            fileContent = fileContent.Replace("#CREATIONDATE#", $"{System.DateTime.Now.ToString("d", CultureInfo.CurrentCulture)} ({CultureInfo.CurrentCulture.Name})");
+            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"));
 
             System.IO.File.WriteAllText(path, fileContent);
             AssetDatabase.Refresh();

Editor/ScriptTemplatesEditor.cs

@@ -1,7 +1,7 @@
 /**
  * CustomScriptTemplateEditor.cs
  * Created by: João Borks [[email protected]]
- * Created on: 7/13/2019 (en-US)
+ * Created on: 2019-07-13
  */
 
 using System.IO;
@@ -19,29 +19,34 @@ public class ScriptTemplatesEditor : EditorWindow
         /// <summary>
         /// The name of the <see cref="authorName"/> string field saved on <see cref="EditorPrefs"/>
         /// </summary>
-        public const string AuthorNameField = "com.myunitytools.cst.authorName";
+        public const string AuthorNameKey = "com.myunitytools.cst.authorName";
         /// <summary>
         /// The name of the <see cref="authorEmail"/> string field saved on <see cref="EditorPrefs"/>
         /// </summary>
-        public const string AuthorEmailField = "com.myunitytools.cst.authorEmail";
+        public const string AuthorEmailKey = "com.myunitytools.cst.authorEmail";
+        /// <summary>
+        /// Should the date be formatted in the current locale or in the default ISO format?
+        /// </summary>
+        public const string UseLocalDateKey = "com.myunitytools.cst.localdate";
         /// <summary>
         /// The name of the <see cref="localGUID"/> string field saved on <see cref="EditorPrefs"/>
         /// </summary>
-        public const string LocalGUIDField = "com.myunitytools.cst.localguid";
+        public const string LocalGUIDKey = "com.myunitytools.cst.localguid";
         /// <summary>
         /// Package path for accessing script templates and visual elements
         /// </summary>
-        public const string PackageRootPath = "Packages/com.myunitytools.scripttemplate/";
+        public const string PackageRootPath = "Packages/com.myunitytools.script-template/";
         /// <summary>
         /// Project path for storing script templates
         /// </summary>
         public const string LocalTemplatesPath = "Assets/ScriptTemplates/";
+
         /// <summary>
         /// Editor path for storing script templates
         /// </summary>
         public static readonly string EditorTemplatesPath = EditorApplication.applicationPath.Replace("Unity.exe", "") + "/Data/Resources/ScriptTemplates/";
 
-        const string EditorRestartMesssage = "Copying Script Templates will requre Editor restart in order to apply the changes. Do you want to restart now?";
+        const string _editorRestartMesssage = "Copying Script Templates will requre Editor restart in order to apply the changes. Do you want to restart now?";
 
         [MenuItem("Assets/Script Templates Editor", false, 800)]
         public static void ShowWindow() => GetWindow<ScriptTemplatesEditor>("Script Templates").minSize = new Vector2(300, 250);
@@ -62,35 +67,43 @@ void DrawInfoView()
             var saveButton = rootVisualElement.Q<Button>("save-button");
 
             var authorField = rootVisualElement.Q<TextField>("author");
-            authorField.SetValueWithoutNotify(EditorPrefs.GetString(AuthorNameField, string.Empty));
+            authorField.SetValueWithoutNotify(EditorPrefs.GetString(AuthorNameKey, string.Empty));
             authorField.RegisterValueChangedCallback(e => saveButton.SetEnabled(!isAuthorUpdated(e.newValue) && !string.IsNullOrEmpty(authorField.value)));
 
             var emailField = rootVisualElement.Q<TextField>("email");
-            emailField.SetValueWithoutNotify(EditorPrefs.GetString(AuthorEmailField, string.Empty));
+            emailField.SetValueWithoutNotify(EditorPrefs.GetString(AuthorEmailKey, string.Empty));
             emailField.RegisterValueChangedCallback(e => saveButton.SetEnabled(!isEmailUpdated(e.newValue) && !string.IsNullOrEmpty(authorField.value)));
 
+            var localDateToggle = rootVisualElement.Q<Toggle>("localdate");
+            localDateToggle.SetValueWithoutNotify(EditorPrefs.GetBool(UseLocalDateKey, false));
+            localDateToggle.RegisterValueChangedCallback(e => saveButton.SetEnabled(!isLocalDateUpdated(e.newValue)));
+
             var clearButton = rootVisualElement.Q<Button>("clear-button");
-            clearButton.SetEnabled(EditorPrefs.HasKey(AuthorNameField) || EditorPrefs.HasKey(AuthorEmailField));
+            clearButton.SetEnabled(EditorPrefs.HasKey(AuthorNameKey) || EditorPrefs.HasKey(AuthorEmailKey));
             clearButton.clicked += () =>
             {
-                EditorPrefs.DeleteKey(AuthorNameField);
-                EditorPrefs.DeleteKey(AuthorEmailField);
+                EditorPrefs.DeleteKey(AuthorNameKey);
+                EditorPrefs.DeleteKey(AuthorEmailKey);
+                EditorPrefs.DeleteKey(UseLocalDateKey);
                 saveButton.SetEnabled(!string.IsNullOrEmpty(authorField.value));
                 clearButton.SetEnabled(false);
             };
 
             saveButton.SetEnabled(false);
             saveButton.clicked += () =>
             {
-                EditorPrefs.SetString(AuthorNameField, authorField.value);
-                EditorPrefs.SetString(AuthorEmailField, emailField.value);
+                EditorPrefs.SetString(AuthorNameKey, authorField.value);
+                EditorPrefs.SetString(AuthorEmailKey, emailField.value);
+                EditorPrefs.SetBool(UseLocalDateKey, localDateToggle.value);
                 saveButton.SetEnabled(false);
                 clearButton.SetEnabled(true);
             };
 
-            bool isAuthorUpdated(string author) => author == EditorPrefs.GetString(AuthorNameField, string.Empty);
+            bool isAuthorUpdated(string author) => author == EditorPrefs.GetString(AuthorNameKey, string.Empty);
+
+            bool isEmailUpdated(string email) => email == EditorPrefs.GetString(AuthorEmailKey, string.Empty);
 
-            bool isEmailUpdated(string email) => email == EditorPrefs.GetString(AuthorEmailField, string.Empty);
+            bool isLocalDateUpdated(bool value) => value == EditorPrefs.GetBool(UseLocalDateKey, false);
         }
 
         void DrawTemplateView()
@@ -124,7 +137,7 @@ void DrawTemplateView()
             var projectButton = rootVisualElement.Q<Button>("copy-project-button");
             projectButton.clicked += () =>
             {
-                var shouldRestart = EditorUtility.DisplayDialog("Editor Restart", EditorRestartMesssage, "Yes", "No");
+                var shouldRestart = EditorUtility.DisplayDialog("Editor Restart", _editorRestartMesssage, "Yes", "No");
                 var length = templates.Length;
                 if (!AssetDatabase.IsValidFolder(LocalTemplatesPath))
                     AssetDatabase.CreateFolder("Assets", "ScriptTemplates");
@@ -137,7 +150,7 @@ void DrawTemplateView()
             var editorButton = rootVisualElement.Q<Button>("copy-editor-button");
             editorButton.clicked += () =>
             {
-                var shouldRestart = EditorUtility.DisplayDialog("Editor Restart", EditorRestartMesssage, "Yes", "No");
+                var shouldRestart = EditorUtility.DisplayDialog("Editor Restart", _editorRestartMesssage, "Yes", "No");
                 var length = templates.Length;
                 for (int i = 0; i < length; i++)
                     File.Copy(AssetDatabase.GetAssetPath(templates[i]), EditorTemplatesPath + templates[i].name + ".txt");

README.md

@@ -27,9 +27,9 @@ Usage
 
 From `Assets/Script Templates Editor` you can open the **Script Templates Editor** Window.
 
-![Custom Script Template Editor](https://user-images.githubusercontent.com/9505905/111533536-a70be580-8745-11eb-909c-b9a97ee0e311.png)
+![Custom Script Template Editor](https://user-images.githubusercontent.com/9505905/190041726-dcd85558-00fa-49d3-b0cc-03a20da335bd.png)
 
-Here you can set your Author Name and Email to add to your script's signature header. You need to click save to store this data into
+Here you can set your Author Name and Email to add to your script's signature header. Also, you can choose to use the **local date format**: _9/13/2022 (en-US)_, for example, or the standard ISO format: _2022-09-13_. You need to click `Save` to store this data into
 the [Editor Prefs](https://docs.unity3d.com/ScriptReference/EditorPrefs.html). You also have the option to clear the saved data.
 
 Immediately below that, we have a list of all included Script Templates and you can select them to locate the file.

UIToolkit/ScriptTemplateWindow.uxml

@@ -1,21 +1,16 @@
-<?xml version="1.0" encoding="utf-8"?>
-<engine:UXML
-    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-    xmlns:engine="UnityEngine.UIElements"
-    xmlns:editor="UnityEditor.UIElements"
-    xsi:noNamespaceSchemaLocation="../../../UIElementsSchema/UIElements.xsd"
->
-    <engine:Label text="Signature Info" class="bold"/>
-    <engine:TextField name="author" label="Author"/>
-    <engine:TextField name="email" label="Email (optional)"/>
-    <engine:VisualElement class="button-group">
-        <engine:Button name="clear-button" text="Clear"/>
-        <engine:Button name="save-button" text="Save"/>
-    </engine:VisualElement>
-    <engine:Label text="Templates" class="bold"/>
-    <engine:VisualElement class="button-group">
-        <engine:Button name="copy-project-button" text="Copy to Project"/>
-        <engine:Button name="copy-editor-button" text="Copy to Editor"/>
-    </engine:VisualElement>
-    <engine:ListView name="template-list"/>
-</engine:UXML>
+<ui:UXML xmlns:ui="UnityEngine.UIElements" xmlns:uie="UnityEditor.UIElements" xsi="http://www.w3.org/2001/XMLSchema-instance" engine="UnityEngine.UIElements" editor="UnityEditor.UIElements" noNamespaceSchemaLocation="../../../UIElementsSchema/UIElements.xsd" editor-extension-mode="False">
+    <ui:Label text="Signature Info" class="bold" />
+    <ui:TextField name="author" label="Author" />
+    <ui:TextField name="email" label="Email (optional)" />
+    <ui:Toggle label="Use Local Date" name="localdate" />
+    <ui:VisualElement class="button-group">
+        <ui:Button name="clear-button" text="Clear" />
+        <ui:Button name="save-button" text="Save" />
+    </ui:VisualElement>
+    <ui:Label text="Templates" class="bold" />
+    <ui:VisualElement class="button-group">
+        <ui:Button name="copy-project-button" text="Copy to Project" />
+        <ui:Button name="copy-editor-button" text="Copy to Editor" />
+    </ui:VisualElement>
+    <ui:ListView name="template-list" />
+</ui:UXML>

package.json

@@ -1,6 +1,6 @@
 {
   "name": "com.myunitytools.script-template",
-  "version": "2.1.0",
+  "version": "2.2.0",
   "displayName": "Script Templates",
   "description": "This tool adds custom Script Templates to Unity that will serve as alternatives for the default \"C#Script\" that I personally always modify before writing my scripts.\nIn essence, it adds a signature header on every script with your name, email and creation date. \nAdditionally, it adds templates for others types of scripts rather than just Mono Behaviours.",
   "unity": "2019.4",