feat(conventional-commits-parser)!: rewrite to TypeScript (#1126)

BREAKING CHANGES: Now package exports CommitParser class and parseCommitsStream method for backward compatability. Options has minor changes in types, please read the docs.

.eslintrc.json

@@ -1,5 +1,9 @@
 {
+  "root": true,
   "extends": "standard",
+  "env": {
+    "node": true
+  },
   "overrides": [
     {
       "files": [
@@ -8,6 +12,23 @@
       "env": {
         "mocha": true
       }
+    },
+    {
+      "files": [
+        "packages/**/*.ts"
+      ],
+      "extends": [
+        "@trigen/eslint-config",
+        "@trigen/eslint-config/tsm",
+        "@trigen/eslint-config/esm",
+        "@trigen/eslint-config/jest"
+      ],
+      "env": {
+        "node": true
+      }
     }
+  ],
+  "ignorePatterns": [
+    "packages/*/dist/**/*"
   ]
 }

.gitignore

@@ -1,11 +1,32 @@
-**/.nyc_output/
-**/coverage/
-**/node_modules/
-**/tmp/
-/lerna-debug.log
-package-lock.json
-
-# Editors
+# Logs
+logs
+*.log
+npm-debug.log*
+
+# Coverage directory used by tools like istanbul
+coverage
+
+# Dependency directory
+node_modules
+
+# Optional npm cache directory
+.npm
+
+# OS stuff
+._*
+.DS_Store
+
+# Some caches
+.*cache
+
+# Compiled dist
+dist
+package
+build
+
+# Env files
+.env
+
+# IDE files
 .idea
 .vscode
-.DS_Store

.npmrc

@@ -0,0 +1 @@
+auto-install-peers=false

package.json

@@ -36,21 +36,30 @@
     "url": "https://github.com/conventional-changelog/conventional-changelog.git"
   },
   "scripts": {
+    "clear": "pnpm -r --parallel --if-present clear && del ./coverage",
+    "build": "pnpm -r --parallel --if-present build",
     "lint": "eslint . --cache --cache-location ./node_modules/.cache/ --ignore-path .gitignore",
     "fix": "eslint . --fix --cache --cache-location ./node_modules/.cache/ --ignore-path .gitignore",
     "test:watch": "vitest watch",
     "test": "vitest run --coverage"
   },
   "version": "1.0.0",
   "devDependencies": {
+    "@trigen/eslint-config": "8.0.0-alpha.28",
+    "@types/node": "^20.5.9",
     "@vitest/coverage-v8": "^0.34.0",
     "better-than-before": "^1.0.0",
     "conventional-changelog-core": "workspace:^",
+    "del-cli": "^5.1.0",
     "eslint": "^8.0.0",
     "eslint-config-standard": "^17.0.0",
-    "forceable-tty": "^0.1.0",
+    "eslint-plugin-import": "^2.27.5",
+    "eslint-plugin-n": "^16.0.1",
+    "eslint-plugin-promise": "^6.0.0",
     "safe-buffer": "5.2.1",
     "tmp": "^0.2.1",
+    "tsm": "^2.3.0",
+    "typescript": "^5.2.2",
     "vinyl": "^3.0.0",
     "vite": "^4.4.4",
     "vitest": "^0.34.0"

packages/conventional-changelog-core/index.js

@@ -2,7 +2,7 @@ import { Readable, Transform } from 'stream'
 import { execFileSync } from 'child_process'
 import addStream from 'add-stream'
 import gitRawCommits from 'git-raw-commits'
-import conventionalCommitsParser from 'conventional-commits-parser'
+import { parseCommitsStream } from 'conventional-commits-parser'
 import conventionalChangelogWriter from 'conventional-changelog-writer'
 import mergeConfig from './lib/merge-config.js'
 
@@ -93,7 +93,7 @@ export default function conventionalChangelog (options, context, gitRawCommitsOp
           err.message = 'Error in git-raw-commits: ' + err.message
           setImmediate(readable.emit.bind(readable), 'error', err)
         })
-        .pipe(conventionalCommitsParser(parserOpts))
+        .pipe(parseCommitsStream(parserOpts))
         .on('error', function (err) {
           err.message = 'Error in conventional-commits-parser: ' + err.message
           setImmediate(readable.emit.bind(readable), 'error', err)

packages/conventional-changelog-jshint/parserOpts.js

@@ -5,6 +5,6 @@ export function createParserOpts () {
       'type',
       'shortDesc'
     ],
-    noteKeywords: 'BREAKING CHANGE'
+    noteKeywords: ['BREAKING CHANGE']
   }
 }

packages/conventional-commits-filter/index.js

@@ -23,7 +23,7 @@ function findRevertCommit (commit, reverts) {
     return null
   }
 
-  const rawCommit = commit.raw || commit
+  const rawCommit = commit.raw || commit // @todo: ??? remove?
 
   for (const revertCommit of reverts) {
     if (revertCommit.revert && isMatch(rawCommit, revertCommit.revert)) {

packages/conventional-commits-parser/.eslintrc.json

@@ -0,0 +1,11 @@
+{
+  "extends": [
+    "@trigen/eslint-config/typescript",
+    "@trigen/eslint-config/typescript-requiring-type-checking",
+    "@trigen/eslint-config/jest"
+  ],
+  "parserOptions": {
+    "tsconfigRootDir": "./packages/conventional-commits-parser",
+    "project": ["./tsconfig.json", "./test/tsconfig.json"]
+  }
+}