@jmlweb/commitlint-config 0.0.0 → 2.0.0

package/CHANGELOG.md

@@ -1,5 +1,17 @@
 # @jmlweb/commitlint-config
 
+## 2.0.0
+
+### Major Changes
+
+- 738525c: Make config generic by removing hardcoded scopes and adding flexible scope options
+
+## 1.0.0
+
+### Major Changes
+
+- 165d410: Make config generic by removing hardcoded scopes and adding flexible scope options
+
 ## 0.0.0
 
 Initial development version.

package/README.md

@@ -5,16 +5,15 @@
 [![Node.js](https://img.shields.io/badge/Node.js-%3E%3D18.0.0-339933.svg)](https://nodejs.org/)
 [![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)
 
-> Shared commitlint configuration for enforcing Conventional Commits across projects. Includes predefined scopes for @jmlweb packages and configurable options.
+> Shared commitlint configuration for enforcing Conventional Commits across projects. Flexible design works out-of-the-box for any project, with optional scope restrictions.
 
 ## Features
 
 - Enforces [Conventional Commits](https://conventionalcommits.org) specification
-- Predefined commit types: `feat`, `fix`, `docs`, `chore`, `refactor`, `test`, `ci`, `perf`, `style`, `build`, `revert`
-- Predefined scopes matching @jmlweb package names
-- Configurable options for custom scopes and stricter rules
+- **No scope restrictions by default** - works with any project structure
+- Configurable scopes when you need them
+- Custom ignore functions for merge commits, dependabot, etc.
 - TypeScript support with full type definitions
-- Easy integration with husky for Git hooks
 
 ## Installation
 
@@ -38,12 +37,61 @@ import commitlintConfig from '@jmlweb/commitlint-config';
 export default commitlintConfig;
 ```
 
-Or with CommonJS:
+That's it! Any commit type/scope following Conventional Commits is allowed.
+
+## Usage Examples
+
+### No Scope Restrictions (Default)
 
 ```javascript
-const commitlintConfig = require('@jmlweb/commitlint-config');
+// commitlint.config.js
+import commitlintConfig from '@jmlweb/commitlint-config';
+
+export default commitlintConfig;
+```
+
+Valid commits:
+
+```text
+feat: add new feature
+fix(auth): resolve login issue
+chore(whatever-you-want): update deps
+```
+
+### Define Your Own Scopes
+
+```typescript
+// commitlint.config.ts
+import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+
+export default createCommitlintConfig({
+  scopes: ['api', 'ui', 'database', 'auth', 'deps'],
+});
+```
+
+### Strict Configuration
 
-module.exports = commitlintConfig;
+```typescript
+import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+
+export default createCommitlintConfig({
+  scopes: ['core', 'utils', 'config'],
+  scopeRequired: true,
+  headerMaxLength: 72,
+});
+```
+
+### Ignore Specific Commits
+
+```typescript
+import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+
+export default createCommitlintConfig({
+  ignores: [
+    (commit) => commit.startsWith('Merge'),
+    (commit) => /^\[dependabot\]/.test(commit),
+  ],
+});
 ```
 
 ## Commit Message Format
@@ -58,15 +106,15 @@ This configuration enforces the Conventional Commits format:
 [optional footer(s)]
 ```
 
-### Examples of Valid Commits
+### Example Commits
 
 ```text
-feat(eslint-config-base): add new rule for import sorting
-fix(prettier-config-tailwind): correct plugin order
-docs: update README with installation instructions
+feat(api): add user authentication endpoint
+fix: correct date parsing logic
+docs: update README with examples
 chore(deps): update dependencies
-refactor(tsconfig-base): simplify compiler options
-test(vitest-config): add unit tests for config factory
+refactor(ui): simplify form validation
+test: add unit tests for utils
 ci: add GitHub Actions workflow
 ```
 
@@ -86,73 +134,46 @@ ci: add GitHub Actions workflow
 | `build`    | Build system changes                  |
 | `revert`   | Reverting previous commits            |
 
-## Allowed Scopes
-
-### Package Scopes
-
-- `eslint-config-base`, `eslint-config-base-js`, `eslint-config-react`
-- `prettier-config-base`, `prettier-config-tailwind`
-- `tsconfig-base`, `tsconfig-internal`, `tsconfig-nextjs`, `tsconfig-react`
-- `tsup-config-base`
-- `vitest-config`
-- `commitlint-config`
-
-### Common Scopes
-
-- `deps` - Dependency updates
-- `release` - Release-related changes
-- `scripts` - Build/CI scripts
-- `workspace` - Workspace configuration
+## Configuration Options
 
-## Customization
+| Option             | Type                              | Default     | Description                                    |
+| ------------------ | --------------------------------- | ----------- | ---------------------------------------------- |
+| `scopes`           | `string[]`                        | `undefined` | Define allowed scopes (enables scope checking) |
+| `additionalScopes` | `string[]`                        | `[]`        | Add scopes when extending base configs         |
+| `additionalTypes`  | `string[]`                        | `[]`        | Additional commit types to allow               |
+| `headerMaxLength`  | `number`                          | `100`       | Maximum length for the header line             |
+| `scopeRequired`    | `boolean`                         | `false`     | Whether to require a scope                     |
+| `bodyRequired`     | `boolean`                         | `false`     | Whether to require a commit body               |
+| `ignores`          | `((commit: string) => boolean)[]` | `undefined` | Functions to ignore certain commits            |
 
-### Adding Custom Scopes
+## Exports
 
 ```typescript
-import { createCommitlintConfig } from '@jmlweb/commitlint-config';
-
-export default createCommitlintConfig({
-  additionalScopes: ['api', 'ui', 'database', 'auth'],
-});
-```
-
-### Stricter Configuration
+// Default config - no scope restrictions
+import config from '@jmlweb/commitlint-config';
 
-```typescript
+// Factory function for custom configs
 import { createCommitlintConfig } from '@jmlweb/commitlint-config';
 
-export default createCommitlintConfig({
-  scopeRequired: true,
-  headerMaxLength: 72,
-  bodyRequired: true,
-});
-```
-
-### Adding Custom Types
-
-```typescript
-import { createCommitlintConfig } from '@jmlweb/commitlint-config';
-
-export default createCommitlintConfig({
-  additionalTypes: ['wip', 'merge'],
-});
+// Commit types constant
+import { COMMIT_TYPES } from '@jmlweb/commitlint-config';
 ```
 
 ## Integration with Husky
 
-### Step 1: Install husky
+### Step 1 - Install husky
 
 ```bash
 pnpm add -D husky
 ```
 
-### Step 2: Initialize husky
+### Step 2 - Initialize husky
 
 ```bash
 pnpm exec husky init
 ```
 
-### Step 3: Add commit-msg hook
+### Step 3 - Add commit-msg hook
 
 Create or edit `.husky/commit-msg`:
 
@@ -160,7 +181,7 @@ Create or edit `.husky/commit-msg`:
 pnpm exec commitlint --edit $1
 ```
 
-### Step 4: Test your setup
+### Step 4 - Test your setup
 
 ```bash
 # This should fail
@@ -170,37 +191,6 @@ git commit -m "bad commit message"
 git commit -m "feat: add new feature"
 ```
 
-## Configuration Options
-
-| Option             | Type       | Default | Description                        |
-| ------------------ | ---------- | ------- | ---------------------------------- |
-| `additionalTypes`  | `string[]` | `[]`    | Additional commit types to allow   |
-| `additionalScopes` | `string[]` | `[]`    | Additional scopes to allow         |
-| `headerMaxLength`  | `number`   | `100`   | Maximum length for the header line |
-| `scopeRequired`    | `boolean`  | `false` | Whether to require a scope         |
-| `bodyRequired`     | `boolean`  | `false` | Whether to require a commit body   |
-
-## Exports
-
-### Default Export
-
-The default export is a ready-to-use commitlint configuration:
-
-```javascript
-import config from '@jmlweb/commitlint-config';
-export default config;
-```
-
-### Named Exports
-
-```typescript
-import {
-  createCommitlintConfig, // Factory function for custom configs
-  COMMIT_TYPES, // Array of allowed commit types
-  COMMIT_SCOPES, // Array of allowed scopes
-} from '@jmlweb/commitlint-config';
-```
-
 ## Requirements
 
 - **Node.js** >= 18.0.0

package/dist/index.cjs

@@ -20,7 +20,6 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
 // src/index.ts
 var index_exports = {};
 __export(index_exports, {
-  COMMIT_SCOPES: () => COMMIT_SCOPES,
   COMMIT_TYPES: () => COMMIT_TYPES,
   createCommitlintConfig: () => createCommitlintConfig,
   default: () => index_default
@@ -50,54 +49,32 @@ var COMMIT_TYPES = [
   "revert"
   // Reverting previous commits
 ];
-var COMMIT_SCOPES = [
-  // ESLint configs
-  "eslint-config-base",
-  "eslint-config-base-js",
-  "eslint-config-react",
-  // Prettier configs
-  "prettier-config-base",
-  "prettier-config-tailwind",
-  // TypeScript configs
-  "tsconfig-base",
-  "tsconfig-internal",
-  "tsconfig-nextjs",
-  "tsconfig-react",
-  // Build configs
-  "tsup-config-base",
-  // Test configs
-  "vitest-config",
-  // Commitlint config
-  "commitlint-config",
-  // Common scopes
-  "deps",
-  // Dependency updates
-  "release",
-  // Release-related changes
-  "scripts",
-  // Build/CI scripts
-  "workspace"
-  // Workspace configuration
-];
-var createCommitlintConfig = (options = {}) => {
+var createCommitlintConfig = (options = {}, baseScopes) => {
   const {
     additionalTypes = [],
+    scopes,
     additionalScopes = [],
     headerMaxLength = 100,
     scopeRequired = false,
-    bodyRequired = false
+    bodyRequired = false,
+    ignores
   } = options;
   const allTypes = [...COMMIT_TYPES, ...additionalTypes];
-  const allScopes = [...COMMIT_SCOPES, ...additionalScopes];
-  return {
+  let finalScopes;
+  if (scopes !== void 0) {
+    finalScopes = scopes;
+  } else if (baseScopes !== void 0 || additionalScopes.length > 0) {
+    finalScopes = [...baseScopes ?? [], ...additionalScopes];
+  }
+  const config2 = {
     extends: ["@commitlint/config-conventional"],
     rules: {
       // Type rules
       "type-enum": [2, "always", allTypes],
       "type-case": [2, "always", "lower-case"],
       "type-empty": [2, "never"],
-      // Scope rules
-      "scope-enum": [2, "always", allScopes],
+      // Scope rules - only enforce enum if scopes are defined
+      "scope-enum": finalScopes ? [2, "always", finalScopes] : [0],
       "scope-case": [2, "always", "kebab-case"],
       "scope-empty": scopeRequired ? [2, "never"] : [0],
       // Subject rules
@@ -115,12 +92,15 @@ var createCommitlintConfig = (options = {}) => {
       "footer-max-line-length": [2, "always", 100]
     }
   };
+  if (ignores && ignores.length > 0) {
+    config2.ignores = ignores;
+  }
+  return config2;
 };
 var config = createCommitlintConfig();
 var index_default = config;
 // Annotate the CommonJS export names for ESM import in node:
 0 && (module.exports = {
-  COMMIT_SCOPES,
   COMMIT_TYPES,
   createCommitlintConfig
 });

package/dist/index.d.cts

@@ -5,24 +5,25 @@ export { UserConfig } from '@commitlint/types';
  * Allowed commit types following Conventional Commits specification
  */
 declare const COMMIT_TYPES: readonly ["feat", "fix", "docs", "chore", "refactor", "test", "ci", "perf", "style", "build", "revert"];
-/**
- * Allowed scopes matching @jmlweb package names
- * These are extracted from the package names without the @jmlweb/ prefix
- */
-declare const COMMIT_SCOPES: readonly ["eslint-config-base", "eslint-config-base-js", "eslint-config-react", "prettier-config-base", "prettier-config-tailwind", "tsconfig-base", "tsconfig-internal", "tsconfig-nextjs", "tsconfig-react", "tsup-config-base", "vitest-config", "commitlint-config", "deps", "release", "scripts", "workspace"];
 type CommitType = (typeof COMMIT_TYPES)[number];
-type CommitScope = (typeof COMMIT_SCOPES)[number];
 /**
  * Options for creating a commitlint configuration
  */
 interface CommitlintConfigOptions {
     /**
-     * Additional commit types to allow
+     * Additional commit types to allow (merged with defaults)
      * @default []
      */
     additionalTypes?: string[];
     /**
-     * Additional scopes to allow
+     * Scopes to allow. When provided, completely replaces any base scopes.
+     * Use this when you want full control over allowed scopes.
+     * @default undefined (no scope restrictions)
+     */
+    scopes?: string[];
+    /**
+     * Additional scopes to allow (merged with base scopes if any).
+     * Only used when `scopes` is not provided.
      * @default []
      */
     additionalScopes?: string[];
@@ -41,23 +42,29 @@ interface CommitlintConfigOptions {
      * @default false
      */
     bodyRequired?: boolean;
+    /**
+     * Custom function to ignore certain commits (e.g., merge commits, dependabot)
+     * Return true to skip validation for a commit
+     */
+    ignores?: ((commit: string) => boolean)[];
 }
 /**
- * Creates a commitlint configuration with sensible defaults
+ * Creates a commitlint configuration with sensible defaults.
+ * By default, no scope restrictions are applied - any scope is allowed.
  *
  * @example
  * ```typescript
- * // Simple usage with defaults
+ * // Simple usage - any scope is allowed
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig();
  * ```
  *
  * @example
  * ```typescript
- * // With additional scopes for your project
+ * // Define allowed scopes for your project
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig({
- *   additionalScopes: ['api', 'ui', 'database'],
+ *   scopes: ['api', 'ui', 'database', 'auth'],
  * });
  * ```
  *
@@ -66,15 +73,28 @@ interface CommitlintConfigOptions {
  * // Strict configuration with required scope
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig({
+ *   scopes: ['core', 'utils', 'deps'],
  *   scopeRequired: true,
  *   headerMaxLength: 72,
  * });
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Ignore merge commits and dependabot
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   ignores: [
+ *     (commit) => commit.startsWith('Merge'),
+ *     (commit) => /^chore\(deps\)/.test(commit),
+ *   ],
+ * });
+ * ```
  */
-declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => UserConfig;
+declare const createCommitlintConfig: (options?: CommitlintConfigOptions, baseScopes?: readonly string[]) => UserConfig;
 /**
  * Default commitlint configuration
- * Use this directly if you don't need customization
+ * Generic configuration with no scope restrictions - suitable for any project.
  *
  * @example
  * ```javascript
@@ -85,4 +105,4 @@ declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => Use
  */
 declare const config: UserConfig;
 
-export { COMMIT_SCOPES, COMMIT_TYPES, type CommitScope, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };
+export { COMMIT_TYPES, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };

package/dist/index.d.ts

@@ -5,24 +5,25 @@ export { UserConfig } from '@commitlint/types';
  * Allowed commit types following Conventional Commits specification
  */
 declare const COMMIT_TYPES: readonly ["feat", "fix", "docs", "chore", "refactor", "test", "ci", "perf", "style", "build", "revert"];
-/**
- * Allowed scopes matching @jmlweb package names
- * These are extracted from the package names without the @jmlweb/ prefix
- */
-declare const COMMIT_SCOPES: readonly ["eslint-config-base", "eslint-config-base-js", "eslint-config-react", "prettier-config-base", "prettier-config-tailwind", "tsconfig-base", "tsconfig-internal", "tsconfig-nextjs", "tsconfig-react", "tsup-config-base", "vitest-config", "commitlint-config", "deps", "release", "scripts", "workspace"];
 type CommitType = (typeof COMMIT_TYPES)[number];
-type CommitScope = (typeof COMMIT_SCOPES)[number];
 /**
  * Options for creating a commitlint configuration
  */
 interface CommitlintConfigOptions {
     /**
-     * Additional commit types to allow
+     * Additional commit types to allow (merged with defaults)
      * @default []
      */
     additionalTypes?: string[];
     /**
-     * Additional scopes to allow
+     * Scopes to allow. When provided, completely replaces any base scopes.
+     * Use this when you want full control over allowed scopes.
+     * @default undefined (no scope restrictions)
+     */
+    scopes?: string[];
+    /**
+     * Additional scopes to allow (merged with base scopes if any).
+     * Only used when `scopes` is not provided.
      * @default []
      */
     additionalScopes?: string[];
@@ -41,23 +42,29 @@ interface CommitlintConfigOptions {
      * @default false
      */
     bodyRequired?: boolean;
+    /**
+     * Custom function to ignore certain commits (e.g., merge commits, dependabot)
+     * Return true to skip validation for a commit
+     */
+    ignores?: ((commit: string) => boolean)[];
 }
 /**
- * Creates a commitlint configuration with sensible defaults
+ * Creates a commitlint configuration with sensible defaults.
+ * By default, no scope restrictions are applied - any scope is allowed.
  *
  * @example
  * ```typescript
- * // Simple usage with defaults
+ * // Simple usage - any scope is allowed
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig();
  * ```
  *
  * @example
  * ```typescript
- * // With additional scopes for your project
+ * // Define allowed scopes for your project
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig({
- *   additionalScopes: ['api', 'ui', 'database'],
+ *   scopes: ['api', 'ui', 'database', 'auth'],
  * });
  * ```
  *
@@ -66,15 +73,28 @@ interface CommitlintConfigOptions {
  * // Strict configuration with required scope
  * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
  * export default createCommitlintConfig({
+ *   scopes: ['core', 'utils', 'deps'],
  *   scopeRequired: true,
  *   headerMaxLength: 72,
  * });
  * ```
+ *
+ * @example
+ * ```typescript
+ * // Ignore merge commits and dependabot
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   ignores: [
+ *     (commit) => commit.startsWith('Merge'),
+ *     (commit) => /^chore\(deps\)/.test(commit),
+ *   ],
+ * });
+ * ```
  */
-declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => UserConfig;
+declare const createCommitlintConfig: (options?: CommitlintConfigOptions, baseScopes?: readonly string[]) => UserConfig;
 /**
  * Default commitlint configuration
- * Use this directly if you don't need customization
+ * Generic configuration with no scope restrictions - suitable for any project.
  *
  * @example
  * ```javascript
@@ -85,4 +105,4 @@ declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => Use
  */
 declare const config: UserConfig;
 
-export { COMMIT_SCOPES, COMMIT_TYPES, type CommitScope, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };
+export { COMMIT_TYPES, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };

package/dist/index.js

@@ -23,54 +23,32 @@ var COMMIT_TYPES = [
   "revert"
   // Reverting previous commits
 ];
-var COMMIT_SCOPES = [
-  // ESLint configs
-  "eslint-config-base",
-  "eslint-config-base-js",
-  "eslint-config-react",
-  // Prettier configs
-  "prettier-config-base",
-  "prettier-config-tailwind",
-  // TypeScript configs
-  "tsconfig-base",
-  "tsconfig-internal",
-  "tsconfig-nextjs",
-  "tsconfig-react",
-  // Build configs
-  "tsup-config-base",
-  // Test configs
-  "vitest-config",
-  // Commitlint config
-  "commitlint-config",
-  // Common scopes
-  "deps",
-  // Dependency updates
-  "release",
-  // Release-related changes
-  "scripts",
-  // Build/CI scripts
-  "workspace"
-  // Workspace configuration
-];
-var createCommitlintConfig = (options = {}) => {
+var createCommitlintConfig = (options = {}, baseScopes) => {
   const {
     additionalTypes = [],
+    scopes,
     additionalScopes = [],
     headerMaxLength = 100,
     scopeRequired = false,
-    bodyRequired = false
+    bodyRequired = false,
+    ignores
   } = options;
   const allTypes = [...COMMIT_TYPES, ...additionalTypes];
-  const allScopes = [...COMMIT_SCOPES, ...additionalScopes];
-  return {
+  let finalScopes;
+  if (scopes !== void 0) {
+    finalScopes = scopes;
+  } else if (baseScopes !== void 0 || additionalScopes.length > 0) {
+    finalScopes = [...baseScopes ?? [], ...additionalScopes];
+  }
+  const config2 = {
     extends: ["@commitlint/config-conventional"],
     rules: {
       // Type rules
       "type-enum": [2, "always", allTypes],
       "type-case": [2, "always", "lower-case"],
       "type-empty": [2, "never"],
-      // Scope rules
-      "scope-enum": [2, "always", allScopes],
+      // Scope rules - only enforce enum if scopes are defined
+      "scope-enum": finalScopes ? [2, "always", finalScopes] : [0],
       "scope-case": [2, "always", "kebab-case"],
       "scope-empty": scopeRequired ? [2, "never"] : [0],
       // Subject rules
@@ -88,11 +66,14 @@ var createCommitlintConfig = (options = {}) => {
       "footer-max-line-length": [2, "always", 100]
     }
   };
+  if (ignores && ignores.length > 0) {
+    config2.ignores = ignores;
+  }
+  return config2;
 };
 var config = createCommitlintConfig();
 var index_default = config;
 export {
-  COMMIT_SCOPES,
   COMMIT_TYPES,
   createCommitlintConfig,
   index_default as default

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@jmlweb/commitlint-config",
-  "version": "0.0.0",
+  "version": "2.0.0",
   "description": "Shared commitlint configuration for enforcing Conventional Commits",
   "type": "module",
   "main": "./dist/index.cjs",
@@ -32,7 +32,10 @@
   ],
   "author": "jmlweb",
   "license": "MIT",
-  "repository": "jmlweb/tooling.git",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/jmlweb/tooling.git"
+  },
   "bugs": "https://github.com/jmlweb/tooling/issues",
   "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/commitlint-config#readme",
   "engines": {