feat!: cleanup presets interface (#1215)

BREAKING CHANGES: now preset object provides `commits`, `parser`, `writer` and `whatBump` properties.

packages/conventional-changelog-angular/index.js

@@ -1,18 +1,11 @@
-import { createParserOpts } from './parserOpts.js'
-import { createWriterOpts } from './writerOpts.js'
-import { createConventionalChangelogOpts } from './conventionalChangelog.js'
-import { createConventionalRecommendedBumpOpts } from './conventionalRecommendedBump.js'
+import { createParserOpts } from './parser.js'
+import { createWriterOpts } from './writer.js'
+import { whatBump } from './whatBump.js'
 
 export default async function createPreset () {
-  const parserOpts = createParserOpts()
-  const writerOpts = await createWriterOpts()
-  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(parserOpts)
-  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
-
   return {
-    parserOpts,
-    writerOpts,
-    recommendedBumpOpts,
-    conventionalChangelog
+    parser: createParserOpts(),
+    writer: await createWriterOpts(),
+    whatBump
   }
 }

packages/conventional-changelog-angular/package.json

@@ -14,11 +14,10 @@
     "preset"
   ],
   "files": [
-    "conventionalChangelog.js",
-    "conventionalRecommendedBump.js",
+    "whatBump.js",
     "index.js",
-    "parserOpts.js",
-    "writerOpts.js",
+    "parser.js",
+    "writer.js",
     "templates"
   ],
   "author": "Steve Mao",

packages/conventional-changelog-angular/whatBump.js

@@ -0,0 +1,24 @@
+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`
+  }
+}

packages/conventional-changelog-atom/index.js

@@ -1,18 +1,11 @@
-import { createParserOpts } from './parserOpts.js'
-import { createWriterOpts } from './writerOpts.js'
-import { createConventionalChangelogOpts } from './conventionalChangelog.js'
-import { createConventionalRecommendedBumpOpts } from './conventionalRecommendedBump.js'
+import { createParserOpts } from './parser.js'
+import { createWriterOpts } from './writer.js'
+import { whatBump } from './whatBump.js'
 
 export default async function createPreset () {
-  const parserOpts = createParserOpts()
-  const writerOpts = await createWriterOpts()
-  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(parserOpts)
-  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
-
   return {
-    parserOpts,
-    writerOpts,
-    recommendedBumpOpts,
-    conventionalChangelog
+    parser: createParserOpts(),
+    writer: await createWriterOpts(),
+    whatBump
   }
 }

packages/conventional-changelog-atom/package.json

@@ -19,11 +19,10 @@
   },
   "license": "ISC",
   "files": [
-    "conventionalChangelog.js",
-    "conventionalRecommendedBump.js",
+    "whatBump.js",
     "index.js",
-    "parserOpts.js",
-    "writerOpts.js",
+    "parser.js",
+    "writer.js",
     "templates"
   ],
   "bugs": {

packages/conventional-changelog-atom/whatBump.js

@@ -0,0 +1,22 @@
+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: `There are ${breakings} BREAKING CHANGES and ${features} features`
+  }
+}

packages/conventional-changelog-cli/test/fixtures/promise-config.cjs

@@ -1,5 +1,5 @@
 module.exports = Promise.resolve({
-  writerOpts: {
+  writer: {
     mainTemplate: '{{commitGroups.[0].commits.[0].type}}{{testContext}}template'
   }
 })

packages/conventional-changelog-codemirror/index.js

@@ -1,18 +1,11 @@
-import { createParserOpts } from './parserOpts.js'
-import { createWriterOpts } from './writerOpts.js'
-import { createConventionalChangelogOpts } from './conventionalChangelog.js'
-import { createConventionalRecommendedBumpOpts } from './conventionalRecommendedBump.js'
+import { createParserOpts } from './parser.js'
+import { createWriterOpts } from './writer.js'
+import { whatBump } from './whatBump.js'
 
 export default async function createPreset () {
-  const parserOpts = createParserOpts()
-  const writerOpts = await createWriterOpts()
-  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(parserOpts)
-  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
-
   return {
-    parserOpts,
-    writerOpts,
-    recommendedBumpOpts,
-    conventionalChangelog
+    parser: createParserOpts(),
+    writer: await createWriterOpts(),
+    whatBump
   }
 }

packages/conventional-changelog-codemirror/package.json

@@ -19,11 +19,10 @@
   },
   "license": "ISC",
   "files": [
-    "conventionalChangelog.js",
-    "conventionalRecommendedBump.js",
+    "whatBump.js",
     "index.js",
-    "parserOpts.js",
-    "writerOpts.js",
+    "parser.js",
+    "writer.js",
     "templates"
   ],
   "bugs": {

packages/conventional-changelog-codemirror/whatBump.js

@@ -0,0 +1,22 @@
+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: `There are ${breakings} BREAKING CHANGES and ${features} features`
+  }
+}

packages/conventional-changelog-conventionalcommits/index.js

@@ -1,25 +1,18 @@
 import { DEFAULT_COMMIT_TYPES } from './constants.js'
-import { createParserOpts } from './parserOpts.js'
-import { createWriterOpts } from './writerOpts.js'
-import { createConventionalChangelogOpts } from './conventionalChangelog.js'
-import { createConventionalRecommendedBumpOpts } from './conventionalRecommendedBump.js'
+import { createParserOpts } from './parser.js'
+import { createWriterOpts } from './writer.js'
+import { createWhatBump } from './whatBump.js'
 
 export { DEFAULT_COMMIT_TYPES }
 
 export default async function createPreset (config) {
-  const parserOpts = createParserOpts(config)
-  const writerOpts = await createWriterOpts(config)
-  const recommendedBumpOpts = createConventionalRecommendedBumpOpts(config, parserOpts)
-  const conventionalChangelog = createConventionalChangelogOpts(parserOpts, writerOpts)
-
   return {
-    gitRawCommitsOpts: {
+    commits: {
       ignore: config?.ignoreCommits,
       noMerges: null
     },
-    parserOpts,
-    writerOpts,
-    recommendedBumpOpts,
-    conventionalChangelog
+    parser: createParserOpts(config),
+    writer: await createWriterOpts(config),
+    whatBump: createWhatBump(config)
   }
 }