commitlint-plugin-function-rules 3.0.0 → 4.0.0-beta.1

package/README.md

@@ -58,7 +58,7 @@ module.exports = {
 
 ## Contributing
 
-Please [create an issue](https://github.com/vidavidorra/commitlint-plugin-function-rules/issues/new/choose) if you have a bug report or feature proposal, or [create a discussion](https://github.com/vidavidorra/commitlint-plugin-function-rules/discussions) if you have a question. If you like this project, please consider giving it a star ⭐ and/or become a [sponsor](https://github.com/sponsors/jdbruijn) to support my work.
+Please [create an issue](https://github.com/vidavidorra/commitlint-plugin-function-rules/issues/new/choose) if you have a bug report or feature proposal, or [create a discussion](https://github.com/vidavidorra/commitlint-plugin-function-rules/discussions) if you have a question. If you like this project, please consider giving it a star ⭐
 
 Refer to the [contributing guide](https://github.com/vidavidorra/.github/blob/main/CONTRIBUTING.md) detailed information about other contributions, like pull requests.
 
@@ -74,7 +74,7 @@ Please refer to the [Security Policy on GitHub](https://github.com/vidavidorra/c
 
 This project is licensed under the [GPLv3 license](https://www.gnu.org/licenses/gpl.html).
 
-Copyright © 2020-2023 Jeroen de Bruijn
+Copyright © 2020-2024 Jeroen de Bruijn
 
 <details><summary>License notice</summary>
 <p>

package/dist/function-rule.d.ts

@@ -1,4 +1,5 @@
-import { type Commit, type Rule, type RuleConfigCondition, type RuleOutcome } from '@commitlint/types';
+import { type Rule, type RuleConfigCondition, type RuleOutcome } from '@commitlint/types';
+type Commit = Parameters<Rule>[0];
 type FunctionRule = (parsed: Commit, when: RuleConfigCondition) => RuleOutcome | Promise<RuleOutcome>;
 declare const functionRule: Rule<FunctionRule>;
-export { type FunctionRule, functionRule };
+export { type Commit, functionRule };

package/dist/index.d.ts

@@ -1,9 +1 @@
-import { plugin } from './plugin.js';
-/**
- * Export single object, according to the CommonJS model. The CommonJS module is
- * explicitly used here as that's the kind of module commitlint requires for
- * shareable configurations. This project is an ES module for ease of
- * development, and thus requires the error for an export assignment to be
- * disabled.
- */
-export = plugin;
+export { rules } from './rules.js';

package/dist/index.js

@@ -1,2 +1,2 @@
-import { plugin } from './plugin.js';
+export { rules } from './rules.js';
 //# sourceMappingURL=index.js.map

package/dist/rules.js

@@ -16,6 +16,7 @@ const rules = {
     'function-rules/header-full-stop': functionRule,
     'function-rules/header-max-length': functionRule,
     'function-rules/header-min-length': functionRule,
+    'function-rules/header-trim': functionRule,
     'function-rules/references-empty': functionRule,
     'function-rules/scope-case': functionRule,
     'function-rules/scope-empty': functionRule,

package/package.json

@@ -1,10 +1,11 @@
 {
   "name": "commitlint-plugin-function-rules",
-  "version": "3.0.0",
-  "description": "commitlint plugin to define rules as functions.",
+  "version": "4.0.0-beta.1",
+  "description": "commitlint plugin to use functions as rule value",
   "keywords": [
     "commitlint",
     "commitlintplugin",
+    "function",
     "plugin",
     "rules"
   ],
@@ -19,24 +20,17 @@
   "license": "GPL-3.0-or-later",
   "author": "Jeroen de Bruijn",
   "type": "module",
-  "exports": {
-    ".": {
-      "import": "./dist/plugin.js",
-      "require": "./dist/index.cjs"
-    }
-  },
+  "exports": "./dist/index.js",
   "files": [
     "./dist/**/!(*.test).{js,d.ts,cjs}"
   ],
   "scripts": {
-    "build": "npm run build:esm && npm run build:cjs",
-    "build:cjs": "esbuild src/index.ts --bundle --target=ES2022 --platform=node --outfile=dist/index.cjs",
-    "build:esm": "tsc",
+    "build": "tsc",
     "format": "prettier --ignore-path .gitignore --write \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
     "format:check": "prettier --ignore-path .gitignore --check \"**/*.{vue,css,less,scss,html,htm,json,md,markdown,yml,yaml}\" --log-level warn",
     "lint": "npm run format:check && xo",
     "lint:fix": "npm run format && xo --fix",
-    "prepare": "husky install .github/husky",
+    "prepare": "husky .github/husky",
     "test": "c8 ava"
   },
   "xo": {
@@ -192,49 +186,30 @@
   },
   "devDependencies": {
     "@ava/typescript": "4.1.0",
-    "@commitlint/cli": "18.2.0",
-    "@commitlint/config-conventional": "18.1.0",
-    "@commitlint/lint-10.x": "npm:@commitlint/lint@10.0.0",
-    "@commitlint/lint-11.x": "npm:@commitlint/lint@11.0.0",
-    "@commitlint/lint-12.x": "npm:@commitlint/lint@12.1.4",
-    "@commitlint/lint-13.x": "npm:@commitlint/lint@13.2.0",
-    "@commitlint/lint-14.x": "npm:@commitlint/lint@14.1.0",
-    "@commitlint/lint-15.x": "npm:@commitlint/lint@15.0.0",
-    "@commitlint/lint-16.x": "npm:@commitlint/lint@16.2.4",
-    "@commitlint/lint-17.x": "npm:@commitlint/lint@17.8.1",
-    "@commitlint/lint-18.x": "npm:@commitlint/lint@18.1.0",
-    "@commitlint/lint-9.x": "npm:@commitlint/lint@9.1.2",
-    "@commitlint/load-10.x": "npm:@commitlint/load@10.0.0",
-    "@commitlint/load-11.x": "npm:@commitlint/load@11.0.0",
-    "@commitlint/load-12.x": "npm:@commitlint/load@12.1.4",
-    "@commitlint/load-13.x": "npm:@commitlint/load@13.2.1",
-    "@commitlint/load-14.x": "npm:@commitlint/load@14.1.0",
-    "@commitlint/load-15.x": "npm:@commitlint/load@15.0.0",
-    "@commitlint/load-16.x": "npm:@commitlint/load@16.3.0",
-    "@commitlint/load-17.x": "npm:@commitlint/load@17.8.1",
-    "@commitlint/load-18.x": "npm:@commitlint/load@18.2.0",
-    "@commitlint/load-9.x": "npm:@commitlint/load@9.1.2",
-    "@commitlint/rules": "18.1.0",
-    "@commitlint/types": "18.1.0",
+    "@commitlint/cli": "19.2.0",
+    "@commitlint/config-conventional": "19.1.0",
+    "@commitlint/lint-19.x": "npm:@commitlint/lint@19.1.0",
+    "@commitlint/load-19.x": "npm:@commitlint/load@19.1.0",
+    "@commitlint/rules": "19.0.3",
+    "@commitlint/types": "19.0.3",
     "@semantic-release/changelog": "6.0.3",
     "@semantic-release/exec": "6.0.3",
     "@semantic-release/git": "10.0.1",
-    "@types/sinon": "17.0.0",
-    "ava": "5.3.1",
-    "c8": "8.0.1",
-    "esbuild": "0.19.5",
-    "husky": "8.0.3",
-    "lint-staged": "15.0.2",
-    "prettier": "3.0.3",
-    "semantic-release": "22.0.7",
+    "@types/sinon": "17.0.3",
+    "ava": "6.1.2",
+    "c8": "9.1.0",
+    "husky": "9.0.11",
+    "lint-staged": "15.2.2",
+    "prettier": "3.2.5",
+    "semantic-release": "23.0.2",
     "sinon": "17.0.1",
-    "typescript": "5.2.2",
-    "xo": "0.56.0"
+    "typescript": "5.4.2",
+    "xo": "0.58.0"
   },
   "peerDependencies": {
-    "@commitlint/lint": ">=9.1.2 <19"
+    "@commitlint/lint": ">=19 <20"
   },
   "engines": {
-    "node": ">=18"
+    "node": ">=20"
   }
 }

package/dist/index.cjs

@@ -1,57 +0,0 @@
-"use strict";
-
-// src/function-rule.ts
-var functionRule = async (parsed, when = "always", functionRule2) => {
-  if (functionRule2 === void 0) {
-    return [true];
-  }
-  if (typeof functionRule2 !== "function") {
-    throw new TypeError("Not a valid function!");
-  }
-  return functionRule2(parsed, when);
-};
-
-// src/rules.ts
-var rules = {
-  "function-rules/body-case": functionRule,
-  "function-rules/body-empty": functionRule,
-  "function-rules/body-full-stop": functionRule,
-  "function-rules/body-leading-blank": functionRule,
-  "function-rules/body-max-length": functionRule,
-  "function-rules/body-max-line-length": functionRule,
-  "function-rules/body-min-length": functionRule,
-  "function-rules/footer-empty": functionRule,
-  "function-rules/footer-leading-blank": functionRule,
-  "function-rules/footer-max-length": functionRule,
-  "function-rules/footer-max-line-length": functionRule,
-  "function-rules/footer-min-length": functionRule,
-  "function-rules/header-case": functionRule,
-  "function-rules/header-full-stop": functionRule,
-  "function-rules/header-max-length": functionRule,
-  "function-rules/header-min-length": functionRule,
-  "function-rules/references-empty": functionRule,
-  "function-rules/scope-case": functionRule,
-  "function-rules/scope-empty": functionRule,
-  "function-rules/scope-enum": functionRule,
-  "function-rules/scope-max-length": functionRule,
-  "function-rules/scope-min-length": functionRule,
-  "function-rules/signed-off-by": functionRule,
-  "function-rules/subject-case": functionRule,
-  "function-rules/subject-empty": functionRule,
-  "function-rules/subject-exclamation-mark": functionRule,
-  "function-rules/subject-full-stop": functionRule,
-  "function-rules/subject-max-length": functionRule,
-  "function-rules/subject-min-length": functionRule,
-  "function-rules/trailer-exists": functionRule,
-  "function-rules/type-case": functionRule,
-  "function-rules/type-empty": functionRule,
-  "function-rules/type-enum": functionRule,
-  "function-rules/type-max-length": functionRule,
-  "function-rules/type-min-length": functionRule
-};
-
-// src/plugin.ts
-var plugin = { rules };
-
-// src/index.ts
-module.exports = plugin;

package/dist/plugin.d.ts

@@ -1,3 +0,0 @@
-import { type Plugin } from '@commitlint/types';
-declare const plugin: Plugin;
-export { plugin };

package/dist/plugin.js

@@ -1,4 +0,0 @@
-import { rules } from './rules.js';
-const plugin = { rules };
-export { plugin };
-//# sourceMappingURL=plugin.js.map