Merge pull request #5 from AutSoft/develop

0.3.0

Author: KuraiAndras

.github/workflows/publish.yml

@@ -12,12 +12,8 @@ jobs:
     steps:
       - uses: actions/checkout@v2
 
-      - name: Publish LinkerGenerator to openupm
+      - name: Publish UnityResourceGenerator to OpenUPM
         uses: butlerlogic/action-autotag@stable
         with:
           GITHUB_TOKEN: "${{ secrets.GITHUB_TOKEN }}"
           root: "UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator"
-
-      - name: Create GitHub Release
-        shell: pwsh
-        run: ./build.ps1 CreateGithubRelease --is-ci

CHANGELOG.md

@@ -1,3 +1,8 @@
+# 0.3.0
+- Support for files with non-alphanumeric characters
+- Support for file starting with numeric characters
+- Update documentation with name generation rules
+
 # 0.2.0
 - Add documentation website
 - Reference documentation in `package.json`

Documentation/articles/GettingStarted.md

@@ -19,3 +19,11 @@ The tool will create new button in the Editor at `Tools / Generate Resource Path
 ![Generate Button](~/images/intro/GenerateButton.png)
 
 If your click the button the helper class will be generated in the root of the `Assets` folder
+
+## Name generation rules
+
+The generated method and filed names are slightly different from the actual file names, because not all valid file names are valid C# identifier names. The following rules apply:
+
+- Whitespaces are removed
+- If the file name starts with a number a `_` character is added to the start of the identifier
+- All non-alphanumeric characters are replaced by the `_` character

Documentation/articles/KnownIssues.md

@@ -2,6 +2,10 @@
 
 ## 0.1.0 - *
 
+- Duplicate file names in the same class module will break the generated file. The solution for this requires further investigation
+
+## 0.1.0 - 0.2.0: Fixed in 0.3.0
+
 - SpecialCharacters can break generated names.
   - Numbers at the end of the files are supported, but not at the start
   - Any character in the filename which would not be a valid C# filed/property/method name will break the generated code
@@ -12,5 +16,3 @@
     - `1Coin` does not
     - `!Coin` does not
     - `Coin!` does not
-
-- Duplicate file names in the same class module will break the generated file. The solution for this requires further investigation

UnityResourceGenerator.Build/Build.cs

@@ -2,16 +2,11 @@
 using Nuke.Common.IO;
 using Nuke.Common.Tooling;
 using Nuke.Common.Tools.MSBuild;
-using Nuke.Common.Utilities.Collections;
 using System;
 using System.IO;
-using System.Linq;
-using System.Text;
-using System.Text.Json;
 using System.Text.RegularExpressions;
 using System.Threading.Tasks;
 using static Nuke.Common.Tools.DocFX.DocFXTasks;
-using static Nuke.Common.Tools.Git.GitTasks;
 using static Nuke.Common.Tools.MSBuild.MSBuildTasks;
 using static Nuke.Common.Tools.Unity.UnityTasks;
 using static UnityHelper;
@@ -22,8 +17,6 @@ class Build : NukeBuild
 
     public static int Main() => Execute<Build>(x => x.Compile);
 
-    [PathExecutable] readonly Tool Gh = default!;
-
     [Parameter("Configuration to build - Default is 'Debug' (local) or 'Release' (server)")]
     readonly Configuration Configuration = IsLocalBuild ? Configuration.Debug : Configuration.Release;
 
@@ -33,9 +26,6 @@ class Build : NukeBuild
 
     [Parameter("Are we running in CI")] bool IsCi = false;
 
-    string CurrentVersion { get; set; } = default!;
-    bool IsNewestVersion { get; set; }
-
     static AbsolutePath UnityProjectPath => RootDirectory / "UnityResourceGenerator";
     static AbsolutePath UnitySolution => UnityProjectPath / "UnityResourceGenerator.sln";
 
@@ -123,66 +113,4 @@ async Task GenerateSolution()
     Target ServeDocs => _ => _
         .DependsOn(BuildDocs)
         .Executes(() => DocFX($"{DocFxJsonPath} --serve"));
-
-    Target CreateGithubRelease => _ => _
-        .OnlyWhenDynamic(() => IsNewestVersion)
-        .OnlyWhenDynamic(() => IsCi)
-        .Executes(() =>
-        {
-            var version = CurrentVersion;
-
-            var notes = File.ReadAllLines(RootDirectory / "CHANGELOG.md")
-                .Skip(1)
-                .TakeUntil(string.IsNullOrWhiteSpace)
-                .Aggregate(new StringBuilder(), (sb, l) => sb.AppendLine(l))
-                .ToString();
-
-            Gh($"release create {version} -t {version} -n \"{notes}\"");
-        });
-
-
-    protected override void OnBuildInitialized()
-    {
-        bool GetIsNewestVersion()
-        {
-            var currentVersion = new Version(CurrentVersion);
-
-            GitLogger = (_, s) => Logger.Info(s);
-
-            Git("fetch --tags");
-
-            var maxPublishedVersion = Git("tag")
-                .Select(o => new Version(o.Text))
-                .OrderBy(v => v)
-                .LastOrDefault();
-
-            return currentVersion.CompareTo(maxPublishedVersion) > 0;
-        }
-
-        string GetCurrentVersion()
-        {
-            var packagePath = UnityProjectPath / "Assets" / "AutSoft.UnityResourceGenerator" / "package.json";
-
-            if (!File.Exists(packagePath)) throw new InvalidOperationException($"package.json does not exist at path: {packagePath}");
-
-            var jsonContent = File.ReadAllText(packagePath);
-            var package = JsonSerializer.Deserialize<PackageJson>(jsonContent, new JsonSerializerOptions { PropertyNameCaseInsensitive = true });
-
-            if (package?.Version is null) throw new InvalidOperationException($"Cloud not deserialize package.json:{Environment.NewLine}{jsonContent}");
-
-            return package.Version;
-        }
-
-        CurrentVersion = GetCurrentVersion();
-        IsNewestVersion = GetIsNewestVersion();
-
-        base.OnBuildInitialized();
-    }
-
-    sealed class PackageJson
-    {
-        public PackageJson(string version) => Version = version;
-
-        public string Version { get; }
-    }
 }

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/ResourcePaths.cs

@@ -1,10 +1,13 @@
 using UnityEngine;
 using UnityEngine.SceneManagement;
+
 namespace AutSoft.UnityResourceGenerator.Sample
 {
     // ReSharper disable PartialTypeWithSinglePart
+    // ReSharper disable InconsistentNaming
     public static partial class ResourcePaths
     {
+
         public static partial class Scenes
         {
             public const string CreatePrefab = "AutSoft.UnityResourceGenerator.Sample/Scenes/CreatePrefab";
@@ -17,24 +20,49 @@ public static partial class Scenes
             public static void LoadLoadSceneNext(LoadSceneMode mode = LoadSceneMode.Single) => SceneManager.LoadScene(LoadSceneNext, mode);
             public static AsyncOperation LoadAsyncLoadSceneNext(LoadSceneMode mode = LoadSceneMode.Single) => SceneManager.LoadSceneAsync(LoadSceneNext, mode);
         }
+
+
         public static partial class Prefabs
         {
             public const string Cube = "Cube";
             public static GameObject LoadCube() => Resources.Load<GameObject>(Cube);
         }
+
+
         public static partial class Materials
         {
             public const string Cube = "Cube";
             public static Material LoadCube() => Resources.Load<Material>(Cube);
             public const string CubeAlt = "CubeAlt";
             public static Material LoadCubeAlt() => Resources.Load<Material>(CubeAlt);
+            public const string LiberationSansSDF_DropShadow = "Fonts & Materials/LiberationSans SDF - Drop Shadow";
+            public static Material LoadLiberationSansSDF_DropShadow() => Resources.Load<Material>(LiberationSansSDF_DropShadow);
+            public const string LiberationSansSDF_Outline = "Fonts & Materials/LiberationSans SDF - Outline";
+            public static Material LoadLiberationSansSDF_Outline() => Resources.Load<Material>(LiberationSansSDF_Outline);
         }
+
+
         public static partial class AudioClips
         {
             public const string CoinSpin = "Coin Spin";
             public static AudioClip LoadCoinSpin() => Resources.Load<AudioClip>(CoinSpin);
+            public const string _1Coin1 = "1Coin 1";
+            public static AudioClip Load_1Coin1() => Resources.Load<AudioClip>(_1Coin1);
             public const string Coin = "Coin";
             public static AudioClip LoadCoin() => Resources.Load<AudioClip>(Coin);
         }
+
+
+
+        public static partial class TextAssets
+        {
+            public const string LineBreakingFollowingCharacters = "LineBreaking Following Characters";
+            public static TextAsset LoadLineBreakingFollowingCharacters() => Resources.Load<TextAsset>(LineBreakingFollowingCharacters);
+            public const string LineBreakingLeadingCharacters = "LineBreaking Leading Characters";
+            public static TextAsset LoadLineBreakingLeadingCharacters() => Resources.Load<TextAsset>(LineBreakingLeadingCharacters);
+        }
+
+
+
     }
 }

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator.Sample/Resources/1Coin 1.wav

@@ -4,11 +4,15 @@
 using System.IO;
 using System.Linq;
 using System.Text;
+using System.Text.RegularExpressions;
 
 namespace AutSoft.UnityResourceGenerator.Editor.Generation.Modules
 {
     public sealed class AllResources : IModuleGenerator
     {
+        private static readonly Regex NonAlphaNumeric = new Regex(@"[^a-zA-Z0-9]", RegexOptions.Compiled, TimeSpan.FromSeconds(1));
+        private static readonly Regex StartsWithNumber = new Regex(@"^\d", RegexOptions.Compiled, TimeSpan.FromSeconds(1));
+
         public string Generate(ResourceContext context) =>
             new StringBuilder()
                 .AppendMultipleLines(context.Data.Select(d => Generate(context, d)))
@@ -47,9 +51,15 @@ public static partial class {data.ClassName}
                         )
                         .Replace('\\', '/');
 
+                    var name = Path.GetFileNameWithoutExtension(filePath).Replace(" ", string.Empty);
+
+                    if (StartsWithNumber.IsMatch(name)) name = name.Insert(0, "_");
+
+                    name = NonAlphaNumeric.Replace(name, "_");
+
                     return
                     (
-                        name: Path.GetFileNameWithoutExtension(filePath).Replace(" ", string.Empty),
+                        name,
                         path: resourcePath,
                         fileExtension: Path.GetExtension(filePath)
                     );