commitlint-config-spellbookx 0.7.2 → 0.7.3

package/.turbo/turbo-build.log

@@ -1,7 +1,7 @@
 
-> commitlint-config-spellbookx@0.7.2 build /home/runner/work/spellbookx/spellbookx/packages/commitlint-config-spellbookx
+> commitlint-config-spellbookx@0.7.3 build /home/runner/work/spellbookx/spellbookx/packages/commitlint-config-spellbookx
 > rolldown -c && tsc
 
 [log] <DIR>/index.js  chunk │ size: 272.41 kB
 [log]
-[success] rolldown v1.0.0-rc.1 Finished in 50.37 ms
+[success] rolldown v1.0.0-rc.1 Finished in 33.15 ms

package/README.md

@@ -1,165 +1,77 @@
 # commitlint-config-spellbookx
 
-Shared Commitlint configuration - standardizing commit message formatting across JS/TS projects.  
-Conventional commits, interactive prompts, and multi-scope support included.  
-Clean. Opinionated. Always consistent.
-
----
-
-## Table of Content
-
-- [Features](#features)
-- [Install](#installation)
-- [Usage](#usage)
-- [With CLI](#with-cli)
-- [With Lefthook](#with-lefthook)
-- [Resources](#resources)
-- [License](#license)
-
----
-
-## Features
-
-- **Base Rules**
-  - Enforces [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) style.
-  - Supported commit types:
-    - `feat` -> A new feature
-    - `fix` -> A bug fix
-    - `docs` -> Documentation only changes
-    - `style` -> Code style changes without functional impact
-    - `refactor` -> Code refactoring (no feature or fix)
-    - `perf` -> Performance improvements
-    - `test` -> Adding or correcting tests
-    - `build` -> Changes affecting the build system or dependencies
-    - `ci` -> Changes to CI configuration
-    - `chore` -> Miscellaneous chores
-    - `revert` -> Reverts a previous commit
-  - `feat` -> A new feature
-  - `fix` -> A bug fix
-  - `docs` -> Documentation only changes
-  - `style` -> Code style changes without functional impact
-  - `refactor` -> Code refactoring (no feature or fix)
-  - `perf` -> Performance improvements
-  - `test` -> Adding or correcting tests
-  - `build` -> Changes affecting the build system or dependencies
-  - `ci` -> Changes to CI configuration
-  - `chore` -> Miscellaneous chores
-  - `revert` -> Reverts a previous commit
-  - Enforces:
-    - Scope case: `kebab-case`
-    - Subject cannot be empty
-    - Subject case: `sentence-case`
-    - No full stop at the end of subject
-    - Header max length: 72
-    - Body and footer max line length: 100
-
-- **Interactive Prompt**
-  - Multi-scope support enabled
-  - Scope separator: `,`
-  - Guided questions for type, scope, subject, body, breaking changes, and issues affected
-  - Emoji and title per commit type
-  - Uses `cz` for interactive commits (`npx cz`)
-
-- **Parser Preset**
-  - Uses `conventional-changelog-conventionalcommits`
-  - Supports multi-scope commit messages:
-    ```bash
-    type(scope1,scope2): subject
-    ```
-
----
+Shared [Commitlint](https://commitlint.js.org/) configuration for the Spellbookx project. This package ensures that all commits adhere to the [Conventional Commits](https://www.conventionalcommits.org/en/v1.0.0/) specification.
+
+## Description
+
+This package provides a base commitlint configuration that:
+
+- Extends the widely-used `@commitlint/config-conventional`.
+- Dynamically generates commit scopes based on the packages present in the `@spellbookx` monorepo.
+- Includes pre-defined commit types with emojis for better readability.
+- Offers a customized `commitizen` prompt for an enhanced commit experience.
+
+## Why use this?
+
+Using this package ensures consistent and readable commit messages across the entire project. This helps in:
+
+- Automatically generating changelogs.
+- Simplifying the release process.
+- Improving the readability of the project's history.
 
 ## Installation
 
+Install the package using your favorite package manager:
+
+**npm**
+
 ```bash
-npm install -g commitizen cz-git
-npm install -D commitizen cz-git conventional-changelog-conventionalcommits @commitlint/cli @commitlint/config-conventional commitlint-config-spellbookx
+npm install --save-dev commitlint-config-spellbookx @commitlint/cli
 ```
 
-or
+**pnpm**
 
 ```bash
-pnpm add -g commitizen cz-git
-pnpm add -D commitizen cz-git conventional-changelog-conventionalcommits @commitlint/cli @commitlint/config-conventional commitlint-config-spellbookx
+pnpm add -D commitlint-config-spellbookx @commitlint/cli
 ```
 
-or
+**yarn**
 
 ```bash
-yarn global add commitizen cz-git
-yarn add -D commitizen cz-git conventional-changelog-conventionalcommits @commitlint/cli @commitlint/config-conventional commitlint-config-spellbookx
+yarn add -D commitlint-config-spellbookx @commitlint/cli
 ```
 
-or
+**bun**
 
 ```bash
-bun add -g commitizen cz-git
-bun add -D commitizen cz-git conventional-changelog-conventionalcommits @commitlint/cli @commitlint/config-conventional commitlint-config-spellbookx
+bun add -d commitlint-config-spellbookx @commitlint/cli
 ```
 
----
-
 ## Usage
 
-Create a `commitlint.config.mjs` file at your project root:
-
-```ts
-export default {
-  extends: ['spellbookx'],
-};
-```
+To use this configuration, create a `commitlint.config.mjs` file in your project's root and extend this package:
 
-Create a `.czrc` file at your project root:
+```javascript
+import config from 'commitlint-config-spellbookx';
 
-```json
-{
-  "path": "cz-git"
-}
+export default config;
 ```
 
-Add these properties to your root `package.json`:
+For an interactive commit experience, you can use `commitizen` with `cz-git`. Update your `package.json` with the following configuration:
 
 ```json
 {
+  "scripts": {
+    "commit": "cz"
+  },
   "config": {
     "commitizen": {
-      "path": "git-cz"
+      "path": "cz-git"
     }
   }
 }
 ```
 
-### With CLI
-
-Interactive commits using Commitizen:
-
-```bash
-npx cz
-```
-
-### With Lefthook
-
-Configure a `lefthook.yml` in your project root:
-
-```yaml
-commit-msg:
-  commands:
-    lint-commit-msg:
-      run: npx commitlint --verbose --edit {1}
-```
-
-> Commitlint will automatically validate commit messages on each commit. Use `cz` to create commits interactively.
-
----
-
-## Resources
-
-- [Commitlint Documentation](https://commitlint.js.org/)
-- [Conventional Commits](https://www.conventionalcommits.org/)
-- [Commitizen](https://github.com/commitizen/cz-cli)
-
----
-
 ## License
 
 This project is licensed under the MIT License.

package/package.json

@@ -1,12 +1,15 @@
 {
   "name": "commitlint-config-spellbookx",
-  "version": "0.7.2",
+  "version": "0.7.3",
   "private": false,
-  "description": "Shared Commitlint configuration and commit convention tooling for Spellbookx",
+  "description": "A shareable Commitlint configuration for enforcing conventional commits.",
   "keywords": [
+    "commit-config",
+    "commitizen",
     "commitlint",
+    "commitlint-config",
     "conventional-commits",
-    "commit-config",
+    "cz-git",
     "spellbookx"
   ],
   "homepage": "https://github.com/spellbookx/spellbookx#readme",
@@ -46,7 +49,7 @@
     "@types/node": "^25.0.10",
     "rolldown": "1.0.0-rc.1",
     "typescript": "5.9.2",
-    "@spellbookx/typescript-config": "0.7.2"
+    "@spellbookx/typescript-config": "0.7.3"
   },
   "publishConfig": {
     "access": "public"