com.elestrago.unity.package-tools 2.0.7

package/Editor/Utils/PackageInitialize/PackageInitializeWindow.cs

@@ -0,0 +1,92 @@
+using System.IO;
+using UnityEditor;
+using UnityEngine;
+
+namespace Playdarium.PackageTool.Utils.PackageInitialize
+{
+	public class PackageInitializeWindow : EditorWindow
+	{
+		private const string DISPLAY_NAME_FIELD = "Display Name";
+		private const string PACKAGE_NAME_FIELD = "Package Name";
+		private const string SCOPE_FIELD = "Scope";
+		private const string AUTHOR_FIELD = "Author";
+		private const string GIT_URL_FIELD = "Git URL";
+		private const string LICENSE_FIELD = "License";
+
+		private string _displayName = "Package Name";
+		private string _packageName = "com.example.package";
+		private string _scope = "com.example";
+		private string _author = "Name";
+		private string _gitURL = "https://gitlab.com/user/package";
+		private string _license = "MIT";
+
+		public static void Open()
+		{
+			var window = GetWindow<PackageInitializeWindow>(false, "Init Package");
+			window.ShowPopup();
+			window.minSize = new Vector2(300, 150);
+		}
+
+		private void OnGUI()
+		{
+			DrawTextField(DISPLAY_NAME_FIELD, ref _displayName);
+			DrawTextField(PACKAGE_NAME_FIELD, ref _packageName);
+			DrawTextField(SCOPE_FIELD, ref _scope);
+			DrawTextField(AUTHOR_FIELD, ref _author);
+			DrawTextField(GIT_URL_FIELD, ref _gitURL);
+			DrawTextField(LICENSE_FIELD, ref _license);
+
+			if (GUILayout.Button("Create"))
+				CreatePackageFiles();
+		}
+
+		private void CreatePackageFiles()
+		{
+			var valid = ValidateField(DISPLAY_NAME_FIELD, _displayName);
+			valid &= ValidateField(PACKAGE_NAME_FIELD, _packageName);
+			valid &= ValidateField(SCOPE_FIELD, _scope);
+			valid &= ValidateField(AUTHOR_FIELD, _author);
+			valid &= ValidateField(GIT_URL_FIELD, _gitURL);
+			valid &= ValidateField(LICENSE_FIELD, _license);
+
+			if (!valid)
+			{
+				EditorUtility.DisplayDialog("Init Package", "All fields must be completed", "Ok");
+				return;
+			}
+
+			var config = CreateInstance<PackageManifestConfig>();
+			config.displayName = _displayName;
+			config.packageName = _packageName;
+			config.homepage = _gitURL;
+			config.license = _license;
+			config.author = new PackageManifestConfig.Author
+			{
+				name = _author
+			};
+			config.packageDestinationPath = PackageInitializeUtil.RELEASE_FOLDER_NAME;
+			config.sourcePath = Path.Combine(
+				PackageInitializeUtil.ASSETS_FOLDER_NAME,
+				config.author.name,
+				config.displayName.Replace(" ", string.Empty)
+			);
+
+			PackageInitializeUtil.Init(_scope, config);
+
+			if (EditorUtility.DisplayDialog("Init Package", "Successful created", "Ok"))
+				Close();
+		}
+
+		private static bool ValidateField(string name, string value)
+		{
+			if (!string.IsNullOrWhiteSpace(value))
+				return true;
+
+			Debug.LogError($"[{nameof(PackageInitializeWindow)}] Field with name '{name}' cannot be empty");
+			return false;
+		}
+
+		private static void DrawTextField(string label, ref string value)
+			=> value = EditorGUILayout.TextField(label, value);
+	}
+}

package/Editor/Utils/PackageInitialize/PackageInitializeWindow.cs.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: ad10d8fc899f416dadb1cfa838ce234e
+timeCreated: 1662388832

package/Editor/Utils/PackageInitialize.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: e4ce4c1c72b44784a72207369503a9e2
+timeCreated: 1662377237

package/Editor/Utils.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 03966419edf24ae1a3be75fc83721788
+timeCreated: 1662377224

package/Editor.meta

@@ -0,0 +1,3 @@
+fileFormatVersion: 2
+guid: 2f77ac48c6a44b1dab1bc00aabe75b33
+timeCreated: 1655821530

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2019 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.

package/LICENSE.meta

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

package/README.md

