package-versioner 0.8.6 → 0.9.1

package/README.md

@@ -130,7 +130,7 @@ Customize behaviour by creating a `version.config.json` file in your project roo
   "updateChangelog": true,
   "changelogFormat": "keep-a-changelog",
   "strictReachable": false,
-  "synced": true,
+  "sync": true,
   "skip": [
     "docs",
     "e2e"
@@ -160,7 +160,7 @@ Customize behaviour by creating a `version.config.json` file in your project roo
   - `paths`: Directories to search for Cargo.toml files (optional)
 
 #### Monorepo-Specific Options
-- `synced`: Whether all packages should be versioned together (default: true)
+- `sync`: Whether all packages should be versioned together (default: true)
 - `skip`: Array of package names or patterns to exclude from versioning. Supports exact names, scope wildcards, path patterns, and global wildcards (e.g., ["@scope/package-a", "@scope/*", "packages/**/*"])
 - `packages`: Array of package names or patterns to target for versioning. Supports exact names, scope wildcards, path patterns and global wildcards (e.g., ["@scope/package-a", "@scope/*", "*"])
 - `mainPackage`: Package name whose commit history should drive version determination
@@ -234,7 +234,7 @@ This option works in conjunction with `tagTemplate` to control tag formatting. T
 
 **Examples:**
 
-For single-package repositories or synced monorepos:
+For single-package repositories or sync monorepos:
 ```json
 {
   "packageSpecificTags": true,
@@ -253,8 +253,8 @@ For global versioning:
 Creates tags like `v1.2.3`
 
 **Important Notes:**
-- In **synced mode** with a single package, `packageSpecificTags: true` will use the package name even though all packages are versioned together
-- In **synced mode** with multiple packages, package names are not used regardless of the setting
+- In **sync mode** with a single package, `packageSpecificTags: true` will use the package name even though all packages are versioned together
+- In **sync mode** with multiple packages, package names are not used regardless of the setting
 - In **async mode**, each package gets its own tag when `packageSpecificTags` is enabled
 
 With package-specific tagging enabled, the tool will:
@@ -269,7 +269,7 @@ With package-specific tagging enabled, the tool will:
 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.md).
+For a detailed explanation of these concepts and monorepo modes (Sync vs. Async), see [Versioning Strategies and Concepts](./docs/versioning.md).
 
 ## Documentation
 

package/dist/index.cjs

@@ -1012,7 +1012,7 @@ function formatVersionPrefix(prefix) {
 function formatTag(version, prefix, packageName, template, packageSpecificTags) {
   if ((template == null ? void 0 : template.includes("${packageName}")) && !packageName) {
     log(
-      'Warning: Your tagTemplate contains ${packageName} but no package name is available.\nThis will result in an empty package name in the tag (e.g., "@v1.0.0" instead of "my-package@v1.0.0").\n\nTo fix this:\n\u2022 If using synced mode: Set "packageSpecificTags": true in your config to enable package names in tags\n\u2022 If you want global tags: Remove ${packageName} from your tagTemplate (e.g., use "${prefix}${version}")\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
+      'Warning: Your tagTemplate contains ${packageName} but no package name is available.\nThis will result in an empty package name in the tag (e.g., "@v1.0.0" instead of "my-package@v1.0.0").\n\nTo fix this:\n\u2022 If using sync mode: Set "packageSpecificTags": true in your config to enable package names in tags\n\u2022 If you want global tags: Remove ${packageName} from your tagTemplate (e.g., use "${prefix}${version}")\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
       "warning"
     );
   }
@@ -1027,7 +1027,7 @@ function formatTag(version, prefix, packageName, template, packageSpecificTags)
 function formatCommitMessage(template, version, packageName, additionalContext) {
   if (template.includes("${packageName}") && !packageName) {
     log(
-      'Warning: Your commitMessage template contains ${packageName} but no package name is available.\nThis will result in an empty package name in the commit message (e.g., "Release @v1.0.0").\n\nTo fix this:\n\u2022 If using synced mode: Set "packageSpecificTags": true to enable package names in commits\n\u2022 If you want generic commit messages: Remove ${packageName} from your commitMessage template\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
+      'Warning: Your commitMessage template contains ${packageName} but no package name is available.\nThis will result in an empty package name in the commit message (e.g., "Release @v1.0.0").\n\nTo fix this:\n\u2022 If using sync mode: Set "packageSpecificTags": true to enable package names in commits\n\u2022 If you want generic commit messages: Remove ${packageName} from your commitMessage template\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
       "warning"
     );
   }
@@ -1997,7 +1997,7 @@ function shouldProcessPackage2(pkg, config) {
   const pkgName = pkg.packageJson.name;
   return shouldProcessPackage(pkgName, config.skip);
 }
-function createSyncedStrategy(config) {
+function createSyncStrategy(config) {
   return async (packages) => {
     try {
       const {
@@ -2334,14 +2334,14 @@ function createAsyncStrategy(config) {
   };
 }
 function createStrategy(config) {
-  if (config.synced) {
-    return createSyncedStrategy(config);
+  if (config.sync) {
+    return createSyncStrategy(config);
   }
   return createAsyncStrategy(config);
 }
 function createStrategyMap(config) {
   return {
-    synced: createSyncedStrategy(config),
+    sync: createSyncStrategy(config),
     single: createSingleStrategy(config),
     async: createAsyncStrategy(config)
   };
@@ -2442,7 +2442,7 @@ var VersionEngine = class {
   }
   /**
    * Change the current strategy
-   * @param strategyType The strategy type to use: 'synced', 'single', or 'async'
+   * @param strategyType The strategy type to use: 'sync', 'single', or 'async'
    */
   setStrategy(strategyType) {
     this.currentStrategy = this.strategies[strategyType];
@@ -2477,7 +2477,7 @@ async function run() {
     program.command("version", { isDefault: true }).description("Version a package or packages based on configuration").option(
       "-c, --config <path>",
       "Path to config file (defaults to version.config.json in current directory)"
-    ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").option("--project-dir <path>", "Project directory to run commands in", process.cwd()).action(async (options) => {
+    ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --sync", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").option("--project-dir <path>", "Project directory to run commands in", process.cwd()).action(async (options) => {
       if (options.json) {
         enableJsonOutput(options.dryRun);
       }
@@ -2496,7 +2496,7 @@ async function run() {
         const config = await loadConfig(options.config);
         log(`Loaded configuration from ${options.config || "version.config.json"}`, "info");
         if (options.dryRun) config.dryRun = true;
-        if (options.synced) config.synced = true;
+        if (options.sync) config.sync = true;
         if (options.bump) config.type = options.bump;
         if (options.prerelease) {
           config.prereleaseIdentifier = options.prerelease === true ? "next" : options.prerelease;
@@ -2508,10 +2508,10 @@ async function run() {
         const resolvedCount = pkgsResult.packages.length;
         log(`Resolved ${resolvedCount} packages from workspace`, "debug");
         log(`Config packages: ${JSON.stringify(config.packages)}`, "debug");
-        log(`Config synced: ${config.synced}`, "debug");
-        if (config.synced) {
-          log("Using synced versioning strategy.", "info");
-          engine.setStrategy("synced");
+        log(`Config sync: ${config.sync}`, "debug");
+        if (config.sync) {
+          log("Using sync versioning strategy.", "info");
+          engine.setStrategy("sync");
           await engine.run(pkgsResult);
         } else if (resolvedCount === 1) {
           log("Using single package versioning strategy.", "info");

package/dist/index.js

@@ -979,7 +979,7 @@ function formatVersionPrefix(prefix) {
 function formatTag(version, prefix, packageName, template, packageSpecificTags) {
   if ((template == null ? void 0 : template.includes("${packageName}")) && !packageName) {
     log(
-      'Warning: Your tagTemplate contains ${packageName} but no package name is available.\nThis will result in an empty package name in the tag (e.g., "@v1.0.0" instead of "my-package@v1.0.0").\n\nTo fix this:\n\u2022 If using synced mode: Set "packageSpecificTags": true in your config to enable package names in tags\n\u2022 If you want global tags: Remove ${packageName} from your tagTemplate (e.g., use "${prefix}${version}")\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
+      'Warning: Your tagTemplate contains ${packageName} but no package name is available.\nThis will result in an empty package name in the tag (e.g., "@v1.0.0" instead of "my-package@v1.0.0").\n\nTo fix this:\n\u2022 If using sync mode: Set "packageSpecificTags": true in your config to enable package names in tags\n\u2022 If you want global tags: Remove ${packageName} from your tagTemplate (e.g., use "${prefix}${version}")\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
       "warning"
     );
   }
@@ -994,7 +994,7 @@ function formatTag(version, prefix, packageName, template, packageSpecificTags)
 function formatCommitMessage(template, version, packageName, additionalContext) {
   if (template.includes("${packageName}") && !packageName) {
     log(
-      'Warning: Your commitMessage template contains ${packageName} but no package name is available.\nThis will result in an empty package name in the commit message (e.g., "Release @v1.0.0").\n\nTo fix this:\n\u2022 If using synced mode: Set "packageSpecificTags": true to enable package names in commits\n\u2022 If you want generic commit messages: Remove ${packageName} from your commitMessage template\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
+      'Warning: Your commitMessage template contains ${packageName} but no package name is available.\nThis will result in an empty package name in the commit message (e.g., "Release @v1.0.0").\n\nTo fix this:\n\u2022 If using sync mode: Set "packageSpecificTags": true to enable package names in commits\n\u2022 If you want generic commit messages: Remove ${packageName} from your commitMessage template\n\u2022 If using single/async mode: Ensure your package.json has a valid "name" field',
       "warning"
     );
   }
@@ -1964,7 +1964,7 @@ function shouldProcessPackage2(pkg, config) {
   const pkgName = pkg.packageJson.name;
   return shouldProcessPackage(pkgName, config.skip);
 }
-function createSyncedStrategy(config) {
+function createSyncStrategy(config) {
   return async (packages) => {
     try {
       const {
@@ -2301,14 +2301,14 @@ function createAsyncStrategy(config) {
   };
 }
 function createStrategy(config) {
-  if (config.synced) {
-    return createSyncedStrategy(config);
+  if (config.sync) {
+    return createSyncStrategy(config);
   }
   return createAsyncStrategy(config);
 }
 function createStrategyMap(config) {
   return {
-    synced: createSyncedStrategy(config),
+    sync: createSyncStrategy(config),
     single: createSingleStrategy(config),
     async: createAsyncStrategy(config)
   };
@@ -2409,7 +2409,7 @@ var VersionEngine = class {
   }
   /**
    * Change the current strategy
-   * @param strategyType The strategy type to use: 'synced', 'single', or 'async'
+   * @param strategyType The strategy type to use: 'sync', 'single', or 'async'
    */
   setStrategy(strategyType) {
     this.currentStrategy = this.strategies[strategyType];
@@ -2443,7 +2443,7 @@ async function run() {
     program.command("version", { isDefault: true }).description("Version a package or packages based on configuration").option(
       "-c, --config <path>",
       "Path to config file (defaults to version.config.json in current directory)"
-    ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --synced", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").option("--project-dir <path>", "Project directory to run commands in", process.cwd()).action(async (options) => {
+    ).option("-d, --dry-run", "Dry run (no changes made)", false).option("-b, --bump <type>", "Specify bump type (patch|minor|major)").option("-p, --prerelease [identifier]", "Create prerelease version").option("-s, --sync", "Use synchronized versioning across all packages").option("-j, --json", "Output results as JSON", false).option("-t, --target <packages>", "Comma-delimited list of package names to target").option("--project-dir <path>", "Project directory to run commands in", process.cwd()).action(async (options) => {
       if (options.json) {
         enableJsonOutput(options.dryRun);
       }
@@ -2462,7 +2462,7 @@ async function run() {
         const config = await loadConfig(options.config);
         log(`Loaded configuration from ${options.config || "version.config.json"}`, "info");
         if (options.dryRun) config.dryRun = true;
-        if (options.synced) config.synced = true;
+        if (options.sync) config.sync = true;
         if (options.bump) config.type = options.bump;
         if (options.prerelease) {
           config.prereleaseIdentifier = options.prerelease === true ? "next" : options.prerelease;
@@ -2474,10 +2474,10 @@ async function run() {
         const resolvedCount = pkgsResult.packages.length;
         log(`Resolved ${resolvedCount} packages from workspace`, "debug");
         log(`Config packages: ${JSON.stringify(config.packages)}`, "debug");
-        log(`Config synced: ${config.synced}`, "debug");
-        if (config.synced) {
-          log("Using synced versioning strategy.", "info");
-          engine.setStrategy("synced");
+        log(`Config sync: ${config.sync}`, "debug");
+        if (config.sync) {
+          log("Using sync versioning strategy.", "info");
+          engine.setStrategy("sync");
           await engine.run(pkgsResult);
         } else if (resolvedCount === 1) {
           log("Using single package versioning strategy.", "info");

package/docs/versioning.md

@@ -334,7 +334,7 @@ Warning: Your tagTemplate contains ${packageName} but no package name is availab
 This will result in an empty package name in the tag (e.g., "@v1.0.0" instead of "my-package@v1.0.0").
 
 To fix this:
-• If using synced mode: Set "packageSpecificTags": true in your config to enable package names in tags
+• If using sync mode: Set "packageSpecificTags": true in your config to enable package names in tags
 • If you want global tags: Remove ${packageName} from your tagTemplate (e.g., use "${prefix}${version}")
 • If using single/async mode: Ensure your package.json has a valid "name" field
 ```
@@ -344,7 +344,7 @@ To fix this:
 1. **For Synced Mode with Package Names**: Enable package-specific tags
    ```json
    {
-     "synced": true,
+     "sync": true,
      "packageSpecificTags": true,
      "tagTemplate": "${packageName}@${prefix}${version}"
    }
@@ -397,11 +397,11 @@ For global commit messages, use templates without `${packageName}`:
 
 ## Monorepo Versioning Modes
 
-While primarily used for single packages now, `package-versioner` retains options for monorepo workflows, controlled mainly by the `synced` flag in `version.config.json`.
+While primarily used for single packages now, `package-versioner` retains options for monorepo workflows, controlled mainly by the `sync` flag in `version.config.json`.
 
-### Synced Mode (`synced: true`)
+### Sync Mode (`sync: true`)
 
-This is the default if the `synced` flag is present and true.
+This is the default if the `sync` flag is present and true.
 
 -   **Behaviour:** The tool calculates **one** version bump based on the overall history (or branch pattern). This single new version is applied to **all** packages within the repository (or just the root `package.json` if not a structured monorepo). A single Git tag is created.
 -   **Tag Behaviour:** 
@@ -409,7 +409,7 @@ This is the default if the `synced` flag is present and true.
     - In **single-package repositories**: Respects the `packageSpecificTags` setting - can create either `v1.2.3` or `package-name@v1.2.3`
 -   **Use Case:** Suitable for monorepos where all packages are tightly coupled and released together with the same version number. Also the effective mode for single-package repositories.
 
-### Async Mode (`synced: false`)
+### Async Mode (`sync: false`)
 
 *(Note: This mode relies heavily on monorepo tooling and structure, like `pnpm workspaces` and correctly configured package dependencies.)*
 

package/package-versioner.schema.json

@@ -41,7 +41,7 @@
       "description": "The main branch for versioning",
       "default": "main"
     },
-    "synced": {
+    "sync": {
       "type": "boolean",
       "default": false,
       "description": "Whether packages should be versioned together"

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "package-versioner",
   "description": "A lightweight yet powerful CLI tool for automated semantic versioning based on Git history and conventional commits.",
-  "version": "0.8.6",
+  "version": "0.9.1",
   "type": "module",
   "main": "./dist/index.js",
   "module": "./dist/index.mjs",