com.elestrago.unity.package-tools 2.0.7

package/CAHNGELOG.md

@@ -0,0 +1,130 @@
+# Changelog
+
+---
+
+## [v2.0.7](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.7)
+
+### Fixed
+
+- Newtonsoft Json dependency
+
+---
+
+## [v2.0.6](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.6)
+
+### Fixed
+
+- Remove `npm install` from CI job template
+
+---
+
+## [v2.0.5](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.5)
+
+### Fixed
+
+- Remove `.idea` folder from package
+- Package repository url in README.md
+
+---
+
+## [v2.0.4](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.4)
+
+### Fixed
+
+- Remove `npm install` from CI job for avoid unresolved dependencies conflicts
+- Package initializer window size and make size flexible
+
+---
+
+## [v2.0.3](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.3)
+
+### Fixed
+
+- Links to readme, changelog and license files
+
+---
+
+## [v2.0.2](https://gitlab.com/pd-packages/package-tool/-/tags/v2.0.2)
+
+### Changed
+
+- Migrate to GitLab
+- New package name `com.playdarium.unity.package-tools`
+- CI file generation
+
+---
+
+## [v1.0.3](https://github.com/playdarium/package-tool/releases/tag/v1.0.3)
+
+### Changed
+
+- Fix generated package folder path
+
+---
+
+## [v1.0.2](https://github.com/playdarium/package-tool/releases/tag/v1.0.2)
+
+### Added
+
+- `ExampleProject` for show how work adding samples to package
+
+### Changed
+
+- Update changelog template
+
+---
+
+## [v1.0.1](https://github.com/playdarium/package-tool/releases/tag/v1.0.1)
+
+### Added
+
+- Init package fields validation
+- CIUtils script for generate package and prepare dll configuration
+- Auto generate `Documentation~` and `Samples~` folders when init package
+
+### Changed
+
+- Changed namespace from `Package.PackageTool` to `Playdarium.PackageTool`
+
+---
+
+## [v1.0.0](https://github.com/playdarium/package-tool/releases/tag/v1.0.0)
+
+### Added
+
+- Export `Documentation~` folder to package manifest
+- Export samples to package manifest
+- Fields for copy files README, CHANGELOG, LICENSE
+- Auto filled url for documentation, changelog and license in `package.json`
+
+### Changed
+
+- Make readable json format in `package.json` file
+
+---
+
+## [v1.0.0](https://github.com/playdarium/package-tool/releases/tag/v1.0.0)
+
+### Added
+
+- For new features.
+
+### Changed
+
+- For changes in existing functionality.
+
+### Deprecated
+
+- For soon-to-be removed features.
+
+### Removed
+
+- For now removed features.
+
+### Fixed
+
+- For any bug fixes.
+
+### Security
+
+- In case of vulnerabilities.

package/CAHNGELOG.md.meta

@@ -0,0 +1,7 @@
+fileFormatVersion: 2
+guid: 0efa450279b0a4c68be92211275d49f2
+TextScriptImporter:
+  externalObjects: {}
+  userData: 
+  assetBundleName: 
+  assetBundleVariant: 

package/Editor/CIUtils.cs

@@ -0,0 +1,247 @@
+using System;
+using System.IO;
+using System.Linq;
+using System.Text;
+using Playdarium.PackageTool.Tools;
+using UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool
+{
+	/// <summary>
+	/// Continuous-integration API for package tools.
+	/// </summary>
+	public static class CIUtils
+	{
+		// Command-line arguments
+		private const string ID_ARG_KEY = "id";
+		private const string VERSION_ARG_KEY = "version";
+		private const string PREVIEW_ARG_KEY = "preview";
+		private const string GENERATE_VERSION_CONSTANTS_ARG_KEY = "generateversionconstants";
+
+		// Logs
+		private const string LOG_PREFIX = "[Package Tools] ";
+		private const string CI_STARTING = LOG_PREFIX + "Starting Package Tools CI...";
+		private const string CI_COMPLETE = LOG_PREFIX + "Package Tools CI has completed!";
+		private const string CI_COMMAND_LINE_ARGS_PARSED_FORMAT = LOG_PREFIX + "Parsed CI Command Line Args.\n\n{0}";
+
+		private const string CI_USING_ONLY_CONFIGS_FROM_ARG =
+			LOG_PREFIX + "Using configs matching IDs passed in 'ID' argument";
+
+		private const string CI_FOUND_CONFIGS = LOG_PREFIX + "Found [{0}] configs in project.";
+		private const string CI_USING_ALL_CONFIGS = LOG_PREFIX + "Using all configs in project.";
+		private const string CI_GENERATION_STARTING = LOG_PREFIX + "Starting to generate packages...";
+
+		private const string CI_PACKAGE_NOT_FOUND_FORMAT =
+			LOG_PREFIX + "Could not find a package for ID: [{0}], skipping it.";
+
+		private const string CI_PACKAGE_FOUND_FORMAT = LOG_PREFIX + "Package [{0}] found for ID: [{1}]";
+
+		private const string CI_GENERATING_LEGACY_PACKAGE_FORMAT =
+			LOG_PREFIX + "Generating Legacy Package for Config [{0}] with ID: [{1}]";
+
+		private const string CI_SKIPPING_LEGACY_PACKAGE_FORMAT = LOG_PREFIX +
+		                                                         "Skipping Legacy Package for Config [{0}] with ID: [{1}] as no output path is present in config.";
+
+		private const string CI_GENERATING_PACKAGE_SOURCE_FORMAT =
+			LOG_PREFIX + "Generating Package Source for Config [{0}] with ID: [{1}].";
+
+		private const string CI_SKIPPING_PACKAGE_SOURCE_FORMAT = LOG_PREFIX +
+		                                                         "Skipping Package Source for Config [{0}] with ID: [{1}] as no output path is present in config.";
+
+		private static readonly StringBuilder StringBuilder;
+
+		private static bool IsRunningOnCI => !string.IsNullOrEmpty(Environment.GetEnvironmentVariable("CI"));
+
+		static CIUtils()
+		{
+			StringBuilder = new StringBuilder(8192);
+		}
+
+		/// <summary>
+		/// Attempts to use zero or more <see cref="PackageManifestConfig"/> assets to generate legacy Unity packages
+		/// and Unity source.
+		/// </summary>
+		public static void Generate()
+		{
+			Debug.Log(CI_STARTING);
+
+			PrepareDll();
+
+			try
+			{
+				EditorApplication.LockReloadAssemblies();
+				AssetDatabase.StartAssetEditing();
+
+				// Get command line args and log them
+				var commandLineArgs = CommandLineTools.GetKVPCommandLineArguments();
+
+				StringBuilder.Clear();
+				const string cliArgFormat = "{0} => {1}";
+				foreach (var commandLineArg in commandLineArgs)
+				{
+					StringBuilder.AppendFormat(cliArgFormat, commandLineArg.Key, commandLineArg.Value);
+					StringBuilder.AppendLine();
+				}
+
+				Debug.LogFormat(CI_COMMAND_LINE_ARGS_PARSED_FORMAT, StringBuilder);
+
+				// Attempt to parse CLI-passed version, if present.
+				string version = null;
+				if (commandLineArgs.TryGetValue(VERSION_ARG_KEY, out var versionRawValue))
+					version = (string)versionRawValue;
+
+				// Attempt to parse CLI-passed version, if present.
+				bool? isPreview = null;
+				if (commandLineArgs.TryGetValue(PREVIEW_ARG_KEY, out var previewRawValue))
+					isPreview = bool.Parse((string)previewRawValue);
+
+				// See if we should generate version constants
+				var generateVersionConstants = false;
+				if (commandLineArgs.TryGetValue(
+					    GENERATE_VERSION_CONSTANTS_ARG_KEY,
+					    out var generateVersionConstantsRawValue))
+					generateVersionConstants = bool.Parse(generateVersionConstantsRawValue.ToString());
+
+				// Get all package manifests in project
+				var allPackageManifestConfigs = PackageManifestTools.GetAllConfigs();
+
+				Debug.LogFormat(CI_FOUND_CONFIGS, allPackageManifestConfigs.Length);
+
+				// Check to see if any IDs have been passed for specific configs
+				string[] configIds;
+				if (commandLineArgs.TryGetValue(ID_ARG_KEY, out var arg))
+				{
+					Debug.Log(CI_USING_ONLY_CONFIGS_FROM_ARG);
+
+					const char commaChar = ',';
+					var idArgValue = arg.ToString();
+					configIds = idArgValue.Split(commaChar);
+				}
+				// Otherwise generate all package manifest configs in project.
+				else
+				{
+					Debug.Log(CI_USING_ALL_CONFIGS);
+
+					configIds = allPackageManifestConfigs.Select(x => x.Id).ToArray();
+				}
+
+				// For each matching config ID, find the matching package manifest config and generate any relevant packages.
+				Debug.Log(CI_GENERATION_STARTING);
+				foreach (var configId in configIds)
+				{
+					var matchingConfig = allPackageManifestConfigs.FirstOrDefault(x =>
+						string.Compare(x.Id, configId, StringComparison.OrdinalIgnoreCase) == 0);
+
+					// If a config cannot be found matching config id, skip it and continue.
+					if (matchingConfig == null)
+					{
+						Debug.LogWarningFormat(CI_PACKAGE_NOT_FOUND_FORMAT, configId);
+
+						continue;
+					}
+
+					var configName = matchingConfig.name;
+
+					Debug.LogFormat(CI_PACKAGE_FOUND_FORMAT, configName, configId);
+
+					// Set the CLI passed version if present, otherwise default to checked in version number.
+					if (!string.IsNullOrEmpty(version))
+					{
+						matchingConfig.packageVersion = version;
+						EditorUtility.SetDirty(matchingConfig);
+					}
+
+					// If set to generate version constants, do so.
+					if (generateVersionConstants) CodeGenTools.GenerateVersionConstants(matchingConfig);
+
+					// Otherwise generate the corresponding legacy unity package and package source if their output paths
+					// have been defined
+					if (!string.IsNullOrEmpty(matchingConfig.legacyPackageDestinationPath))
+					{
+						Debug.LogFormat(CI_GENERATING_LEGACY_PACKAGE_FORMAT, configName, configId);
+
+						UnityFileTools.CompileLegacyPackage(matchingConfig);
+					}
+					else
+					{
+						Debug.LogFormat(CI_SKIPPING_LEGACY_PACKAGE_FORMAT, configName, configId);
+					}
+
+					if (!string.IsNullOrEmpty(matchingConfig.packageDestinationPath))
+					{
+						Debug.LogFormat(CI_GENERATING_PACKAGE_SOURCE_FORMAT, configName, configId);
+
+						FileTools.CreateOrUpdatePackageSource(matchingConfig);
+					}
+					else
+					{
+						Debug.LogFormat(CI_SKIPPING_PACKAGE_SOURCE_FORMAT, configName, configId);
+					}
+				}
+			}
+			catch (Exception e)
+			{
+				Debug.LogErrorFormat("An unexpected error occured during package generation:\n\n{0}", e);
+			}
+			finally
+			{
+				AssetDatabase.StopAssetEditing();
+				EditorApplication.UnlockReloadAssemblies();
+			}
+
+			Debug.Log(CI_COMPLETE);
+		}
+
+		[MenuItem("Tools/PackageTools/PrepareDll")]
+		public static void PrepareDll()
+		{
+			try
+			{
+				Debug.Log($"[{nameof(CIUtils)}] PrepareDll");
+
+				var packageManifestConfig = PackageManifestTools.GetAllConfigs().Single();
+				var sourcePath = packageManifestConfig.sourcePath;
+
+				Debug.Log($"[{nameof(CIUtils)}] Find assets in path: {sourcePath}");
+
+				var assets = AssetDatabase.GetAllAssetPaths().Where(s => s.Contains(sourcePath));
+				foreach (var asset in assets)
+				{
+					if (Path.GetExtension(asset) != ".dll")
+						continue;
+
+					var isEditor = Path.GetFileNameWithoutExtension(asset).Contains("Editor")
+					               || asset.Contains("/Editor/");
+					var pluginImporter = (PluginImporter)AssetImporter.GetAtPath(asset);
+					if (isEditor)
+					{
+						pluginImporter.SetCompatibleWithAnyPlatform(false);
+						pluginImporter.SetCompatibleWithEditor(true);
+						Debug.Log($"[{nameof(CIUtils)}] SetCompatibleWithEditor: {asset}");
+					}
+					else
+					{
+						pluginImporter.SetCompatibleWithAnyPlatform(true);
+						pluginImporter.SetExcludeEditorFromAnyPlatform(false);
+						Debug.Log($"[{nameof(CIUtils)}] SetCompatibleWithAnyPlatform and ExcludeEditor: {asset}");
+					}
+
+					pluginImporter.SaveAndReimport();
+				}
+
+				Debug.Log($"[{nameof(CIUtils)}] Complete dll import");
+			}
+			catch (Exception e)
+			{
+				Debug.LogException(e);
+
+				if (IsRunningOnCI)
+					EditorApplication.Exit(1);
+			}
+
+			if (IsRunningOnCI)
+				EditorApplication.Exit(0);
+		}
+	}
+}

