@aneuhold/core-ts-lib 2.3.1 → 2.3.3

package/CHANGELOG.md

@@ -5,6 +5,25 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
 and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html).
 
+## 🔖 [2.3.3] (2025-10-16)
+
+### 🏗️ Changed
+
+- Added JSDoc comments to all public types in `src/types` for improved documentation and clarity
+- Updated `JsonWithVersionProperty`, `PackageJson`, `PackageJsonInfo`, and `PackageJsonMap` interfaces with detailed descriptions
+
+## 🔖 [2.3.2] (2025-07-04)
+
+### ✅ Added
+
+- New `hasChangesComparedToMain` method in `FileSystemService` to check if directory has changes compared to main branch
+- New `getGitDiffCommand` private method in `FileSystemService` to determine appropriate git diff command
+
+### 🏗️ Changed
+
+- Updated `PackageServiceUtils.bumpVersionAndInitializeChangelog` to check for changes before version bumping
+- Package version bump now skips if no changes are detected compared to main branch
+
 ## 🔖 [2.2.14] (2025-06-26)
 
 ### 🏗️ Changed
@@ -47,6 +66,8 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
 
 <!-- Link References -->
 
+[2.3.3]: https://github.com/aneuhold/ts-libs/compare/core-ts-lib-v2.3.2...core-ts-lib-v2.3.3
+[2.3.2]: https://github.com/aneuhold/ts-libs/compare/core-ts-lib-v2.2.14...core-ts-lib-v2.3.2
 [2.2.14]: https://github.com/aneuhold/ts-libs/compare/core-ts-lib-v2.2.13...core-ts-lib-v2.2.14
 [2.2.13]: https://github.com/aneuhold/ts-libs/compare/core-ts-lib-v2.2.12...core-ts-lib-v2.2.13
 [2.2.12]: https://github.com/aneuhold/ts-libs/releases/tag/core-ts-lib-v2.2.12

package/lib/types/JsonWithVersionProperty.d.ts

@@ -1,3 +1,7 @@
+/**
+ * Represents a JSON object with a required `version` property.
+ * Used as a base interface for package metadata types.
+ */
 export interface JsonWithVersionProperty {
     version: string;
 }

package/lib/types/JsonWithVersionProperty.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"JsonWithVersionProperty.d.ts","sourceRoot":"","sources":["../../src/types/JsonWithVersionProperty.ts"],"names":[],"mappings":"AAAA,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB"}
+{"version":3,"file":"JsonWithVersionProperty.d.ts","sourceRoot":"","sources":["../../src/types/JsonWithVersionProperty.ts"],"names":[],"mappings":"AAAA;;;GAGG;AACH,MAAM,WAAW,uBAAuB;IACtC,OAAO,EAAE,MAAM,CAAC;CACjB"}

package/lib/types/JsonWithVersionProperty.ts

@@ -1,3 +1,7 @@
+/**
+ * Represents a JSON object with a required `version` property.
+ * Used as a base interface for package metadata types.
+ */
 export interface JsonWithVersionProperty {
   version: string;
 }

package/lib/types/PackageJson.d.ts

@@ -1,4 +1,8 @@
 import { JsonWithVersionProperty } from './JsonWithVersionProperty.js';
