@cenk1cenk2/cz-cc 2.3.3 → 3.0.0

package/README.md

@@ -11,6 +11,8 @@
 - [Configuration](#configuration)
   - [package.json](#packagejson)
   - [Environment Variables](#environment-variables)
+- [Breaking Changes](#breaking-changes)
+  - [Migration to v3](#migration-to-v3)
 - [Commitlint](#commitlint)
 
 <!-- tocstop -->
@@ -68,6 +70,7 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
     "config": {
         "commitizen": {
             "path": "./node_modules/@cenk1cenk2/cz-cc",
+            "preset": "conventionalcommits",
             "maxHeaderWidth": 100,
             "maxLineWidth": 100,
             "defaultType": "",
@@ -89,10 +92,13 @@ Like commitizen, you specify the configuration of cz-conventional-changelog thro
 }
 ```
 
+`preset` selects how breaking changes are prompted for and rendered, either `conventionalcommits` (default) or `angular`. See [Breaking Changes](#breaking-changes).
+
 ### Environment Variables
 
 The following environment varibles can be used to override any default configuration or package.json based configuration.
 
+- CZ_PRESET = preset
 - CZ_TYPE = defaultType
 - CZ_SCOPE = defaultScope
 - CZ_SUBJECT = defaultSubject
@@ -100,6 +106,34 @@ The following environment varibles can be used to override any default configura
 - CZ_MAX_HEADER_WIDTH = maxHeaderWidth
 - CZ_MAX_LINE_WIDTH = maxLineWidth
 
+## Breaking Changes
+
+Breaking changes are declared through the additional actions of the prompt, and the `preset` configuration decides which of the two mechanisms are offered there. It has to match the preset the release tooling analyzes commits with.
+
+- `conventionalcommits` (**default**) offers both. `breaking-marker` appends the `!` marker after the type and the optional scope, as in `feat(api)!: drop the legacy token endpoint`, and `breaking-changes` appends a `BREAKING CHANGE` footer. The specification treats them as independent signals, so either one on its own marks the commit as breaking and selecting both is valid.
+- `angular` offers `breaking-changes` alone, since the `!` marker is not part of its header pattern. This is the behaviour of every release before v3.
+
+Selecting neither leaves the commit non-breaking, so an ordinary commit still skips the whole subject in one pass.
+
+### Migration to v3
+
+`conventionalcommits` became the default in v3, so commits made through the adapter can now carry the `!` marker in the header once `breaking-marker` is selected. Two things to check:
+
+- The release tooling has to analyze commits with the `conventionalcommits` preset, otherwise the `!` marker is not read as a major bump. `@semantic-release/commit-analyzer` and `commitlint` both take a `preset` of their own.
+- `header-max-length` counts the extra character, and any tooling matching commit headers with a custom regular expression has to allow the `!` before the colon.
+
+To keep the previous behaviour, pin the preset back:
+
+```json5
+{
+  "config": {
+    "commitizen": {
+      "preset": "angular"
+    }
+  }
+}
+```
+
 ## Commitlint
 
 If using the [commitlint](https://github.com/conventional-changelog/commitlint) js library, the "maxHeaderWidth" configuration property will default to the configuration of the "header-max-length" rule instead of the hard coded value of 100. This can be overwritten by setting the 'maxHeaderWidth' configuration in package.json or the CZ_MAX_HEADER_WIDTH environment variable.

package/dist/index.cjs

@@ -38,6 +38,13 @@ let os = require("os");
 let path = require("path");
 let _inquirer_prompts = require("@inquirer/prompts");
 
+//#region src/presets.js
+const PRESETS = {
+	conventionalcommits: "conventionalcommits",
+	angular: "angular"
+};
+
+//#endregion
 //#region src/engine.js
 function engine_default(options) {
 	return { prompter(cz, commit) {
@@ -90,10 +97,15 @@ function engine_default(options) {
 							value: "issue",
 							description: "Resolve Issues by additional comments."
 						},
+						...options.preset === PRESETS.conventionalcommits ? [{
+							name: "breaking-marker",
+							value: "breaking-marker",
+							description: "Mark the commit as breaking with the \"!\" marker in the header."
+						}] : [],
 						{
 							name: "breaking-changes",
 							value: "breaking-changes",
-							description: "Note breaking changes in the commit message."
+							description: "Describe the breaking changes in a footer of the commit message."
 						},
 						{
 							name: "long-description",
@@ -152,7 +164,8 @@ function engine_default(options) {
 			ctx: { prompts: {} }
 		}).run().then((ctx) => {
 			const scope = ctx.prompts.scope ? `(${ctx.prompts.scope})` : "";
-			let head = ctx.prompts.type + scope + ": " + ctx.prompts.subject;
+			const breakingMarker = options.preset === PRESETS.conventionalcommits && ctx.prompts.additional.includes("breaking-marker") ? "!" : "";
+			let head = ctx.prompts.type + scope + breakingMarker + ": " + ctx.prompts.subject;
 			if (ctx.prompts.additional.includes("skip-ci")) head = head + " [skip ci]";
 			const body = ctx.prompts.body;
 			const breaking = ctx.prompts.breaking ? "BREAKING CHANGE: " + ctx.prompts.breaking.trim().replace(/^BREAKING CHANGE: /, "") : false;
@@ -173,7 +186,10 @@ function engine_default(options) {
 //#region src/index.js
 function bootstrap() {
 	const config = commitizen.configLoader.load() || {};
+	const preset = process.env.CZ_PRESET || config.preset || PRESETS.conventionalcommits;
+	if (!Object.hasOwn(PRESETS, preset)) throw new Error(`Unknown preset "${preset}", expected one of: ${Object.keys(PRESETS).join(", ")}.`);
 	const options = {
+		preset,
 		types: config.types || conventional_commit_types.default.types,
 		defaultType: process.env.CZ_TYPE || config.defaultType || "fix",
 		defaultScope: process.env.CZ_SCOPE || config.defaultScope,

package/package.json

@@ -1,8 +1,11 @@
 {
   "name": "@cenk1cenk2/cz-cc",
-  "version": "2.3.3",
+  "version": "3.0.0",
   "description": "Commitizen adapter following the conventional-changelog format.",
-  "repository": "git@gitlab.kilic.dev:libraries/cz-cc.git",
+  "repository": {
+    "type": "git",
+    "url": "git@gitlab.kilic.dev:libraries/cz-cc.git"
+  },
   "author": "Cenk Kilic <cenk@kilic.dev>",
   "license": "MIT",
   "type": "commonjs",
@@ -10,12 +13,6 @@
   "publishConfig": {
     "access": "public"
   },
-  "scripts": {
-    "build": "tsdown src/index.js",
-    "dev:start": "tsdown --watch src/index.js",
-    "format": "prettier --log-level warn --write src/ && eslint --fix",
-    "lint": "eslint"
-  },
   "simple-git-hooks": {
     "pre-commit": "[ -n \"$SKIP_GIT_HOOKS\" ] && true || pnpm exec lint-staged",
     "prepare-commit-msg": "[ -t 1 ] && exec < /dev/tty && git cz --hook || true"
@@ -47,7 +44,7 @@
     "lint-staged": "^17.4.1",
     "prettier": "^3.9.6",
     "simple-git-hooks": "^2.14.0",
-    "tsdown": "^0.22.14",
+    "tsdown": "^0.23.0",
     "typescript": "^6.0.3"
   },
   "config": {
@@ -55,5 +52,10 @@
       "path": "./dist/index.cjs"
     }
   },
-  "packageManager": "pnpm@12.3.0"
-}
+  "scripts": {
+    "build": "tsdown src/index.js",
+    "dev:start": "tsdown --watch src/index.js",
+    "format": "prettier --log-level warn --write src/ && eslint --fix",
+    "lint": "eslint"
+  }
+}