package/Editor/CIUtils.cs.meta

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

package/Editor/Drawers/AuthorPropertyDrawer.cs

@@ -0,0 +1,82 @@
+/*
+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 UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool.Drawers
+{
+	/// <summary>
+	/// A property drawer for drawing <see cref="PackageManifestConfig.Author"/>
+	/// </summary>
+	[CustomPropertyDrawer(typeof(PackageManifestConfig.Author))]
+	internal sealed class AuthorPropertyDrawer : PropertyDrawer
+	{
+		private const string NAME_PROPERTY_NAME = "name";
+		private const string EMAIL_PROPERTY_NAME = "email";
+		private const string URL_PROPERTY_NAME = "url";
+
+		private const string NAME_LABEL = "Author Name";
+		private const string EMAIL_LABEL = "Author Email";
+		private const string URL_LABEL = "Author URL";
+
+		private readonly GUIContent _nameGUIContent;
+		private readonly GUIContent _emailGUIContent;
+		private readonly GUIContent _urlGUIContent;
+
+		public AuthorPropertyDrawer()
+		{
+			_nameGUIContent = new GUIContent(NAME_LABEL);
+			_emailGUIContent = new GUIContent(EMAIL_LABEL);
+			_urlGUIContent = new GUIContent(URL_LABEL);
+		}
+
+		public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+		{
+			var nameRect = new Rect(position)
+			{
+				height = EditorGUIUtility.singleLineHeight
+			};
+
+			var emailRect = new Rect(nameRect)
+			{
+				position = new Vector2(position.x, nameRect.y + nameRect.height + 2f)
+			};
+
+			var urlRect = new Rect(emailRect)
+			{
+				position = new Vector2(position.x, emailRect.y + emailRect.height + 2f)
+			};
+
+			EditorGUI.PropertyField(nameRect, property.FindPropertyRelative(NAME_PROPERTY_NAME), _nameGUIContent);
+			EditorGUI.PropertyField(emailRect, property.FindPropertyRelative(EMAIL_PROPERTY_NAME), _emailGUIContent);
+			EditorGUI.PropertyField(urlRect, property.FindPropertyRelative(URL_PROPERTY_NAME), _urlGUIContent);
+		}
+
+		public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
+		{
+			return EditorGUIUtility.singleLineHeight * 3f + 6f;
+		}
+	}
+}

package/Editor/Drawers/AuthorPropertyDrawer.cs.meta

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

package/Editor/Drawers/DependencyPropertyDrawer.cs

@@ -0,0 +1,60 @@
+/*
+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 UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool.Drawers
+{
+	/// <summary>
+	/// A property drawer for drawing <see cref="PackageManifestConfig.Dependency"/>
+	/// </summary>
+	[CustomPropertyDrawer(typeof(PackageManifestConfig.Dependency))]
+	internal sealed class DependencyPropertyDrawer : PropertyDrawer
+	{
+		private const string PACKAGE_NAME_PROPERTY_NAME = "packageName";
+		private const string PACKAGE_VERSION_PROPERTY_NAME = "packageVersion";
+
+		public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+		{
+			var packageRect = new Rect(position)
+			{
+				height = EditorGUIUtility.singleLineHeight
+			};
+
+			var packageVersionRect = new Rect(packageRect)
+			{
+				position = new Vector2(position.x, packageRect.y + packageRect.height)
+			};
+
+			EditorGUI.PropertyField(packageRect, property.FindPropertyRelative(PACKAGE_NAME_PROPERTY_NAME));
+			EditorGUI.PropertyField(packageVersionRect, property.FindPropertyRelative(PACKAGE_VERSION_PROPERTY_NAME));
+		}
+
+		public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
+		{
+			return EditorGUIUtility.singleLineHeight * 2f;
+		}
+	}
+}

package/Editor/Drawers/DependencyPropertyDrawer.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 14741f16085841cc9711fa0107a9c584
+timeCreated: 1554966411

package/Editor/Drawers/SamplePropertyDrawer.cs

@@ -0,0 +1,62 @@
+using Playdarium.PackageTool.Tools;
+using UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool.Drawers
+{
+	[CustomPropertyDrawer(typeof(PackageManifestConfig.Sample))]
+	public class SamplePropertyDrawer : PropertyDrawer
+	{
+		private const string DISPLAY_NAME_PROPERTY_NAME = "displayName";
+		private const string DESCRIPTION_PROPERTY_NAME = "description";
+		private const string PATH_PROPERTY_NAME = "path";
+
+		public override void OnGUI(Rect position, SerializedProperty property, GUIContent label)
+		{
+			var displayNameRect = new Rect(position)
+			{
+				height = EditorGUIUtility.singleLineHeight
+			};
+			displayNameRect.height = EditorConstants.FOLDER_PATH_PICKER_HEIGHT;
+
+			var descriptionRect = new Rect(displayNameRect)
+			{
+				position = new Vector2(position.x, displayNameRect.y + displayNameRect.height + 2)
+			};
+			descriptionRect.height = EditorConstants.FOLDER_PATH_PICKER_HEIGHT;
+
+			var pathRect = new Rect(descriptionRect)
+			{
+				position = new Vector2(position.x, descriptionRect.y + displayNameRect.height + 2),
+			};
+
+			pathRect.width -= EditorConstants.FOLDER_PATH_PICKER_BUFFER;
+			pathRect.height = EditorConstants.FOLDER_PATH_PICKER_HEIGHT;
+			var newPathRect = new Rect(pathRect);
+
+			var pathProperty = property.FindPropertyRelative(PATH_PROPERTY_NAME);
+			EditorGUI.PropertyField(displayNameRect, property.FindPropertyRelative(DISPLAY_NAME_PROPERTY_NAME));
+			EditorGUI.PropertyField(descriptionRect, property.FindPropertyRelative(DESCRIPTION_PROPERTY_NAME));
+			EditorGUI.PropertyField(newPathRect, pathProperty);
+
+			var folderPickerRect = new Rect
+			{
+				position = new Vector2(
+					newPathRect.width + EditorConstants.FOLDER_PATH_PICKER_BUFFER + 10,
+					newPathRect.position.y),
+				width = EditorConstants.FOLDER_PATH_PICKER_HEIGHT,
+				height = EditorConstants.FOLDER_PATH_PICKER_HEIGHT,
+			};
+
+			GUILayoutTools.DrawSourceFolderPicker(
+				folderPickerRect,
+				pathProperty,
+				EditorConstants.SELECT_SAMPLES_PATH_FOLDER_TITLE);
+		}
+
+		public override float GetPropertyHeight(SerializedProperty property, GUIContent label)
+		{
+			return EditorGUIUtility.singleLineHeight * 3f;
+		}
+	}
+}

package/Editor/Drawers/SamplePropertyDrawer.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 84a7cde6b5ef4569a2e1fba5ff3b1a5d
+timeCreated: 1655809044

package/Editor/Drawers.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 710552c69d1d4891b536566eb51c787e
+timeCreated: 1554966389