@jmlweb/commitlint-config 0.0.0

package/CHANGELOG.md

@@ -0,0 +1,5 @@
+# @jmlweb/commitlint-config
+
+## 0.0.0
+
+Initial development version.

package/README.md

@@ -0,0 +1,218 @@
+# @jmlweb/commitlint-config
+
+[![npm version](https://img.shields.io/npm/v/@jmlweb/commitlint-config)](https://www.npmjs.com/package/@jmlweb/commitlint-config)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://opensource.org/licenses/MIT)
+[![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.
+
+## 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
+- TypeScript support with full type definitions
+- Easy integration with husky for Git hooks
+
+## Installation
+
+```bash
+npm install --save-dev @jmlweb/commitlint-config @commitlint/cli @commitlint/config-conventional
+```
+
+Or with pnpm:
+
+```bash
+pnpm add -D @jmlweb/commitlint-config @commitlint/cli @commitlint/config-conventional
+```
+
+## Quick Start
+
+Create a `commitlint.config.js` file in your project root:
+
+```javascript
+import commitlintConfig from '@jmlweb/commitlint-config';
+
+export default commitlintConfig;
+```
+
+Or with CommonJS:
+
+```javascript
+const commitlintConfig = require('@jmlweb/commitlint-config');
+
+module.exports = commitlintConfig;
+```
+
+## Commit Message Format
+
+This configuration enforces the Conventional Commits format:
+
+```text
+<type>(<scope>): <subject>
+
+[optional body]
+
+[optional footer(s)]
+```
+
+### Examples of Valid 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
+chore(deps): update dependencies
+refactor(tsconfig-base): simplify compiler options
+test(vitest-config): add unit tests for config factory
+ci: add GitHub Actions workflow
+```
+
+## Allowed Types
+
+| Type       | Description                           |
+| ---------- | ------------------------------------- |
+| `feat`     | New feature                           |
+| `fix`      | Bug fix                               |
+| `docs`     | Documentation changes                 |
+| `chore`    | Maintenance tasks                     |
+| `refactor` | Code refactoring                      |
+| `test`     | Adding or updating tests              |
+| `ci`       | CI/CD configuration                   |
+| `perf`     | Performance improvements              |
+| `style`    | Code style changes (formatting, etc.) |
+| `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
+
+## Customization
+
+### Adding Custom Scopes
+
+```typescript
+import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+
+export default createCommitlintConfig({
+  additionalScopes: ['api', 'ui', 'database', 'auth'],
+});
+```
+
+### Stricter Configuration
+
+```typescript
+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'],
+});
+```
+
+## Integration with Husky
+
+### Step 1: Install husky
+
+```bash
+pnpm add -D husky
+```
+
+### Step 2: Initialize husky
+
+```bash
+pnpm exec husky init
+```
+
+### Step 3: Add commit-msg hook
+
+Create or edit `.husky/commit-msg`:
+
+```bash
+pnpm exec commitlint --edit $1
+```
+
+### Step 4: Test your setup
+
+```bash
+# This should fail
+git commit -m "bad commit message"
+
+# This should pass
+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
+- **@commitlint/cli** >= 19.0.0
+- **@commitlint/config-conventional** >= 19.0.0
+
+## Related Packages
+
+- [`@jmlweb/eslint-config-base`](../eslint-config-base) - ESLint configuration for TypeScript
+- [`@jmlweb/prettier-config-base`](../prettier-config-base) - Prettier configuration
+- [`@jmlweb/tsconfig-base`](../tsconfig-base) - TypeScript configuration
+
+## License
+
+MIT

package/dist/index.cjs

@@ -0,0 +1,126 @@
+"use strict";
+var __defProp = Object.defineProperty;
+var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
+var __getOwnPropNames = Object.getOwnPropertyNames;
+var __hasOwnProp = Object.prototype.hasOwnProperty;
+var __export = (target, all) => {
+  for (var name in all)
+    __defProp(target, name, { get: all[name], enumerable: true });
+};
+var __copyProps = (to, from, except, desc) => {
+  if (from && typeof from === "object" || typeof from === "function") {
+    for (let key of __getOwnPropNames(from))
+      if (!__hasOwnProp.call(to, key) && key !== except)
+        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
+  }
+  return to;
+};
+var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
+
+// src/index.ts
+var index_exports = {};
+__export(index_exports, {
+  COMMIT_SCOPES: () => COMMIT_SCOPES,
+  COMMIT_TYPES: () => COMMIT_TYPES,
+  createCommitlintConfig: () => createCommitlintConfig,
+  default: () => index_default
+});
+module.exports = __toCommonJS(index_exports);
+var COMMIT_TYPES = [
+  "feat",
+  // New feature
+  "fix",
+  // Bug fix
+  "docs",
+  // Documentation changes
+  "chore",
+  // Maintenance tasks
+  "refactor",
+  // Code refactoring
+  "test",
+  // Adding or updating tests
+  "ci",
+  // CI/CD configuration
+  "perf",
+  // Performance improvements
+  "style",
+  // Code style changes (formatting, etc.)
+  "build",
+  // Build system changes
+  "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 = {}) => {
+  const {
+    additionalTypes = [],
+    additionalScopes = [],
+    headerMaxLength = 100,
+    scopeRequired = false,
+    bodyRequired = false
+  } = options;
+  const allTypes = [...COMMIT_TYPES, ...additionalTypes];
+  const allScopes = [...COMMIT_SCOPES, ...additionalScopes];
+  return {
+    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-case": [2, "always", "kebab-case"],
+      "scope-empty": scopeRequired ? [2, "never"] : [0],
+      // Subject rules
+      "subject-case": [2, "always", "lower-case"],
+      "subject-empty": [2, "never"],
+      "subject-full-stop": [2, "never", "."],
+      // Header rules
+      "header-max-length": [2, "always", headerMaxLength],
+      // Body rules
+      "body-leading-blank": [2, "always"],
+      "body-max-line-length": [2, "always", 100],
+      "body-empty": bodyRequired ? [2, "never"] : [0],
+      // Footer rules
+      "footer-leading-blank": [2, "always"],
+      "footer-max-line-length": [2, "always", 100]
+    }
+  };
+};
+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

@@ -0,0 +1,88 @@
+import { UserConfig } from '@commitlint/types';
+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
+     * @default []
+     */
+    additionalTypes?: string[];
+    /**
+     * Additional scopes to allow
+     * @default []
+     */
+    additionalScopes?: string[];
+    /**
+     * Maximum length for the header line
+     * @default 100
+     */
+    headerMaxLength?: number;
+    /**
+     * Whether to require a scope
+     * @default false
+     */
+    scopeRequired?: boolean;
+    /**
+     * Whether to require body for certain commit types
+     * @default false
+     */
+    bodyRequired?: boolean;
+}
+/**
+ * Creates a commitlint configuration with sensible defaults
+ *
+ * @example
+ * ```typescript
+ * // Simple usage with defaults
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With additional scopes for your project
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   additionalScopes: ['api', 'ui', 'database'],
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Strict configuration with required scope
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   scopeRequired: true,
+ *   headerMaxLength: 72,
+ * });
+ * ```
+ */
+declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => UserConfig;
+/**
+ * Default commitlint configuration
+ * Use this directly if you don't need customization
+ *
+ * @example
+ * ```javascript
+ * // commitlint.config.js
+ * import commitlintConfig from '@jmlweb/commitlint-config';
+ * export default commitlintConfig;
+ * ```
+ */
+declare const config: UserConfig;
+
+export { COMMIT_SCOPES, COMMIT_TYPES, type CommitScope, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };

package/dist/index.d.ts

@@ -0,0 +1,88 @@
+import { UserConfig } from '@commitlint/types';
+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
+     * @default []
+     */
+    additionalTypes?: string[];
+    /**
+     * Additional scopes to allow
+     * @default []
+     */
+    additionalScopes?: string[];
+    /**
+     * Maximum length for the header line
+     * @default 100
+     */
+    headerMaxLength?: number;
+    /**
+     * Whether to require a scope
+     * @default false
+     */
+    scopeRequired?: boolean;
+    /**
+     * Whether to require body for certain commit types
+     * @default false
+     */
+    bodyRequired?: boolean;
+}
+/**
+ * Creates a commitlint configuration with sensible defaults
+ *
+ * @example
+ * ```typescript
+ * // Simple usage with defaults
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig();
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // With additional scopes for your project
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   additionalScopes: ['api', 'ui', 'database'],
+ * });
+ * ```
+ *
+ * @example
+ * ```typescript
+ * // Strict configuration with required scope
+ * import { createCommitlintConfig } from '@jmlweb/commitlint-config';
+ * export default createCommitlintConfig({
+ *   scopeRequired: true,
+ *   headerMaxLength: 72,
+ * });
+ * ```
+ */
+declare const createCommitlintConfig: (options?: CommitlintConfigOptions) => UserConfig;
+/**
+ * Default commitlint configuration
+ * Use this directly if you don't need customization
+ *
+ * @example
+ * ```javascript
+ * // commitlint.config.js
+ * import commitlintConfig from '@jmlweb/commitlint-config';
+ * export default commitlintConfig;
+ * ```
+ */
+declare const config: UserConfig;
+
+export { COMMIT_SCOPES, COMMIT_TYPES, type CommitScope, type CommitType, type CommitlintConfigOptions, createCommitlintConfig, config as default };

package/dist/index.js

@@ -0,0 +1,99 @@
+// src/index.ts
+var COMMIT_TYPES = [
+  "feat",
+  // New feature
+  "fix",
+  // Bug fix
+  "docs",
+  // Documentation changes
+  "chore",
+  // Maintenance tasks
+  "refactor",
+  // Code refactoring
+  "test",
+  // Adding or updating tests
+  "ci",
+  // CI/CD configuration
+  "perf",
+  // Performance improvements
+  "style",
+  // Code style changes (formatting, etc.)
+  "build",
+  // Build system changes
+  "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 = {}) => {
+  const {
+    additionalTypes = [],
+    additionalScopes = [],
+    headerMaxLength = 100,
+    scopeRequired = false,
+    bodyRequired = false
+  } = options;
+  const allTypes = [...COMMIT_TYPES, ...additionalTypes];
+  const allScopes = [...COMMIT_SCOPES, ...additionalScopes];
+  return {
+    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-case": [2, "always", "kebab-case"],
+      "scope-empty": scopeRequired ? [2, "never"] : [0],
+      // Subject rules
+      "subject-case": [2, "always", "lower-case"],
+      "subject-empty": [2, "never"],
+      "subject-full-stop": [2, "never", "."],
+      // Header rules
+      "header-max-length": [2, "always", headerMaxLength],
+      // Body rules
+      "body-leading-blank": [2, "always"],
+      "body-max-line-length": [2, "always", 100],
+      "body-empty": bodyRequired ? [2, "never"] : [0],
+      // Footer rules
+      "footer-leading-blank": [2, "always"],
+      "footer-max-line-length": [2, "always", 100]
+    }
+  };
+};
+var config = createCommitlintConfig();
+var index_default = config;
+export {
+  COMMIT_SCOPES,
+  COMMIT_TYPES,
+  createCommitlintConfig,
+  index_default as default
+};

package/package.json

@@ -0,0 +1,60 @@
+{
+  "name": "@jmlweb/commitlint-config",
+  "version": "0.0.0",
+  "description": "Shared commitlint configuration for enforcing Conventional Commits",
+  "type": "module",
+  "main": "./dist/index.cjs",
+  "module": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": {
+        "types": "./dist/index.d.ts",
+        "default": "./dist/index.js"
+      },
+      "require": {
+        "types": "./dist/index.d.cts",
+        "default": "./dist/index.cjs"
+      }
+    }
+  },
+  "files": [
+    "dist",
+    "README.md",
+    "CHANGELOG.md"
+  ],
+  "keywords": [
+    "commitlint",
+    "commitlint-config",
+    "conventional-commits",
+    "git",
+    "lint"
+  ],
+  "author": "jmlweb",
+  "license": "MIT",
+  "repository": "jmlweb/tooling.git",
+  "bugs": "https://github.com/jmlweb/tooling/issues",
+  "homepage": "https://github.com/jmlweb/tooling/tree/main/packages/commitlint-config#readme",
+  "engines": {
+    "node": ">=18.0.0"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "peerDependencies": {
+    "@commitlint/cli": ">=19.0.0",
+    "@commitlint/config-conventional": ">=19.0.0"
+  },
+  "devDependencies": {
+    "@commitlint/cli": "^19.8.1",
+    "@commitlint/config-conventional": "^19.8.1",
+    "@commitlint/types": "^19.8.1",
+    "tsup": "^8.5.1",
+    "typescript": "^5.9.3",
+    "@jmlweb/tsconfig-internal": "0.0.1"
+  },
+  "scripts": {
+    "build": "tsup",
+    "clean": "rm -rf dist"
+  }
+}