+/**
+ * Represents the contents of a `package.json` file, including dependencies and metadata.
+ * Extends JsonWithVersionProperty for version tracking.
+ */
 export interface PackageJson extends JsonWithVersionProperty {
     name: string;
     packageManager?: string;

package/lib/types/PackageJson.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PackageJson.d.ts","sourceRoot":"","sources":["../../src/types/PackageJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE,MAAM,WAAW,WAAY,SAAQ,uBAAuB;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/C"}
+{"version":3,"file":"PackageJson.d.ts","sourceRoot":"","sources":["../../src/types/PackageJson.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,uBAAuB,EAAE,MAAM,8BAA8B,CAAC;AAEvE;;;GAGG;AACH,MAAM,WAAW,WAAY,SAAQ,uBAAuB;IAC1D,IAAI,EAAE,MAAM,CAAC;IACb,cAAc,CAAC,EAAE,MAAM,CAAC;IACxB,YAAY,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACtC,eAAe,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IACzC,gBAAgB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;IAC1C,oBAAoB,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAC;CAC/C"}

package/lib/types/PackageJson.ts

@@ -1,5 +1,9 @@
 import { JsonWithVersionProperty } from './JsonWithVersionProperty.js';
 
+/**
+ * Represents the contents of a `package.json` file, including dependencies and metadata.
+ * Extends JsonWithVersionProperty for version tracking.
+ */
 export interface PackageJson extends JsonWithVersionProperty {
   name: string;
   packageManager?: string;

package/lib/types/PackageJsonInfo.d.ts

@@ -1,4 +1,8 @@
 import { PackageJson } from './PackageJson.js';
+/**
+ * Contains the parsed contents and file path of a package.json file.
+ * Used for package metadata management.
+ */
 export interface PackageJsonInfo {
     packageJsonContents: PackageJson;
     packageJsonPath: string;

package/lib/types/PackageJsonInfo.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PackageJsonInfo.d.ts","sourceRoot":"","sources":["../../src/types/PackageJsonInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C,MAAM,WAAW,eAAe;IAC9B,mBAAmB,EAAE,WAAW,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC;CACzB"}
+{"version":3,"file":"PackageJsonInfo.d.ts","sourceRoot":"","sources":["../../src/types/PackageJsonInfo.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,kBAAkB,CAAC;AAE/C;;;GAGG;AACH,MAAM,WAAW,eAAe;IAC9B,mBAAmB,EAAE,WAAW,CAAC;IACjC,eAAe,EAAE,MAAM,CAAC;CACzB"}

package/lib/types/PackageJsonInfo.ts

@@ -1,5 +1,9 @@
 import { PackageJson } from './PackageJson.js';
 
+/**
+ * Contains the parsed contents and file path of a package.json file.
+ * Used for package metadata management.
+ */
 export interface PackageJsonInfo {
   packageJsonContents: PackageJson;
   packageJsonPath: string;

package/lib/types/PackageJsonMap.d.ts

@@ -1,4 +1,8 @@
 import { PackageJsonInfo } from './PackageJsonInfo.js';
+/**
+ * Maps package names to their corresponding PackageJsonInfo objects.
+ * Useful for managing multiple package.json files in a monorepo.
+ */
 export interface PackageJsonMap {
     [packageName: string]: PackageJsonInfo;
 }

package/lib/types/PackageJsonMap.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"PackageJsonMap.d.ts","sourceRoot":"","sources":["../../src/types/PackageJsonMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD,MAAM,WAAW,cAAc;IAC7B,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,CAAC;CACxC"}
+{"version":3,"file":"PackageJsonMap.d.ts","sourceRoot":"","sources":["../../src/types/PackageJsonMap.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,eAAe,EAAE,MAAM,sBAAsB,CAAC;AAEvD;;;GAGG;AACH,MAAM,WAAW,cAAc;IAC7B,CAAC,WAAW,EAAE,MAAM,GAAG,eAAe,CAAC;CACxC"}

package/lib/types/PackageJsonMap.ts

@@ -1,5 +1,9 @@
 import { PackageJsonInfo } from './PackageJsonInfo.js';
 
+/**
+ * Maps package names to their corresponding PackageJsonInfo objects.
+ * Useful for managing multiple package.json files in a monorepo.
+ */
 export interface PackageJsonMap {
   [packageName: string]: PackageJsonInfo;
 }

package/package.json

@@ -2,7 +2,7 @@
   "name": "@aneuhold/core-ts-lib",
   "author": "Anton G. Neuhold Jr.",
   "license": "MIT",
-  "version": "2.3.1",
+  "version": "2.3.3",
   "description": "A core library for all of my TypeScript projects",
   "packageManager": "pnpm@10.12.1",
   "type": "module",
@@ -56,4 +56,4 @@
     "typescript": "~5.8.3",
     "vitest": "^3.2.4"
   }
-}
+}