com.elestrago.unity.package-tools 2.0.7

package/Editor/PackageManifestConfig.cs

@@ -0,0 +1,194 @@
+/*
+MIT License
+
+Copyright (c) 2020 Jeff Campbell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+using System;
+using Playdarium.PackageTool.Tools;
+using UnityEngine;
+
+namespace Playdarium.PackageTool
+{
+	/// <summary>
+	/// <see cref="PackageManifestConfig"/> is an asset config representing a Unity Package. It allows for
+	/// defining the data used on the package json file, the locations of source files/assets that make up the
+	/// package, and a destination for th package source to be distributed at.
+	/// </summary>
+	[CreateAssetMenu(fileName = "PackageManifestConfig", menuName = "JCMG/PackageTools/PackageManifestConfig")]
+	public sealed class PackageManifestConfig : ScriptableObject
+	{
+		/// <summary>
+		/// Describes a dependency that this package requires.
+		/// </summary>
+		[Serializable]
+		public sealed class Dependency
+		{
+			/// <summary>
+			/// The name of the dependent package.
+			/// </summary>
+			public string packageName;
+
+			/// <summary>
+			/// The semantic version of the dependent package in MAJOR.MINOR.PATCH format.
+			/// </summary>
+			public string packageVersion;
+
+			public bool IsEmpty() => string.IsNullOrEmpty(packageName) || string.IsNullOrEmpty(packageVersion);
+		}
+
+		/// <summary>
+		/// Describes the author of this package.
+		/// </summary>
+		[Serializable]
+		public sealed class Author
+		{
+			public string name = "";
+			public string email = "";
+			public string url = "";
+		}
+
+		/// <summary>
+		/// Describes the samples of this package.
+		/// </summary>
+		[Serializable]
+		public sealed class Sample
+		{
+			public string displayName;
+			public string description;
+			public string path;
+
+			public bool IsEmpty() => string.IsNullOrEmpty(displayName)
+			                         || string.IsNullOrEmpty(description)
+			                         || string.IsNullOrEmpty(path);
+		}
+
+		/// <summary>
+		/// A unique id for this <see cref="PackageManifestConfig"/> instance.
+		/// </summary>
+		public string Id => _id;
+
+		public string homepage = "https://github.com/";
+
+		/// <summary>
+		/// A collection of paths to folders and files for the source for the package.
+		/// </summary>
+		// public string[] packageSourcePaths;
+		public string sourcePath;
+
+		public string documentationPath = "Documentation~";
+		public string readmePath = "README.md";
+		public string changelogPath = "CHANGELOG.md";
+		public string licensePath = "LICENSE";
+		public string license = "MIT";
+
+		/// <summary>
+		/// A collection of file/folder paths to exclude from the package.
+		/// </summary>
+		public string[] packageIgnorePaths;
+
+		/// <summary>
+		/// A path to the package source distribution contents.
+		/// </summary>
+		public string packageDestinationPath;
+
+		/// <summary>
+		/// The relative path to the folder where the legacy package will be exported to.
+		/// </summary>
+		public string legacyPackageDestinationPath;
+
+		/// <summary>
+		/// The fully-qualified package name.
+		/// </summary>
+		public string packageName = "";
+
+		/// <summary>
+		/// The package name as it appears in the Package Manager window.
+		/// </summary>
+		public string displayName;
+
+		/// <summary>
+		/// The semantic version of the package in MAJOR.MINOR.PATCH format.
+		/// </summary>
+		public string packageVersion = "1.0.0";
+
+		/// <summary>
+		/// The version of Unity in semantic version format like 2018.1.
+		/// </summary>
+		public string unityVersion = "2021.3";
+
+		/// <summary>
+		/// A description of the package.
+		/// </summary>
+		public string description;
+
+		/// <summary>
+		/// The category the package belongs in.
+		/// </summary>
+		public string category = "unity";
+
+		/// <summary>
+		/// The author of this package.
+		/// </summary>
+		public Author author;
+
+		/// <summary>
+		/// A collection of keywords that describe the package.
+		/// </summary>
+		public string[] keywords;
+
+		/// <summary>
+		/// A collection of packages that this package depends on.
+		/// </summary>
+		public Dependency[] dependencies;
+
+		public Sample[] samples;
+
+		/// <summary>
+		/// A path to the where the VersionConstants.cs file should be created/updated
+		/// </summary>
+		public string versionConstantsPath;
+
+		/// <summary>
+		/// The namespace the generated VersionConstants class will be in. If left blank, this will be
+		/// the global namespace.
+		/// </summary>
+		public string versionConstantsNamespace;
+
+		[SerializeField] private string _id;
+
+		/// <summary>
+		/// Returns a Json <see cref="string"/> representation.
+		/// </summary>
+		/// <returns></returns>
+		public string GenerateJson()
+		{
+			return PackageManifestTools.GenerateJson(this);
+		}
+
+		private void Reset()
+		{
+			packageVersion = EditorConstants.DEFAULT_PACKAGE_VERSION;
+			unityVersion = EditorConstants.DEFAULT_UNITY_VERSION;
+			_id = Guid.NewGuid().ToString();
+		}
+	}
+}

package/Editor/PackageManifestConfig.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: a29f67b488b4458983fd973bbda8c8fa
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {fileID: 2800000, guid: aa27849da66efed40ac33d6d0da5f64f, type: 3}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Playdarium.PackageTool.Editor.asmdef

@@ -0,0 +1,16 @@
+{
+    "name": "Playdarium.PackageTool.Editor",
+    "rootNamespace": "",
+    "references": [],
+    "includePlatforms": [
+        "Editor"
+    ],
+    "excludePlatforms": [],
+    "allowUnsafeCode": false,
+    "overrideReferences": false,
+    "precompiledReferences": [],
+    "autoReferenced": true,
+    "defineConstraints": [],
+    "versionDefines": [],
+    "noEngineReferences": false
+}

package/Editor/Playdarium.PackageTool.Editor.asmdef.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 85045da2336f0504692a6f7d7dfd12b7
+AssemblyDefinitionImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Tools/CodeGenTools.cs

@@ -0,0 +1,145 @@
+/*
+MIT License
+
+Copyright (c) 2020 Jeff Campbell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+using System;
+using System.Globalization;
+using System.IO;
+using UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool.Tools
+{
+	/// <summary>
+	/// Helper methods for code-gen.
+	/// </summary>
+	internal static class CodeGenTools
+	{
+		private const string TEMPLATE =
+@"namespace ${namespace}
+{
+	/// <summary>
+	/// Version info for this library.
+	/// </summary>
+	internal static class VersionConstants
+	{
+		/// <summary>
+		/// The semantic version
+		/// </summary>
+		public const string VERSION = ""${version}"";
+
+		/// <summary>
+		/// The branch of GIT this package was published from.
+		/// </summary>
+		public const string GIT_BRANCH = ""${git_branch}"";
+
+		/// <summary>
+		/// The current GIT commit hash this package was published on.
+		/// </summary>
+		public const string GIT_COMMIT = ""${git_commit}"";
+
+		/// <summary>
+		/// The UTC human-readable date this package was published at.
+		/// </summary>
+		public const string PUBLISH_DATE = ""${publish_date}"";
+
+		/// <summary>
+		/// The UTC time this package was published at.
+		/// </summary>
+		public const string PUBLISH_TIME = ""${publish_utc_time}"";
+	}
+}
+";
+
+		private const string GLOBAL_TEMPLATE =
+@"/// <summary>
+/// Version info for this library.
+/// </summary>
+internal static class VersionConstants
+{
+	/// <summary>
+	/// The semantic version
+	/// </summary>
+	public const string VERSION = ""${version}"";
+
+	/// <summary>
+	/// The branch of GIT this package was published from.
+	/// </summary>
+	public const string GIT_BRANCH = ""${git_branch}"";
+
+	/// <summary>
+	/// The current GIT commit hash this package was published on.
+	/// </summary>
+	public const string GIT_COMMIT = ""${git_commit}"";
+
+	/// <summary>
+	/// The UTC human-readable date this package was published at.
+	/// </summary>
+	public const string PUBLISH_DATE = ""${publish_date}"";
+
+	/// <summary>
+	/// The UTC time this package was published at.
+	/// </summary>
+	public const string PUBLISH_TIME = ""${publish_utc_time}"";
+}
+";
+
+		// Filename
+		private const string FILENAME = "VersionConstants.cs";
+
+		// Logs
+		private const string NO_PATH_SPECIFIED = "A path must be specified for the VersionConstants.cs file to be written " +
+		                                         "to, otherwise this file will not be created.";
+
+		public static void GenerateVersionConstants(PackageManifestConfig config)
+		{
+			if(string.IsNullOrEmpty(config.versionConstantsPath))
+			{
+				Debug.LogWarning(NO_PATH_SPECIFIED);
+				return;
+			}
+
+			// Create folder/file path info
+			var folderPath = Path.GetFullPath(config.versionConstantsPath);
+			var filePath = Path.Combine(folderPath, FILENAME);
+
+			// Create file contents
+			var template = string.IsNullOrEmpty(config.versionConstantsNamespace)
+				? GLOBAL_TEMPLATE
+				: TEMPLATE;
+
+			var fileContents = template
+				.Replace("${namespace}", config.versionConstantsNamespace)
+				.Replace("${version}", config.packageVersion)
+				.Replace("${git_branch}", GitTools.GetBranch())
+				.Replace("${git_commit}", GitTools.GetLongHeadHash())
+				.Replace("${publish_date}", DateTime.UtcNow.ToLongDateString())
+				.Replace("${publish_utc_time}", DateTime.UtcNow.ToString(CultureInfo.InvariantCulture));
+
+			File.WriteAllText(filePath, fileContents);
+
+			var importPath = Path.Combine(config.versionConstantsPath, FILENAME);
+			AssetDatabase.ImportAsset(importPath);
+		}
+	}
+}

package/Editor/Tools/CodeGenTools.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 55647bcc8b6f00c45ad3336e9f952e8d
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/Tools/CommandLineTools.cs

@@ -0,0 +1,68 @@
+/*
+MIT License
+
+Copyright (c) 2020 Jeff Campbell
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+*/
+
+using System;
+using System.Collections.Generic;
+
+namespace Playdarium.PackageTool.Tools
+{
+	/// <summary>
+	/// Helper methods for command-line usage
+	/// </summary>
+	public static class CommandLineTools
+	{
+		// Command-Line Delimiters
+		private const string ARGUMENT_DELIMITER_STR = "=";
+		private const char ARGUMENT_DELIMITER_CHAR = '=';
+
+		/// <summary>
+		/// Returns a more easily-searchable <see cref="Dictionary{TKey,TValue}"/> of command-line arguments.
+		/// </summary>
+		/// <returns></returns>
+		public static Dictionary<string, object> GetKVPCommandLineArguments()
+		{
+			var dict = new Dictionary<string, object>();
+			var arguments = Environment.GetCommandLineArgs();
+			foreach (var argument in arguments)
+			{
+				// If the commandline argument contains a value, parse that and add it
+				if (argument.Contains(ARGUMENT_DELIMITER_STR))
+				{
+					var array = argument.Split(ARGUMENT_DELIMITER_CHAR);
+					var key = array[0].ToLower();
+					var value = array[1];
+
+					dict.Add(key, value);
+				}
+				// Otherwise add the command line argument as a key without a value.
+				else if (!dict.ContainsKey(argument))
+				{
+					dict.Add(argument, null);
+				}
+			}
+
+			return dict;
+		}
+	}
+}

package/Editor/Tools/CommandLineTools.cs.meta

@@ -0,0 +1,11 @@
+fileFormatVersion: 2
+guid: 6bb959778362eb843bb141f1f1960e92
+MonoImporter:
+  externalObjects: {}
+  serializedVersion: 2
+  defaultReferences: []
+  executionOrder: 0
+  icon: {instanceID: 0}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: