fix non-alphanumeric characters in filenames

Author: András Kurai

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/Assets/AutSoft.UnityResourceGenerator.Sample/ResourcePaths.cs

@@ -3,6 +3,7 @@
 namespace AutSoft.UnityResourceGenerator.Sample
 {
     // ReSharper disable PartialTypeWithSinglePart
+    // ReSharper disable InconsistentNaming
     public static partial class ResourcePaths
     {
         public static partial class Scenes
@@ -28,13 +29,26 @@ public static partial class Materials
             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)
                     );

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

@@ -15,6 +15,7 @@ public static string CreateResourceFile(ResourceContext context)
 namespace {0}
 {
     // ReSharper disable PartialTypeWithSinglePart
+    // ReSharper disable InconsistentNaming
     public static partial class {1}
     {";
 
@@ -27,6 +28,7 @@ public static partial class {1}
             const string fileBeginNoNamespace =
 @"
 // ReSharper disable PartialTypeWithSinglePart
+// ReSharper disable InconsistentNaming
 public static partial class {1}
 {";
 

UnityResourceGenerator/Assets/AutSoft.UnityResourceGenerator/Editor/Generation/Modules/AllResources.cs

@@ -1,6 +1,6 @@
 {
     "name": "com.autsoft.unityresourcegenerator",
-    "version": "0.2.0",
+    "version": "0.3.0",
     "displayName": "Unity Resource Generator",
     "description": "Generate path strings for Resources.Load",
     "license": "MIT",