BREAKING: Bump @metamask/auto-changelog to ^4.0.0, and bump related dependencies (#156)

Author: Mrtenz

.github/workflows/build-test.yml

@@ -14,7 +14,7 @@ jobs:
       YARN_VERSION: ${{ steps.yarn-version.outputs.YARN_VERSION }}
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -41,7 +41,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -69,7 +69,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}
@@ -103,7 +103,7 @@ jobs:
       - prepare
     strategy:
       matrix:
-        node-version: [16.x, 18.x, 20.x]
+        node-version: [18.x, 20.x]
     steps:
       - uses: actions/checkout@v3
       - name: Use Node.js ${{ matrix.node-version }}

package.json

@@ -26,7 +26,7 @@
   },
   "dependencies": {
     "@metamask/action-utils": "^1.0.0",
-    "@metamask/auto-changelog": "~3.3.0",
+    "@metamask/auto-changelog": "^4.0.0",
     "@metamask/utils": "^9.0.0",
     "debug": "^4.3.4",
     "execa": "^8.0.1",
@@ -59,29 +59,29 @@
     "babel-jest": "^29.7.0",
     "deepmerge": "^4.2.2",
     "eslint": "^8.27.0",
-    "eslint-config-prettier": "^8.5.0",
+    "eslint-config-prettier": "^9.1.0",
     "eslint-plugin-import": "^2.26.0",
     "eslint-plugin-jest": "^26.9.0",
     "eslint-plugin-jsdoc": "^39.6.2",
     "eslint-plugin-node": "^11.1.0",
-    "eslint-plugin-prettier": "^4.2.1",
+    "eslint-plugin-prettier": "^5.2.1",
     "jest": "^29.7.0",
     "jest-it-up": "^3.0.0",
     "jest-when": "^3.5.2",
     "nanoid": "^3.3.4",
-    "prettier": "^2.2.1",
-    "prettier-plugin-packagejson": "^2.3.0",
+    "prettier": "^3.3.3",
+    "prettier-plugin-packagejson": "^2.5.2",
     "rimraf": "^4.0.5",
     "stdio-mock": "^1.2.0",
     "tsx": "^4.6.1",
     "typescript": "~5.1.6"
   },
   "peerDependencies": {
-    "prettier": "^2"
+    "prettier": ">=3.0.0"
   },
   "packageManager": "[email protected]",
   "engines": {
-    "node": "^16.20 || ^18.16 || >=20"
+    "node": "^18.18 || >=20"
   },
   "publishConfig": {
     "access": "public",

src/package.test.ts

@@ -4,7 +4,7 @@ import { when } from 'jest-when';
 import * as autoChangelog from '@metamask/auto-changelog';
 import { SemVer } from 'semver';
 import { MockWritable } from 'stdio-mock';
-import { buildChangelog, withSandbox } from '../tests/helpers';
+import { buildChangelog, withSandbox } from '../tests/helpers.js';
 import {
   buildMockPackage,
   buildMockProject,
@@ -682,7 +682,7 @@ describe('package', () => {
   });
 
   describe('formatChangelog', () => {
-    it('formats a changelog', () => {
+    it('formats a changelog', async () => {
       const unformattedChangelog = `#  Changelog
 ##     1.0.0
 
@@ -692,7 +692,8 @@ describe('package', () => {
 - Some other change
 `;
 
-      expect(formatChangelog(unformattedChangelog)).toMatchInlineSnapshot(`
+      expect(await formatChangelog(unformattedChangelog))
+        .toMatchInlineSnapshot(`
         "# Changelog
 
         ## 1.0.0

src/package.ts

@@ -2,7 +2,8 @@ import fs, { WriteStream } from 'fs';
 import path from 'path';
 import { format } from 'util';
 import { parseChangelog, updateChangelog } from '@metamask/auto-changelog';
-import prettier from 'prettier';
+import { format as formatPrettier } from 'prettier/standalone';
+import * as markdown from 'prettier/plugins/markdown';
 import { WriteStreamLike, readFile, writeFile, writeJsonFile } from './fs.js';
 import { isErrorWithCode } from './misc-utils.js';
 import {
@@ -278,7 +279,7 @@ export async function migrateUnreleasedChangelogChangesToRelease({
 
   changelog.addRelease({ version });
   changelog.migrateUnreleasedChangesToRelease(version);
-  await writeFile(pkg.changelogPath, changelog.toString());
+  await writeFile(pkg.changelogPath, await changelog.toString());
 }
 
 /**
@@ -288,8 +289,11 @@ export async function migrateUnreleasedChangelogChangesToRelease({
  * @param changelog - The changelog to format.
  * @returns The formatted changelog.
  */
-export function formatChangelog(changelog: string) {
-  return prettier.format(changelog, { parser: 'markdown' });
+export async function formatChangelog(changelog: string) {
+  return await formatPrettier(changelog, {
+    parser: 'markdown',
+    plugins: [markdown],
+  });
 }
 
 /**

src/project.ts

@@ -113,9 +113,12 @@ export async function readProject(
         });
       }),
     )
-  ).reduce((obj, pkg) => {
-    return { ...obj, [pkg.validatedManifest.name]: pkg };
-  }, {} as Record<string, Package>);
+  ).reduce(
+    (obj, pkg) => {
+      return { ...obj, [pkg.validatedManifest.name]: pkg };
+    },
+    {} as Record<string, Package>,
+  );
 
   const isMonorepo = Object.keys(workspacePackages).length > 0;