v1.4.0

Author: sator-imaging

README.md

@@ -11,6 +11,9 @@ Alternative Source Generator is built on the Unity native functions.
 
 As you already know, Roslyn's source generator is too sophisticated. This framework provides more simple, ease of use and good enough functions for source code generation.
 
+- [Troubleshooting](#troubleshooting)
+
+
 <p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
 
 超簡単に使える Unity 向けソースジェネレーターです。
@@ -27,12 +30,14 @@ As you already know, Roslyn's source generator is too sophisticated. This framew
     - [Generic Generator](#generic-generator)
         - [Result](#result-1)
 - [Output Directory and File Name](#output-directory-and-file-name)
+- [Coding Goodies](#coding-goodies)
 - [Utility Functions for Build](#utility-functions-for-build)
 - [Technical Notes](#technical-notes)
     - [Naming Convention](#naming-convention)
     - [`<auto-generated/>` Tag](#auto-generated-tag)
 - [Installation](#installation)
 - [Editor Extensions](#editor-extensions)
+- [Troubleshooting](#troubleshooting)
 - [Copyright](#copyright)
 - [License](#license)
 - [Devnote](#devnote)
@@ -45,7 +50,8 @@ As you already know, Roslyn's source generator is too sophisticated. This framew
 
 
 
-# Sample Code
+Sample Code
+===========
 
 Minimal implementation codes of source generator.
 
@@ -176,7 +182,8 @@ Hello World from Sample.MinimalGenerator
 ```
 
 
-# Output Directory and File Name
+Output Directory and File Name
+==============================
 
 Source Generator creates `USG.g` folder next to target script and append class names to file name.
 
@@ -196,7 +203,68 @@ Resulting file path will be:
 
 
 
-# Utility Functions for Build
+Coding Goodies
+==============
+
+There are utility methods for coding source generator more efficient and readable.
+
+- `StringBuilder` Extentions
+    - `IndentLine` / `IndentAppend`
+    - `IndentLevel` / `IndentChar` / `IndentSize`
+    - `IndentBegin` / `IndentEnd`
+- `USGFullNameOf`
+    - `usg`
+- `USGReflection`
+    - `GetAllPublicInstanceFieldAndProperty`
+    - `TryGetFieldOrPropertyType`
+    - `GetEnumNamesAndValuesAsDictionary`
+    - `GetEnumNamesAndValuesAsTuple`
+
+`usg` is a special utility that is designed for refactoring-ready source generator more readable, script template import it as a static library by default.
+
+
+<p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
+
+`System.Reflection` 系のユーティリティーと `StringBuilder` の拡張メソッド群。
+
+`usg` は特殊で、クラス名やら何やらのリファクタリングに強いジェネレーターにすると読みづらくなってしまうのを緩和するためのモノ。
+
+`{typeof(MyClass).FullName}.{nameof(MyClass.Property)}` どんどん長くなるだけなら良いけどクラス内クラスとか構造体の名前が + 付きの不正な状態で出てくる。その他にもジェネリッククラスへの対応とかなんとか、結局何かが必要になる。それならばと可能な限り短く書けるようにした。
+
+インデント系はトリッキーだけど開発機での実行なのでまあ良し。
+
+<!------- End of Details JA Tag -------></details></p>
+
+
+```csharp
+using static SatorImaging.UnitySourceGenerator.USGFullNameOf;  // usg<T>() to work
+
+// simple usage -> Full.Namespace.To.MyClass.MyStruct.MyField
+usg<MyClass>("MyStruct.MyField");
+// most strict refactoring-ready coding is...
+usg<MyClass>(nameof(MyClass.MyStruct), nameof(MyClass.MyStruct.MyField));
+
+// indent utility
+sb.IndentChar(' ');  // default
+sb.IndentSize(4);    // default
+sb.IndentLevel(3);   // template default
+sb.IndentBegin();
+{
+    // cast int value to enum
+    sb.IndentLine($"MyObject.EnumValue = ({usg<MyEnum>()})intValue");
+    // --- or ---
+    string CAST_MY_ENUM = "(" + usg(typeVariableCanBePassed) + ")";
+    sb.IndentLine($"MyObject.EnumValue = {CAST_MY_ENUM}intValue");
+}
+sb.IndentEnd();
+```
+
+> **NOTE**: Inner class, enum or struct (`MyClass+InnerEnum`) is supported. Generic class (<code>MyClass`1</code>) naming is not supported yet.  
+
+
+
+Utility Functions for Build
+===========================
 
 There are utility functions to perform source code generation on build event.
 
@@ -218,7 +286,8 @@ USGEngine.ProcessFile(assetPath);
 
 
 
-# Technical Notes
+Technical Notes
+===============
 
 As of C# 9.0, it doesn't allow to define `abstract static` methods in interface, USG reports error when source generator class doesn't implement required static methods.
 
@@ -271,7 +340,8 @@ USG automatically adds document tag at the beginning of generated file. You can
 
 
 
-# Installation
+Installation
+============
 
 Use the following git URL in Unity Package Manager (UPM).
 
@@ -280,7 +350,8 @@ Use the following git URL in Unity Package Manager (UPM).
 
 
 
-# Editor Extensions
+Editor Extensions
+=================
 
 <p><details lang="ja" --open><summary><small>日本語 / JA</small></summary>
 
@@ -304,6 +375,19 @@ There is an ability to invoke source code generation by hand. With generator scr
 
 
 
+Troubleshooting
+===============
+
+#### Generator script update is not applied to generated file.
+
+Usually, this problem happens when Unity automatically reloads updated scripts WITHOUT Editor window getting focus. To solve the problem:
+
+1. Close Unity and Visual Studio.
+1. Restart Unity.
+1. Launch Visual Studio by double clicking `.cs` script in Unity Editor.
+
+
+
 
 
 Copyright

package.json

@@ -1,7 +1,7 @@
 {
   "name": "com.sator-imaging.alt-source-generator",
   "displayName": "Alternative Source Generator for Unity",
-  "version": "1.3.0",
+  "version": "1.4.0",
   "unity": "2021.3",
   "description": "Ease-of-Use Source Generator Alternative for Unity.",
   "author": {