diff --git a/README.md b/README.md index 403f5a90..8a704fb8 100644 --- a/README.md +++ b/README.md @@ -61,7 +61,7 @@ With this example: | Option | Description | Default | | -------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------- | -| `preset` | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: [`angular`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular), [`atom`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-atom), [`codemirror`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-codemirror), [`ember`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-ember), [`eslint`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint), [`express`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-express), [`jquery`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-jquery), [`jshint`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-jshint), [`conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)). | [`angular`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular) | +| `preset` | [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset (possible values: [`angular`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-angular), [`atom`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-atom), [`codemirror`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-codemirror), [`ember`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-ember), [`eslint`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-eslint), [`express`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-express), [`jquery`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-jquery), [`jshint`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-jshint), [`conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits)). | [`conventionalcommits`](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-changelog-conventionalcommits) | | `config` | npm package name of a custom [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset. | - | | `parserOpts` | Additional [conventional-commits-parser](https://github.com/conventional-changelog/conventional-changelog/tree/master/packages/conventional-commits-parser#conventionalcommitsparseroptions) options that will extends the ones loaded by `preset` or `config`. This is convenient to use a [conventional-changelog](https://github.com/conventional-changelog/conventional-changelog) preset with some customizations without having to create a new module. | - | | `releaseRules` | An external module, a path to a module or an `Array` of rules. See [`releaseRules`](#releaserules). | See [`releaseRules`](#releaserules) | diff --git a/lib/load-parser-config.js b/lib/load-parser-config.js index a6863e71..600d5925 100644 --- a/lib/load-parser-config.js +++ b/lib/load-parser-config.js @@ -1,13 +1,13 @@ import { dirname } from "node:path"; import { fileURLToPath } from "node:url"; import importFrom from "import-from-esm"; -import conventionalChangelogAngular from "conventional-changelog-angular"; +import conventionalChangelogConventionalcommits from "conventional-changelog-conventionalcommits"; /** * Load `conventional-changelog-parser` options. Handle presets that return either a `Promise` or a `Promise`. * * @param {Object} pluginConfig The plugin configuration. - * @param {Object} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint') + * @param {Object} pluginConfig.preset conventional-changelog preset ('angular', 'atom', 'codemirror', 'ember', 'eslint', 'express', 'jquery', 'jscs', 'jshint', 'conventionalcommits') * @param {String} pluginConfig.config Requireable npm package with a custom conventional-changelog preset * @param {Object} pluginConfig.parserOpts Additional `conventional-changelog-parser` options that will overwrite ones loaded by `preset` or `config`. * @param {Object} context The semantic-release context. @@ -27,7 +27,7 @@ export default async ({ preset, config, parserOpts, presetConfig }, { cwd }) => } else if (config) { loadedConfig = await ((await importFrom.silent(__dirname, config)) || (await importFrom(cwd, config)))(); } else { - loadedConfig = await conventionalChangelogAngular(); + loadedConfig = await conventionalChangelogConventionalcommits(); } return { ...loadedConfig.parser, ...parserOpts }; diff --git a/package-lock.json b/package-lock.json index 0c2d8fbd..a444b6ec 100644 --- a/package-lock.json +++ b/package-lock.json @@ -9,7 +9,7 @@ "version": "0.0.0-development", "license": "MIT", "dependencies": { - "conventional-changelog-angular": "^8.0.0", + "conventional-changelog-conventionalcommits": "^9.0.0", "conventional-changelog-writer": "^8.0.0", "conventional-commits-filter": "^5.0.0", "conventional-commits-parser": "^6.0.0", @@ -21,8 +21,8 @@ "devDependencies": { "ava": "6.4.1", "c8": "10.1.3", + "conventional-changelog-angular": "8.0.0", "conventional-changelog-atom": "5.0.0", - "conventional-changelog-conventionalcommits": "9.1.0", "conventional-changelog-ember": "5.0.0", "conventional-changelog-eslint": "6.0.0", "conventional-changelog-express": "5.0.0", @@ -2647,6 +2647,7 @@ "version": "8.0.0", "resolved": "https://registry.npmjs.org/conventional-changelog-angular/-/conventional-changelog-angular-8.0.0.tgz", "integrity": "sha512-CLf+zr6St0wIxos4bmaKHRXWAcsCXrJU6F4VdNDrGRK3B8LDLKoX3zuMV5GhtbGkVR/LohZ6MT6im43vZLSjmA==", + "dev": true, "license": "ISC", "dependencies": { "compare-func": "^2.0.0" @@ -2669,7 +2670,6 @@ "version": "9.1.0", "resolved": "https://registry.npmjs.org/conventional-changelog-conventionalcommits/-/conventional-changelog-conventionalcommits-9.1.0.tgz", "integrity": "sha512-MnbEysR8wWa8dAEvbj5xcBgJKQlX/m0lhS8DsyAAWDHdfs2faDJxTgzRYlRYpXSe7UiKrIIlB4TrBKU9q9DgkA==", - "dev": true, "license": "ISC", "dependencies": { "compare-func": "^2.0.0" diff --git a/package.json b/package.json index cccb7219..81bcf4ab 100644 --- a/package.json +++ b/package.json @@ -19,7 +19,7 @@ "Matt Travi (https://matt.travi.org/)" ], "dependencies": { - "conventional-changelog-angular": "^8.0.0", + "conventional-changelog-conventionalcommits": "^9.0.0", "conventional-changelog-writer": "^8.0.0", "conventional-commits-filter": "^5.0.0", "conventional-commits-parser": "^6.0.0", @@ -32,7 +32,7 @@ "ava": "6.4.1", "c8": "10.1.3", "conventional-changelog-atom": "5.0.0", - "conventional-changelog-conventionalcommits": "9.1.0", + "conventional-changelog-angular": "8.0.0", "conventional-changelog-ember": "5.0.0", "conventional-changelog-eslint": "6.0.0", "conventional-changelog-express": "5.0.0", diff --git a/test/integration.test.js b/test/integration.test.js index 112bc3a5..e58afcd4 100644 --- a/test/integration.test.js +++ b/test/integration.test.js @@ -10,7 +10,7 @@ test.beforeEach((t) => { t.context.logger = { log }; }); -test('Parse with "conventional-changelog-angular" by default', async (t) => { +test('Parse with "conventional-changelog-conventionalcommits" by default', async (t) => { const commits = [ { hash: "123", message: "fix(scope1): First fix" }, { hash: "456", message: "feat(scope2): Second feature" }, diff --git a/test/load-parser-config.test.js b/test/load-parser-config.test.js index 773e395f..bc401490 100644 --- a/test/load-parser-config.test.js +++ b/test/load-parser-config.test.js @@ -35,10 +35,10 @@ async function loadConfig(t, config, pluginOptions) { loadConfig.title = (providedTitle, config) => `${providedTitle} Load "${config}" config`.trim(); -test('Load "conventional-changelog-angular" by default', async (t) => { +test('Load "conventional-changelog-conventionalcommits" by default', async (t) => { t.deepEqual( await loadParserConfig({}, { cwd }), - (await (await import("conventional-changelog-angular")).default()).parser + (await (await import("conventional-changelog-conventionalcommits")).default()).parser ); });