com.elestrago.unity.package-tools 2.3.0 → 2.5.1

package/CAHNGELOG.md

@@ -2,6 +2,43 @@
 
 ---
 
+## [2.5.1](https://gitlab.com/elestrago-pkg/package-tool/-/tags/2.5.1)
+
+### Changed
+
+- Broadened `unity-package-release` skill triggers to cover generic commit phrasings such as "commit all changes".
+
+---
+
+## [2.5.0](https://gitlab.com/elestrago-pkg/package-tool/-/tags/2.5.0)
+
+### Added
+
+- Added `examples` section to `unity-package-docs` driven by `[CreateAssetMenu]`/`[MenuItem]`/public-static API entry points, one chunk per entry under `Documentation~/examples/`.
+
+### Changed
+
+- Made `CommandLineTools`, `GitTools`, `PackageInitializeTemplates`, `PackageInitializeUtil`, and `GitTools.Run` non-public so the supported entry points are `CIUtils.Generate` and `Tools/PackageTools/Init Package`.
+
+### Removed
+
+- Removed `samples` section from `unity-package-docs` (replaced by `examples`).
+
+### Fixed
+
+- Fixed `unity-package-docs` scanner missing expression-bodied methods (`... => Body();`).
+- Fixed broken nested-type anchor references in `Documentation~/manual.md` (e.g. `PackageManifestConfig.CopyEntry`).
+
+---
+
+## [2.4.0](https://gitlab.com/elestrago-pkg/package-tool/-/tags/2.4.0)
+
+### Added
+
+- Added `unity-package-release` skill sample for cutting `V-{version}` release commits.
+
+---
+
 ## [2.3.0](https://gitlab.com/elestrago-pkg/package-tool/-/tags/2.3.0)
 
 ### Added

package/Documentation~/examples/ciutils-generate.md

