package-versioner 0.0.1

package/LICENCE.md

@@ -0,0 +1,7 @@
+MIT License
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of the Turbo-version and Turbo-release 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/README.md

@@ -0,0 +1,89 @@
+# package-versioner
+
+A powerful CLI tool for automated semantic versioning based on Git history and conventional commits. Simplifies version management in JavaScript/TypeScript projects.
+
+## Features
+
+- Automatically determines version bumps based on commit history (using conventional commits)
+- Primarily designed for single package projects, but configurable
+- Flexible versioning strategies (e.g., based on commit types, branch patterns)
+- Integrates with conventional commits presets
+- Customizable through a `version.config.json` file or CLI options
+- Automatically updates `package.json` version
+- Creates and pushes appropriate Git tags for releases
+
+## Usage
+
+`package-versioner` is designed to be run directly using your preferred package manager's execution command, without needing global installation.
+
+```bash
+# Determine bump based on conventional commits since last tag
+npx package-versioner
+
+# Using pnpm
+pnpm dlx package-versioner
+
+# Using yarn
+yarn dlx package-versioner
+
+# Specify a bump type explicitly
+npx package-versioner --bump minor
+
+# Create a prerelease (e.g., alpha)
+npx package-versioner --bump patch --prerelease alpha
+
+# Perform a dry run: calculates version, logs actions, but makes no file changes or Git commits/tags
+npx package-versioner --dry-run
+```
+
+
+
+## Configuration
+
+Customize behavior by creating a `version.config.json` file in your project root:
+
+```json
+{
+  "preset": "conventional-commits", // Preset for conventional-commits analysis
+  "tagPrefix": "v",                 // Prefix for Git tags (e.g., v1.0.0)
+  "commitMessage": "chore(release): v${version}", // Template for the release commit (defaults to this if omitted)
+  "versionStrategy": "commitMessage", // Use conventional commit messages (default) or "branchPattern"
+  "baseBranch": "main",               // Base branch for calculations
+  "branchPattern": [                // Used if versionStrategy is branchPattern
+    "feature:minor", 
+    "fix:patch"
+  ],
+  "prereleaseIdentifier": null,     // Default prerelease identifier (e.g., "beta")
+  "skipHooks": false,               // Skip git commit hooks (--no-verify)
+  "synced": true,                   // (Monorepo-specific) Treat as a single synchronized unit
+  "packages": [],                   // (Monorepo-specific) Specify packages (not typical for single repo)
+  "updateInternalDependencies": "no-internal-update" // (Monorepo-specific) How to handle workspace deps
+}
+```
+
+**Note:** Options like `synced`, `packages`, and `updateInternalDependencies` enable monorepo-specific behaviours.
+
+## How Versioning Works
+
+`package-versioner` determines the next version based on your configuration (`version.config.json`). The two main approaches are:
+
+1.  **Conventional Commits:** Analyzes commit messages (like `feat:`, `fix:`, `BREAKING CHANGE:`) since the last tag.
+2.  **Branch Pattern:** Determines the bump based on the current or recently merged branch name matching predefined patterns.
+
+For a detailed explanation of these concepts and monorepo modes (Synced vs. Async), see [Versioning Strategies and Concepts](./docs/VERSIONING_STRATEGIES.md).
+
+## Documentation
+
+For more details on available CLI options, run:
+
+```bash
+npx package-versioner --help
+```
+
+## Acknowledgements
+
+This project was originally forked from and inspired by `jucian0/turbo-version` ([https://github.com/jucian0/turbo-version](https://github.com/jucian0/turbo-version)). We appreciate the foundational work done by the original authors.
+
+## License
+
+MIT