conventional-changelog-angular 7.0.0 → 8.1.0

package/README.md

@@ -1,11 +1,16 @@
 # conventional-changelog-angular
 
+[![ESM-only package][package]][package-url]
 [![NPM version][npm]][npm-url]
 [![Node version][node]][node-url]
 [![Dependencies status][deps]][deps-url]
+[![Install size][size]][size-url]
 [![Build status][build]][build-url]
 [![Coverage status][coverage]][coverage-url]
 
+[package]: https://img.shields.io/badge/package-ESM--only-ffe536.svg
+[package-url]: https://nodejs.org/api/esm.html
+
 [npm]: https://img.shields.io/npm/v/conventional-changelog-angular.svg
 [npm-url]: https://npmjs.com/package/conventional-changelog-angular
 
@@ -15,7 +20,10 @@
 [deps]: https://img.shields.io/librariesio/release/npm/conventional-changelog-angular
 [deps-url]: https://libraries.io/npm/conventional-changelog-angular/tree
 
-[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/ci.yaml?branch=master
+[size]: https://packagephobia.com/badge?p=conventional-changelog-angular
+[size-url]: https://packagephobia.com/result?p=conventional-changelog-angular
+
+[build]: https://img.shields.io/github/actions/workflow/status/conventional-changelog/conventional-changelog/tests.yaml?branch=master
 [build-url]: https://github.com/conventional-changelog/conventional-changelog/actions
 
 [coverage]: https://coveralls.io/repos/github/conventional-changelog/conventional-changelog/badge.svg?branch=master
@@ -124,3 +132,9 @@ reference GitHub issues that this commit **Closes**.
 **Breaking Changes** should start with the word `BREAKING CHANGE:` with a space or two newlines. The rest of the commit message is then used for this.
 
 A detailed explanation can be found in this [document](#commit-message-format).
+
+## Specific Options
+
+| Option | Description |
+|--------|-------------|
+| ignoreCommits | Regular expression to match and exclude commits from the changelog. Commits matching this pattern will be ignored. |

package/package.json

@@ -1,34 +1,31 @@
 {
   "name": "conventional-changelog-angular",
-  "version": "7.0.0",
-  "description": "conventional-changelog angular preset",
-  "main": "index.js",
+  "type": "module",
+  "version": "8.1.0",
+  "description": "Angular preset for conventional-changelog.",
+  "author": "Steve Mao",
+  "license": "ISC",
+  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#readme",
   "repository": {
     "type": "git",
-    "url": "https://github.com/conventional-changelog/conventional-changelog.git"
+    "url": "https://github.com/conventional-changelog/conventional-changelog.git",
+    "directory": "packages/conventional-changelog-angular"
+  },
+  "bugs": {
+    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
   },
   "keywords": [
     "conventional-changelog",
     "angular",
     "preset"
   ],
-  "files": [
-    "conventionalChangelog.js",
-    "conventionalRecommendedBump.js",
-    "index.js",
-    "parserOpts.js",
-    "writerOpts.js",
-    "templates"
-  ],
-  "author": "Steve Mao",
   "engines": {
-    "node": ">=16"
-  },
-  "license": "ISC",
-  "bugs": {
-    "url": "https://github.com/conventional-changelog/conventional-changelog/issues"
+    "node": ">=18"
   },
-  "homepage": "https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular#readme",
+  "exports": "./src/index.js",
+  "files": [
+    "src"
+  ],
   "dependencies": {
     "compare-func": "^2.0.0"
   }

package/src/index.js

@@ -0,0 +1,15 @@
+import { createParserOpts } from './parser.js'
+import { createWriterOpts } from './writer.js'
+import { whatBump } from './whatBump.js'
+
+export default async function createPreset(config) {
+  return {
+    commits: {
+      ignore: config?.ignoreCommits,
+      merges: false
+    },
+    parser: createParserOpts(),
+    writer: await createWriterOpts(),
+    whatBump
+  }
+}

package/{parserOpts.js → src/parser.js}

@@ -1,6 +1,4 @@
-'use strict'
-
-function createParserOpts () {
+export function createParserOpts() {
   return {
     headerPattern: /^(\w*)(?:\((.*)\))?: (.*)$/,
     headerCorrespondence: [
@@ -9,9 +7,7 @@ function createParserOpts () {
       'subject'
     ],
     noteKeywords: ['BREAKING CHANGE'],
-    revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w*)\./i,
+    revertPattern: /^(?:Revert|revert:)\s"?([\s\S]+?)"?\s*This reverts commit (\w{7,40})\b/i,
     revertCorrespondence: ['header', 'hash']
   }
 }
-
-module.exports.createParserOpts = createParserOpts

package/src/whatBump.js

@@ -0,0 +1,25 @@
+export function whatBump(commits) {
+  let level = 2
+  let breakings = 0
+  let features = 0
+
+  commits.forEach((commit) => {
+    if (commit.notes.length > 0) {
+      breakings += commit.notes.length
+      level = 0
+    } else if (commit.type === 'feat') {
+      features += 1
+
+      if (level === 2) {
+        level = 1
+      }
+    }
+  })
+
+  return {
+    level,
+    reason: breakings === 1
+      ? `There is ${breakings} BREAKING CHANGE and ${features} features`
+      : `There are ${breakings} BREAKING CHANGES and ${features} features`
+  }
+}

package/src/writer.js

@@ -0,0 +1,120 @@
+import { readFile } from 'fs/promises'
+import { resolve } from 'path'
+import { fileURLToPath } from 'url'
+import compareFunc from 'compare-func'
+
+const dirname = fileURLToPath(new URL('.', import.meta.url))
+const COMMIT_HASH_LENGTH = 7
+
+export async function createWriterOpts() {
+  const [
+    template,
+    header,
+    commit,
+    footer
+  ] = await Promise.all([
+    readFile(resolve(dirname, './templates/template.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/header.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/commit.hbs'), 'utf-8'),
+    readFile(resolve(dirname, './templates/footer.hbs'), 'utf-8')
+  ])
+  const writerOpts = getWriterOpts()
+
+  writerOpts.mainTemplate = template
+  writerOpts.headerPartial = header
+  writerOpts.commitPartial = commit
+  writerOpts.footerPartial = footer
+
+  return writerOpts
+}
+
+function getWriterOpts() {
+  return {
+    transform: (commit, context) => {
+      let discard = true
+      const notes = commit.notes.map((note) => {
+        discard = false
+
+        return {
+          ...note,
+          title: 'BREAKING CHANGES'
+        }
+      })
+      let { type } = commit
+
+      if (commit.type === 'feat') {
+        type = 'Features'
+      } else if (commit.type === 'fix') {
+        type = 'Bug Fixes'
+      } else if (commit.type === 'perf') {
+        type = 'Performance Improvements'
+      } else if (commit.type === 'revert' || commit.revert) {
+        type = 'Reverts'
+      } else if (discard) {
+        return undefined
+      } else if (commit.type === 'docs') {
+        type = 'Documentation'
+      } else if (commit.type === 'style') {
+        type = 'Styles'
+      } else if (commit.type === 'refactor') {
+        type = 'Code Refactoring'
+      } else if (commit.type === 'test') {
+        type = 'Tests'
+      } else if (commit.type === 'build') {
+        type = 'Build System'
+      } else if (commit.type === 'ci') {
+        type = 'Continuous Integration'
+      }
+
+      const scope = commit.scope === '*' ? '' : commit.scope
+      const shortHash = typeof commit.hash === 'string'
+        ? commit.hash.substring(0, COMMIT_HASH_LENGTH)
+        : commit.shortHash
+      const issues = []
+      let { subject } = commit
+
+      if (typeof subject === 'string') {
+        let url = context.repository
+          ? `${context.host}/${context.owner}/${context.repository}`
+          : context.repoUrl
+
+        if (url) {
+          url = `${url}/issues/`
+          // Issue URLs.
+          subject = subject.replace(/#([0-9]+)/g, (_, issue) => {
+            issues.push(issue)
+            return `[#${issue}](${url}${issue})`
+          })
+        }
+
+        if (context.host) {
+          // User URLs.
+          subject = subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
+            if (username.includes('/')) {
+              return `@${username}`
+            }
+
+            return `[@${username}](${context.host}/${username})`
+          })
+        }
+      }
+
+      // remove references that already appear in the subject
+      const references = commit.references.filter(reference => !issues.includes(reference.issue))
+
+      return {
+        notes,
+        type,
+        scope,
+        shortHash,
+        subject,
+        references
+      }
+    },
+    groupBy: 'type',
+    commitGroupsSort: 'title',
+    commitsSort: ['scope', 'subject'],
+    noteGroupsSort: 'title',
+    notesSort: compareFunc
+  }
+}

package/conventionalChangelog.js

@@ -1,10 +0,0 @@
-'use strict'
-
-function createConventionalChangelogOpts (parserOpts, writerOpts) {
-  return {
-    parserOpts,
-    writerOpts
-  }
-}
-
-module.exports.createConventionalChangelogOpts = createConventionalChangelogOpts

package/conventionalRecommendedBump.js

@@ -1,34 +0,0 @@
-'use strict'
-
-function createConventionalRecommendedBumpOpts (parserOpts) {
-  return {
-    parserOpts,
-
-    whatBump (commits) {
-      let level = 2
-      let breakings = 0
-      let features = 0
-
-      commits.forEach(commit => {
-        if (commit.notes.length > 0) {
-          breakings += commit.notes.length
-          level = 0
-        } else if (commit.type === 'feat') {
-          features += 1
-          if (level === 2) {
-            level = 1
-          }
-        }
-      })
-
-      return {
-        level,
-        reason: breakings === 1
-          ? `There is ${breakings} BREAKING CHANGE and ${features} features`
-          : `There are ${breakings} BREAKING CHANGES and ${features} features`
-      }
-    }
-  }
-}
-
-module.exports.createConventionalRecommendedBumpOpts = createConventionalRecommendedBumpOpts

package/index.js

@@ -1,22 +0,0 @@
-'use strict'
-
-const { createParserOpts } = require('./parserOpts')
-const { createWriterOpts } = require('./writerOpts')
-const { createConventionalChangelogOpts } = require('./conventionalChangelog')
-const { createConventionalRecommendedBumpOpts } = require('./conventionalRecommendedBump')
-
-async function createPreset () {
-  const parserOpts = createParserOpts()
-  const writerOpts = await createWriterOpts()
-  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(parserOpts)
-  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
-
-  return {
-    parserOpts,
-    writerOpts,
-    recommendedBumpOpts,
-    conventionalChangelog
-  }
-}
-
-module.exports = createPreset

package/writerOpts.js

@@ -1,110 +0,0 @@
-'use strict'
-
-const compareFunc = require('compare-func')
-const { readFile } = require('fs').promises
-const { resolve } = require('path')
-
-async function createWriterOpts () {
-  const [template, header, commit, footer] = await Promise.all([
-    readFile(resolve(__dirname, './templates/template.hbs'), 'utf-8'),
-    readFile(resolve(__dirname, './templates/header.hbs'), 'utf-8'),
-    readFile(resolve(__dirname, './templates/commit.hbs'), 'utf-8'),
-    readFile(resolve(__dirname, './templates/footer.hbs'), 'utf-8')
-  ])
-  const writerOpts = getWriterOpts()
-
-  writerOpts.mainTemplate = template
-  writerOpts.headerPartial = header
-  writerOpts.commitPartial = commit
-  writerOpts.footerPartial = footer
-
-  return writerOpts
-}
-
-module.exports.createWriterOpts = createWriterOpts
-
-function getWriterOpts () {
-  return {
-    transform: (commit, context) => {
-      let discard = true
-      const issues = []
-
-      commit.notes.forEach(note => {
-        note.title = 'BREAKING CHANGES'
-        discard = false
-      })
-
-      if (commit.type === 'feat') {
-        commit.type = 'Features'
-      } else if (commit.type === 'fix') {
-        commit.type = 'Bug Fixes'
-      } else if (commit.type === 'perf') {
-        commit.type = 'Performance Improvements'
-      } else if (commit.type === 'revert' || commit.revert) {
-        commit.type = 'Reverts'
-      } else if (discard) {
-        return
-      } else if (commit.type === 'docs') {
-        commit.type = 'Documentation'
-      } else if (commit.type === 'style') {
-        commit.type = 'Styles'
-      } else if (commit.type === 'refactor') {
-        commit.type = 'Code Refactoring'
-      } else if (commit.type === 'test') {
-        commit.type = 'Tests'
-      } else if (commit.type === 'build') {
-        commit.type = 'Build System'
-      } else if (commit.type === 'ci') {
-        commit.type = 'Continuous Integration'
-      }
-
-      if (commit.scope === '*') {
-        commit.scope = ''
-      }
-
-      if (typeof commit.hash === 'string') {
-        commit.shortHash = commit.hash.substring(0, 7)
-      }
-
-      if (typeof commit.subject === 'string') {
-        let url = context.repository
-          ? `${context.host}/${context.owner}/${context.repository}`
-          : context.repoUrl
-        if (url) {
-          url = `${url}/issues/`
-          // Issue URLs.
-          commit.subject = commit.subject.replace(/#([0-9]+)/g, (_, issue) => {
-            issues.push(issue)
-            return `[#${issue}](${url}${issue})`
-          })
-        }
-        if (context.host) {
-          // User URLs.
-          commit.subject = commit.subject.replace(/\B@([a-z0-9](?:-?[a-z0-9/]){0,38})/g, (_, username) => {
-            if (username.includes('/')) {
-              return `@${username}`
-            }
-
-            return `[@${username}](${context.host}/${username})`
-          })
-        }
-      }
-
-      // remove references that already appear in the subject
-      commit.references = commit.references.filter(reference => {
-        if (issues.indexOf(reference.issue) === -1) {
-          return true
-        }
-
-        return false
-      })
-
-      return commit
-    },
-    groupBy: 'type',
-    commitGroupsSort: 'title',
-    commitsSort: ['scope', 'subject'],
-    noteGroupsSort: 'title',
-    notesSort: compareFunc
-  }
-}