@@ -0,0 +1,41 @@
+<!-- generated by unity-package-docs; safe to regenerate -->
+
+# Package Tool — Example: CIUtils.Generate
+
+**Kind:** static-method
+
+**Entry point:** [CIUtils](../api.md#ciutils)
+
+**Declared at:** `Assets/Package/PackageTool/Editor/CIUtils.cs:65`
+
+## What it does
+
+The CI entry point. Reads `id=<guid>[,<guid>...]`, `version=<semver>`, `preview=<bool>`, and `generateversionconstants=<bool>` from the command line (case-insensitive `key=value` pairs), filters the [PackageManifestConfig](../api.md#packagemanifestconfig) assets to process, optionally overrides each config's `packageVersion`, optionally runs [CodeGenTools.GenerateVersionConstants](../api.md#codegentools), and exports the package source via [FileTools.CreateOrUpdatePackageSource](../api.md#filetools). Wraps the work in `LockReloadAssemblies` + `StartAssetEditing` to avoid mid-export refreshes.
+
+## Snippet
+
+```bash
+# Headless build — call from CI after PrepareDll has fixed plugin flags.
+"$UNITY_PATH" \
+  -batchmode \
+  -quit \
+  -projectPath "$PROJECT_PATH" \
+  -executeMethod PackageTool.CIUtils.Generate \
+  -id ea4351b5-3f49-4afc-8996-ec7b9eb43204 \
+  -version 2.4.1 \
+  -generateversionconstants true \
+  -logFile -
+```
+
+```csharp
+// Or invoke directly from an editor script — Generate() reads -id / -version /
+// -generateversionconstants from Environment.GetCommandLineArgs itself.
+PackageTool.CIUtils.Generate();
+```
+
+## Observable effect
+
+- `Release/<packageName>/` is created or updated with the exported package layout (sources, package.json, README, CHANGELOG, LICENSE, Samples~, Documentation~).
+- `Release/package.json` is rewritten with the version, dependencies, and samples block derived from the config.
+- If `generateversionconstants=true`, a new `VersionConstants.cs` is emitted at the configured path before export.
+- Console prints `[Package Tools]` lines summarizing what was processed; the editor does not exit (unlike `PrepareDll`).

package/Documentation~/examples/create-packagemanifestconfig.md

@@ -0,0 +1,47 @@
+<!-- generated by unity-package-docs; safe to regenerate -->
+
+# Package Tool — Example: Create a PackageManifestConfig
+
+**Kind:** create-asset
+
+**Entry point:** [PackageManifestConfig](../api.md#packagemanifestconfig)
+
+**Declared at:** `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:37`
+
+**Create menu:** `Assets > Create > JCMG/PackageTools/PackageManifestConfig`
+
+## What it does
+
+Creates the ScriptableObject that drives every other entry point — package name, version, sources, dependencies, samples, and the destination path the **Export Package Source** inspector button and `CIUtils.Generate` both read. One config asset per Unity package; everything else (CHANGELOG, README, asmdef wiring, exported `package.json`) is derived from its fields.
+
+## Snippet
+
+```csharp
+using PackageTool;
+using UnityEditor;
+using UnityEngine;
+
+public static class CreatePackageManifestConfigExample
+{
+    [MenuItem("Tools/Examples/Create PackageManifestConfig")]
+    public static void Run()
+    {
+        var config = ScriptableObject.CreateInstance<PackageManifestConfig>();
+        config.packageName = "com.example.foo";
+        config.displayName = "Example Foo";
+        config.packageVersion = "0.1.0";
+        config.unityVersion = "2021.3";
+        config.sourcePath = "Assets/Package/Foo";
+        config.packageDestinationPath = "Release";
+
+        AssetDatabase.CreateAsset(config, "Assets/PackageManifest/PackageManifestConfig.asset");
+        AssetDatabase.SaveAssets();
+    }
+}
+```
+
+## Observable effect
+
+- A new asset appears at `Assets/PackageManifest/PackageManifestConfig.asset`.
+- Selecting it in the Project view renders the inspector with **Generate VersionConstants.cs**, **Export Package Source**, and **Export as Legacy Package** buttons.
+- The same `Assets > Create > JCMG/PackageTools/PackageManifestConfig` menu entry yields the same asset interactively if you prefer GUI.

package/Documentation~/examples/init-package.md

@@ -0,0 +1,30 @@
+<!-- generated by unity-package-docs; safe to regenerate -->
+
+# Package Tool — Example: Init Package
+
+**Kind:** menu-item
+
+**Entry point:** [MenuItems](../api.md#menuitems)
+
+**Declared at:** `Assets/Package/PackageTool/Editor/MenuItems.cs:9`
+
+**Menu path:** `Tools/PackageTools/Init Package`
+
+## What it does
+
+Opens the **Init Package** editor window ([PackageInitializeWindow](../api.md#packageinitializewindow)), which scaffolds a new Unity package: creates `Assets/Package/<scope>/` with `Editor/` (and optionally `Runtime/`), root files (`README.md`, `CAHNGELOG.md`, `LICENSE`), `Documentation~/`, and a sibling `PackageManifestConfig.asset` populated from the form's fields. The internal helpers that do the on-disk work are intentionally not part of the public surface — the window is the supported entry point.
+
+## Snippet
+
+```csharp
+// MenuItems is internal, so other assemblies can't invoke OpenAboutModalDialog
+// directly. Open the window via PackageInitializeWindow.Open(), or use the menu.
+PackageTool.Utils.PackageInitialize.PackageInitializeWindow.Open();
+// Or interactively: Tools > PackageTools > Init Package
+```
+
+## Observable effect
+
+- The **Init Package** editor window opens. Fill in package name, display name, scope, author, license, and unity version, then click **Create**.
+- On Create: `Assets/Package/<scope>/` and `Assets/PackageManifest/PackageManifestConfig.asset` are written; the inspector for the new config asset shows the **Generate VersionConstants.cs** / **Export Package Source** / **Export as Legacy Package** buttons.
+- The project compiles after the next assembly reload.

package/Documentation~/examples/preparedll.md

@@ -0,0 +1,39 @@
+<!-- generated by unity-package-docs; safe to regenerate -->
+
+# Package Tool — Example: PrepareDll
+
+**Kind:** menu-item
+
+**Entry point:** [CIUtils](../api.md#ciutils)
+
+**Declared at:** `Assets/Package/PackageTool/Editor/CIUtils.cs:197`
+
+**Menu path:** `Tools/PackageTools/PrepareDll`
+
+## What it does
+
+Fixes the platform flags on every plugin (`.dll`) under the configured package source before export, so the published package's `PluginImporter` settings match what the Editor needs (no spurious `Any Platform` toggles that would otherwise leak into consumers). When the `CI` environment variable is set, the method calls `EditorApplication.Exit` with code 0 on success or 1 on failure — designed to be the final step of a batch-mode build before the export job moves on.
+
+## Snippet
+
+```bash
+# Run from CI or any shell — replace UNITY_PATH and PROJECT_PATH with your values.
+"$UNITY_PATH" \
+  -batchmode \
+  -quit \
+  -projectPath "$PROJECT_PATH" \
+  -executeMethod PackageTool.CIUtils.PrepareDll \
+  -logFile -
+# Or interactively: Tools > PackageTools > PrepareDll
+```
+
+```csharp
+// Same call from an editor script (no Exit when CI env var is unset):
+PackageTool.CIUtils.PrepareDll();
+```
+
+## Observable effect
+
+- Every `.dll` under each `PackageManifestConfig.sourcePath` has its `PluginImporter` flags normalized; meta files are rewritten as a result and may show up in `git status`.
+- Console prints `[Package Tools]` log lines for each plugin touched.
+- In CI (`CI=1` or similar), the editor exits 0 on success or 1 if any plugin processing throws — wire this into your pipeline as the gate before `CIUtils.Generate`.

package/Documentation~/examples.md

@@ -0,0 +1,25 @@
+<!-- generated by unity-package-docs; safe to regenerate -->
+
+# Package Tool — Examples
+
+Short, focused usage examples that exercise this package's public API. Each example is independent and links into the API reference (`api.md`) for the type or member it calls. Snippets are paste-ready and use only public API — copy one into a fresh project to reach the same observable effect.
+
+## Quick start
+
+Start with **Create a PackageManifestConfig** to produce the config asset that drives every other entry point, then run **Tools > PackageTools > Init Package** (`init-package`) to scaffold a new package skeleton against it. For automated builds, **CIUtils.Generate** is the batch-mode entry point and **Tools > PackageTools > PrepareDll** (`preparedll`) is the DLL platform-flag fix-up step that typically runs immediately before it.
+
+## Contents
+
+| Example | Kind | Entry point |
+|---------|------|-------------|
+| [Create a PackageManifestConfig](examples/create-packagemanifestconfig.md) | create-asset | [PackageManifestConfig](api.md#packagemanifestconfig) |
+| [Init Package](examples/init-package.md) | menu-item | [MenuItems](api.md#menuitems) |
+| [PrepareDll](examples/preparedll.md) | menu-item | [CIUtils](api.md#ciutils) |
+| [CIUtils.Generate](examples/ciutils-generate.md) | static-method | [CIUtils](api.md#ciutils) |
+
+This package also ships Unity samples importable from Package Manager → Package Tool → Samples → `Example Sample`, `Claude Skills`. Those samples are not duplicated here — import them via Package Manager if you want the full asset content.
+
+## Notes
+
+- The `PackageTool.Tools.*` (`CommandLineTools`, `GitTools`) and `PackageTool.Utils.PackageInitialize.*` (`PackageInitializeTemplates`, `PackageInitializeUtil`) helpers were public in earlier revisions and dropped to `internal` to make the public surface intentional. They still exist and are used by `CIUtils.Generate`/`Init Package` internally; they're just no longer documented as consumer-facing entry points.
+- All entry points listed here are editor-only (single asmdef `Playdarium.PackageTool.Editor`, `includePlatforms: ["Editor"]`); call them from editor scripts or batch mode, not from runtime code.

package/Documentation~/manual.md

@@ -64,16 +64,16 @@ Defined at `Assets/Package/PackageTool/Editor/PackageManifestConfig.cs:37`. Crea
 - **Package json metadata:** `homepage`, `packageName`, `displayName`, `packageVersion`, `unityVersion`, `description`, `category`, `license`, `keywords` (`string[]`), `author` (`Author`), `dependencies` (`Dependency[]`).
 - **Package content paths:** `sourcePath`, `documentationPath` (default `Documentation~`), `readmePath` (default `README.md`), `changelogPath` (default `CHANGELOG.md`), `licensePath` (default `LICENSE`), `packageIgnorePaths` (`string[]`).
 - **Export targets:** `packageDestinationPath`, `legacyPackageDestinationPath`.
-- **Staging:** `samples` ([`Sample[]`](api.md#sample)), `copyEntries` ([`CopyEntry[]`](api.md#packagemanifestconfigcopyentry)).
+- **Staging:** `samples` ([`Sample[]`](api.md#sample)), `copyEntries` ([`CopyEntry[]`](api.md#packagemanifestconfig-copyentry)).
 - **Code generation:** `versionConstantsPath`, `versionConstantsNamespace`.
 - **Hidden:** `_id` (Guid; surfaced via `Id` property; used by `CIUtils.Generate id=<guid>` filtering).
 
 Nested `[Serializable]` types, each with a `PropertyDrawer` in `PackageTool.Drawers`:
 
 - [`Author`](api.md#author) — `name`, `email`, `url` (`string`).
-- [`Dependency`](api.md#packagemanifestconfigdependency) — `packageName`, `packageVersion` (`string`); `IsEmpty()` is true when either is blank.
+- [`Dependency`](api.md#packagemanifestconfig-dependency) — `packageName`, `packageVersion` (`string`); `IsEmpty()` is true when either is blank.
 - [`Sample`](api.md#sample) — `sourcePath`, `displayName`, `description`, `folderName` (`string`); `IsEmpty()` is true when any of `displayName`/`sourcePath`/`folderName` is blank. Resulting on-disk path is `{packageDestinationPath}/Samples~/{folderName}`.
-- [`CopyEntry`](api.md#packagemanifestconfigcopyentry) — `sourcePath`, `destinationPath` (`string`); `IsEmpty()` is true when `sourcePath` is blank. See **Copy Entries staging** below.
+- [`CopyEntry`](api.md#packagemanifestconfig-copyentry) — `sourcePath`, `destinationPath` (`string`); `IsEmpty()` is true when `sourcePath` is blank. See **Copy Entries staging** below.
 
 ### Export pipeline
 
@@ -89,7 +89,7 @@ Nested `[Serializable]` types, each with a `PropertyDrawer` in `PackageTool.Draw
 
 ### Copy Entries staging
 
-`copyEntries` is a `PackageManifestConfig` field added in 2.0.12. Each [`CopyEntry`](api.md#packagemanifestconfigcopyentry) names a source path and a destination folder; entries run **first** in the export pipeline (step 4 above) so downstream steps — including the recursive source copy and the `CopySamplesToDirectory` step — can pick up the staged content and ship it into `packageDestinationPath`.
+`copyEntries` is a `PackageManifestConfig` field added in 2.0.12. Each [`CopyEntry`](api.md#packagemanifestconfig-copyentry) names a source path and a destination folder; entries run **first** in the export pipeline (step 4 above) so downstream steps — including the recursive source copy and the `CopySamplesToDirectory` step — can pick up the staged content and ship it into `packageDestinationPath`.
 
 **Folder source.** The folder's *content* is merged directly into `destinationPath` (no `destinationPath/{sourceName}` wrapper). Same-named files are overwritten via `File.Copy(..., overwrite: true)`; unrelated files already in the destination are left in place. This is the merge semantics needed to chain into a `Sample` whose `sourcePath` is the same folder.
 

package/Editor/Tools/CommandLineTools.cs

@@ -30,7 +30,7 @@ namespace PackageTool.Tools
 	/// <summary>
 	/// Helper methods for command-line usage
 	/// </summary>
-	public static class CommandLineTools
+	internal static class CommandLineTools
 	{
 		// Command-Line Delimiters
 		private const string ARGUMENT_DELIMITER_STR = "=";
@@ -65,4 +65,4 @@ namespace PackageTool.Tools
 			return dict;
 		}
 	}
-}
+}

package/Editor/Tools/GitTools.cs

@@ -30,11 +30,15 @@ namespace PackageTool.Tools
 	/// <summary>
 	/// Helper methods for retrieving git information
 	/// </summary>
-	public static class GitTools
+	internal static class GitTools
 	{
 		private const string GIT_APPLICATION = "git";
 
-		public static string Run(string cmd)
+		public static string GetBranch() => Run("rev-parse --abbrev-ref HEAD");
+
+		public static string GetLongHeadHash() => Run("rev-parse HEAD");
+
+		private static string Run(string cmd)
 		{
 			// NOTE: This currently expects that you have git included in your PATH.
 			var p = new Process();
@@ -52,15 +56,5 @@ namespace PackageTool.Tools
 
 			return output;
 		}
-
-		public static string GetBranch()
-		{
-			return Run("rev-parse --abbrev-ref HEAD");
-		}
-
-		public static string GetLongHeadHash()
-		{
-			return Run("rev-parse HEAD");
-		}
 	}
-}
+}

package/Editor/Utils/PackageInitialize/PackageInitializeTemplates.cs

@@ -2,7 +2,7 @@ using System;
 
 namespace PackageTool.Utils.PackageInitialize
 {
-	public static class PackageInitializeTemplates
+	internal static class PackageInitializeTemplates
 	{
 		public static string CreateChangelog(string homepage) => @$"# Changelog
 

package/Editor/Utils/PackageInitialize/PackageInitializeUtil.cs

@@ -4,7 +4,7 @@ using UnityEngine;
 
 namespace PackageTool.Utils.PackageInitialize
 {
-	public static class PackageInitializeUtil
+	internal static class PackageInitializeUtil
 	{
 		public const string ASSETS_FOLDER_NAME = "Assets";
 		public const string RELEASE_FOLDER_NAME = "Release";

package/README.md

@@ -29,7 +29,7 @@ Add the package to `Packages/manifest.json`:
     }
   ],
   "dependencies": {
-    "com.elestrago.unity.package-tools": "2.3.0"
+    "com.elestrago.unity.package-tools": "2.5.1"
   }
 }
 ```
@@ -60,7 +60,7 @@ CIUtils.Generate();
 
 - [Manual](Documentation~/manual.md) — concepts and architecture.
 - [API Reference](Documentation~/api.md) — every public type and member.
-- [Samples](Documentation~/samples.md) — how the sample project in this repo uses the package.
+- [Examples](Documentation~/examples.md) — short usage examples for the public API.
 
 ## License