@commitlint/parse - npm Package Compare versions

Comparing version 20.3.1 to 20.4.0

lib/index.d.ts

 import type { Parser } from "@commitlint/types";
-import { type Commit, type Options } from "conventional-commits-parser";
-export declare function parse(message: string, parser?: Parser, parserOpts?: Options): Promise<Commit>;
+import { type Commit, type ParserOptions } from "conventional-commits-parser";
+export declare function parse(message: string, parser?: Parser, parserOpts?: ParserOptions): Promise<Commit>;
 export default parse;
 //# sourceMappingURL=index.d.ts.map

lib/index.js

@@ -1,11 +0,24 @@
-import { sync } from "conventional-commits-parser";
+import { CommitParser, } from "conventional-commits-parser";
 // @ts-expect-error -- no typings
 import defaultChangelogOpts from "conventional-changelog-angular";
-export async function parse(message, parser = sync, parserOpts) {
+const defaultParser = (message, options) => {
+    if (message === undefined || message === null) {
+        throw new TypeError("Expected a raw commit");
+    }
+    const parser = new CommitParser(options);
+    const result = parser.parse(message);
+    result.scope = result.scope ?? null;
+    result.subject = result.subject ?? null;
+    result.type = result.type ?? null;
+    return result;
+};
+export async function parse(message, parser = defaultParser, parserOpts) {
     const preset = await defaultChangelogOpts();
-    const defaultOpts = preset.parserOpts;
+    const defaultOpts = preset.parser || preset.parserOpts;
+    // Support user-provided parser options passed either flat or nested under a 'parser' key
+    const userOpts = parserOpts?.parser || parserOpts || {};
     const opts = {
         ...defaultOpts,
         fieldPattern: null,
-        ...(parserOpts || {}),
+        ...userOpts,
     };
@@ -12,0 +25,0 @@ const parsed = parser(message, opts);

package.json

 {
   "name": "@commitlint/parse",
   "type": "module",
-  "version": "20.3.1",
+  "version": "20.4.0",
   "description": "Lint your commit messages",
@@ -39,12 +39,11 @@ "main": "lib/index.js",
   "devDependencies": {
-    "@commitlint/test": "^20.0.0",
-    "@commitlint/utils": "^20.0.0",
-    "@types/conventional-commits-parser": "^5.0.0"
+    "@commitlint/test": "^20.4.0",
+    "@commitlint/utils": "^20.0.0"
   },
   "dependencies": {
-    "@commitlint/types": "^20.3.1",
-    "conventional-changelog-angular": "^7.0.0",
-    "conventional-commits-parser": "^5.0.0"
+    "@commitlint/types": "^20.4.0",
+    "conventional-changelog-angular": "^8.1.0",
+    "conventional-commits-parser": "^6.2.1"
   },
-  "gitHead": "be3a280aeadef5afa8ec83dbbe794ab2f72b9c3a"
+  "gitHead": "c68de5e24b010e38eac171f35ba18d31bb1fd3dd"
 }

No alert changes

Improved metrics

Total package byte prevSize

5699

23.38%

Dev dependency count

2

-33.33%

Lines of code

33

65%

Dependency changes

• + Added

  conventional-changelog-angular@8.2.0
  (transitive)

• - Removed

  JSONStream@1.3.5
  (transitive)

• - Removed

  conventional-changelog-angular@7.0.0
  (transitive)

• - Removed

  conventional-commits-parser@5.0.0
  (transitive)

• - Removed

  is-text-path@2.0.0
  (transitive)

• - Removed

  jsonparse@1.3.1
  (transitive)

• - Removed

  meow@12.1.1
  (transitive)

• - Removed

  split2@4.2.0
  (transitive)

• - Removed

  text-extensions@2.4.0
  (transitive)

• - Removed

  through@2.3.8
  (transitive)

• Updated

  @commitlint/types@^20.4.0

• Updated

  conventional-changelog-angular@^8.1.0

• Updated

  conventional-commits-parser@^6.2.1