@@ -0,0 +1,204 @@
+# <img src="./Documentation~/PackageManifestConfigIcon.png" alt="" width="35" height="35"/> Package Tool
+
+[![NPM package](https://img.shields.io/npm/v/com.elestrago.unity.package-tools?logo=npm&logoColor=fff&label=NPM+package&color=limegreen)](https://www.npmjs.com/package/com.elestrago.unity.package-tools)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+## Installing
+
+Using the native Unity Package Manager introduced in 2017.2, you can add this library as a package by modifying your
+`manifest.json` file found at `/ProjectName/Packages/manifest.json` to include it as a dependency. See the example below
+on how to reference it.
+
+### Install via OpenUPM
+
+The package is available on the [npmjs](https://www.npmjs.com/package/com.elestrago.unity.package-tools)
+registry.
+
+#### Add registry scope
+
+```
+{
+  "dependencies": {
+    ...
+    "com.elestrago.unity.package-tools": "x.x.x",
+    ...
+  },
+  "scopedRegistries": [
+    {
+      "name": "eLeSTRaGo",
+      "url": "https://registry.npmjs.org",
+      "scopes": [
+        "com.elestrago.unity"
+      ]
+    }
+  ]
+}
+```
+
+#### Add package in PackageManager
+
+Open `Window -> Package Manager` choose `Packages: My Regestries` and install package
+
+## Setting up your first package
+
+Creating your first package is a simple process that can be made more complex because information available about Unity
+Package manager is inconsistent right now. This is largely due to it not being widely and officially supported for
+end-users of Unity yet, but starting with 2019.1 will gain more official support.
+
+The first step is to create a `PackageManifestConfig` asset that we can use to define the properties and contents of our
+package. This can be done by right-clicking in the `Project` window and
+selecting `Create -> JCMG -> Package Tools -> Package
+Manifest Config`. This will create an asset named `PackageManifestConfig` in that folder.
+
+<img src="./Documentation~/Inspector.png" width="500">
+
+A `PackageManifestConfig` is broken up into two sections:
+
+* **Package Json:** This section contains fields relating to properties of the `package.json` file that we will need to
+  have in our package root folder. It describes the minimum Unity version that it is compatible with and the version of
+  the package itself [Semantic versioning](https://docs.unity3d.com/Manual/upm-semver.html), a
+  description of the package, and any dependencies it
+  has on other packages. This last part I have the least information about, but is supposed to gain more widespread
+  support in 2019.1.
+* **Package Content and Export:** This section focuses on defining the folders/files that make up the content (including
+  code and assets) that make up the package itself and a location that the content will be published to when clicking on
+  the button labeled `Export Package Source`.
+
+For convenience sake, I have added file and folder pickers as buttons to the right of these fields that make it easier
+to add relative file/folder paths from the Assets folder for package source and export location.
+
+There are also options for excluding specific files and/or folders from the package source that might otherwise be
+included. This can be useful for example, if there are unit tests or example content located within your package source
+path that you would not want to include directly or indirectly. Folders and files can be excluded by adding them to
+the **ExcludePaths** list.
+
+Recently I have found myself manually creating a `VersionConstants` static class containing versioning information about
+the package itself. This can be useful for displaying to a user or checking for updates outside of the native Unity
+PackageManager window.. Since updating this file by hand can be error-prone or easy to forget, this can now be
+configured on a `PackageManifestConfig` and generated using a new action `Generate VersionConstants.cs` on the config's
+inspector.
+
+**Example VersionConstants.cs used in JCMG.PackageTools**
+
+```csharp
+namespace JCMG.PackageTools.Editor
+{
+	/// <summary>
+	/// Version info for this library.
+	/// </summary>
+	internal static class VersionConstants
+	{
+		/// <summary>
+		/// The semantic version
+		/// </summary>
+		public const string VERSION = "1.3.0";
+
+		/// <summary>
+		/// The branch of GIT this package was published from.
+		/// </summary>
+		public const string GIT_BRANCH = "develop";
+
+		/// <summary>
+		/// The current GIT commit hash this package was published on.
+		/// </summary>
+		public const string GIT_COMMIT = "57aec574ed19746de42ffa5032358562fb041ebf";
+
+		/// <summary>
+		/// The UTC human-readable date this package was published at.
+		/// </summary>
+		public const string PUBLISH_DATE = "Friday, May 1, 2020";
+
+		/// <summary>
+		/// The UTC time this package was published at.
+		/// </summary>
+		public const string PUBLISH_TIME = "05/01/2020 08:26:31";
+	}
+}
+
+```
+
+The contents of this file can be configured based on the use of a text template. A default one is provided
+at `JCMG\PackageTools\Scripts\Editor\Templates\VersionConstants.txt` and a custom template can be used instead by
+providing it's meta GUID on the `PackageManifestConfig` `versionTemplateGuid` field. There is an example of this in the
+development project
+
+Example Template
+
+```csharp
+namespace JCMG.PackageTools.Editor
+{
+	/// <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}";
+	}
+}
+
+```
+
+## Generating packages from command-line
+
+It can be desirable at times to generate legacy Unity packages and/or package source from the command-line so that they
+can be created and distributed as part of a continuous integration (CI) process. For example, you may want to trigger a
+process every time the repository is updated and source files changed so that a new package is created and made
+available to users. This can be done by launching the Unity Editor from the command line and supplying the appropriate
+arguments.
+
+**Example Command-Line Call**
+
+`"D:\Program Files\2019.4.11f1\Editor\Unity.exe" -quit -batchmode -executeMethod JCMG.PackageTools.Editor.PackageToolsCI.Generate version=1.0.1 GenerateVersionConstants=true`
+
+In this case, the `-executeMethod JCMG.PackageTools.Editor.PackageToolsCI.Generate` is the CLI argument that will
+trigger the PackageTools CI process to execute. By default, this will find all `PackageManifestConfig` instances in the
+project and if they have an appropriate output path will generate the legacy Unity package and/or package source.
+Progress will be output to the Unity Editor player log.
+
+### Arguments
+
+#### ID
+
+An optional `ID` CLI argument (case-insensitive) that can be supplied with one or more `ID` values to limit the package
+generation to a subset of `PackageManifestConfig` instances in the project if so desired. These `ID` values should
+correspond to the `ID` displayed on the `PackageManifestConfig` inspector for that instance. If not supplied, all
+
+**Example ID Argument Usage (for three ID values passed)**
+
+`id=cb87cda2-0bfa-44dc-b583-ae61ff81efcb,e1725f4a-f9f3-42c0-ac15-756f017c90ed,6a406891-59d5-430a-815d-c252deae5d5b`
+
+#### Version
+
+An optional `Version` CLI argument (case-insensitive) can be supplied which will both override and set the value of the
+package version used on the `PackageManifestConfig` `packageVersion` field. This can be useful where the semantic
+package version value should be coming from an external source to the Unity project.
+
+#### GenerateVersionConstants
+
+An optional `GenerateVersionConstants` CLI argument (case-insensitive) can be supplied which will force
+the `VersionConstants` file to be written out prior to generating the package (if a path is specified for it on
+the `PackageManifestConfig`). This can be useful where this file is created as a result of a CI build and has it's
+version number set by the `version` argument.

package/README.md.meta

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

package/package.json

@@ -0,0 +1,41 @@
+{
+  "name": "com.elestrago.unity.package-tools",
+  "version": "2.0.7",
+  "displayName": "Package Tool",
+  "description": "Tool for create unity packages",
+  "category": "unity",
+  "unity": "2021.3",
+  "homepage": "https://gitlab.com/elestrago-pkg/package-tool",
+  "documentationUrl": "https://gitlab.com/elestrago-pkg/package-tool/-/blob/main/README.md",
+  "changelogUrl": "https://gitlab.com/elestrago-pkg/package-tool/-/blob/main/CHANGELOG.md",
+  "licensesUrl": "https://gitlab.com/elestrago-pkg/package-tool/-/blob/main/LICENSE",
+  "license": "MIT",
+  "keywords": [
+    "unity",
+    "package",
+    "upm",
+    "npm"
+  ],
+  "dependencies": {
+    "com.unity.nuget.newtonsoft-json": "3.2.1"
+  },
+  "samples": [
+    {
+      "displayName": "Example Project",
+      "description": "This is example project for check test samples",
+      "path": "Samples~/Example Project"
+    }
+  ],
+  "author": {
+    "name": "eLeSTRaGo",
+    "email": "elestrago63@gmail.com",
+    "url": "https://gitlab.com/elestrago"
+  },
+  "repository": {
+    "type": "git",
+    "url": "https://gitlab.com/elestrago-pkg/package-tool.git"
+  },
+  "bugs": {
+    "url": "https://gitlab.com/elestrago-pkg/package-tool/-/issues"
+  }
+}

package/package.json.meta

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