@abelspithost/commitlint 0.0.2 → 0.1.0

package/README.md

@@ -1,12 +1,14 @@
 # @abelspithost/commitlint
 
-A shared [commitlint](https://commitlint.js.org/) preset that extends `@commitlint/config-conventional` with stricter defaults, plus a CLI to set everything up in one command.
+[![Quality Gate Status](https://sonarcloud.io/api/project_badges/measure?project=aspithost_commitlint&metric=alert_status)](https://sonarcloud.io/summary/new_code?id=aspithost_commitlint)
+
+A shared [commitlint](https://commitlint.js.org/) preset that extends `@commitlint/config-conventional` with stricter defaults, plus a CLI to set everything up with one command.
 
 ## What's included
 
 - Commitlint configuration that extends `@commitlint/config-conventional`
 - Scope is optional by default
-- A `createConfig` helper to customize allowed types and scopes (providing scopes makes them mandatory)
+- A `createConfig` helper to customize allowed types and scopes (when you provide scopes, they become mandatory)
 - An `init` CLI that installs and configures commitlint + husky automatically
 - Automatic package manager detection (npm, yarn, pnpm, bun)
 
@@ -18,17 +20,17 @@ Run the init command in your project root:
 npx -p @abelspithost/commitlint init
 ```
 
-The CLI automatically detects your package manager by looking for `bun.lockb`/`bun.lock`, `pnpm-lock.yaml`, `yarn.lock`, or falling back to npm. It will:
+The CLI detects your package manager by looking for `bun.lockb`/`bun.lock`, `pnpm-lock.yaml`, `yarn.lock`, or falling back to npm. It will:
 
 1. Install `husky`, `@commitlint/cli`, and `@abelspithost/commitlint` as dev dependencies
 2. Initialize husky
-3. Remove the default `pre-commit` hook created by husky
+3. Remove the default `pre-commit` hook that husky creates
 4. Create a `.husky/commit-msg` hook (using the correct runner for your package manager)
-5. Generate a `commitlint.config.ts` that re-exports the preset (skipped if one already exists)
+5. Generate a `commitlint.config.ts` that re-exports the preset (skip if one already exists)
 
 ## Manual setup (npm)
 
-Install the dependencies:
+Install the required dependencies:
 
 ```sh
 npm install --save-dev husky @commitlint/cli @abelspithost/commitlint
@@ -71,7 +73,7 @@ export default createConfig({
 | `scopes` | `string[]` | —              | Restrict commits to these scopes (makes scope mandatory) |
 | `types`  | `string[]` | `COMMIT_TYPES` | Override the allowed commit types     |
 
-When `scopes` is omitted, scope is optional and any value is accepted. When `scopes` is provided, a scope becomes **required** and must be one of the listed values. When `types` is omitted, it defaults to the built-in `COMMIT_TYPES`.
+When you omit `scopes`, scope is optional and you can use any value. When you provide `scopes`, scope becomes **required** and must match one of the listed values. When you omit `types`, it defaults to the built-in `COMMIT_TYPES`.
 
 ### Examples
 
@@ -113,11 +115,11 @@ const configuration: UserConfig = {
 export default configuration;
 ```
 
-`RuleConfigSeverity` and `UserConfig` are re-exported from this package so you don't need to install `@commitlint/types` separately.
+This package re-exports `RuleConfigSeverity` and `UserConfig`, so you don't need to install `@commitlint/types` separately.
 
 ## Commit message format
 
-Commits must follow the [Conventional Commits](https://www.conventionalcommits.org/) format:
+Write your commits in the [Conventional Commits](https://www.conventionalcommits.org/) format:
 
 ```
 type: description

package/dist/index.d.ts

@@ -1,4 +1,4 @@
 export { RuleConfigSeverity, type UserConfig } from '@commitlint/types';
-export { COMMIT_TYPES } from './constants/commitTypes.js';
 export { configuration, configuration as default, createConfig } from './config/config.js';
+export { COMMIT_TYPES } from './constants/commitTypes.js';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAE,KAAK,UAAU,EAAE,MAAM,mBAAmB,CAAC;AAExE,OAAO,EAAE,aAAa,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC"}

package/dist/index.js

@@ -1,4 +1,4 @@
 export { RuleConfigSeverity } from '@commitlint/types';
-export { COMMIT_TYPES } from './constants/commitTypes.js';
 export { configuration, configuration as default, createConfig } from './config/config.js';
+export { COMMIT_TYPES } from './constants/commitTypes.js';
 //# sourceMappingURL=index.js.map

package/dist/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AACxE,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC;AAC1D,OAAO,EAAE,aAAa,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,kBAAkB,EAAmB,MAAM,mBAAmB,CAAC;AAExE,OAAO,EAAE,aAAa,EAAE,aAAa,IAAI,OAAO,EAAE,YAAY,EAAE,MAAM,oBAAoB,CAAC;AAC3F,OAAO,EAAE,YAAY,EAAE,MAAM,4BAA4B,CAAC"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@abelspithost/commitlint",
-  "version": "0.0.2",
+  "version": "0.1.0",
   "description": "Shared commitlint preset extending @commitlint/config-conventional with stricter defaults",
   "keywords": [
     "commitlint",
@@ -39,8 +39,11 @@
     "dist"
   ],
   "scripts": {
-    "build": "npm run clean && tsc -p tsconfig.build.json",
+    "build": "npm run clean && npm run typecheck && tsc -p tsconfig.build.json && npm run deps:check",
     "clean": "rimraf dist",
+    "deps:check": "npx -y npm-check-updates --cooldown 2",
+    "deps:update": "npx -y npm-check-updates -u --target minor --cooldown 2 && npm install",
+    "deps:update:major": "npx -y npm-check-updates -u --cooldown 2 && npm install",
     "lint": "eslint .",
     "test:unit": "vitest",
     "test:cov": "vitest run --coverage --coverage.reporter=text",
@@ -48,22 +51,22 @@
     "prepare": "husky || true"
   },
   "dependencies": {
-    "@commitlint/config-conventional": "^20.4.1",
-    "@commitlint/format": "^20.4.0",
-    "@commitlint/types": "^20.4.0"
+    "@commitlint/config-conventional": "^21.0.1",
+    "@commitlint/format": "^21.0.1",
+    "@commitlint/types": "^21.0.1"
   },
   "devDependencies": {
-    "@abelspithost/eslint-config-ts": "^0.1.3",
-    "@abelspithost/tsconfig-node": "^0.0.4",
-    "@commitlint/cli": "^20.4.1",
-    "@types/node": "^24.10.11",
-    "@vitest/coverage-v8": "^4.0.18",
-    "commitlint": "^20.4.1",
-    "eslint": "^9.39.2",
+    "@abelspithost/eslint-config-ts": "^1.1.0",
+    "@abelspithost/tsconfig-node": "^0.0.5",
+    "@commitlint/cli": "^21.0.1",
+    "@types/node": "^24.12.4",
+    "@vitest/coverage-v8": "^4.1.6",
+    "commitlint": "^21.0.1",
+    "eslint": "^10.4.0",
     "husky": "^9.1.7",
-    "jiti": "^2.6.1",
-    "rimraf": "^6.1.2",
-    "typescript": "^5.9.3",
-    "vitest": "^4.0.18"
+    "jiti": "^2.7.0",
+    "rimraf": "^6.1.3",
+    "typescript": "^6.0.3",
+    "vitest": "^4.1.6"
   }
 }