feat: Add option to use Oxfmt for formatting changelog

package.json

@@ -27,7 +27,7 @@
   },
   "dependencies": {
     "@metamask/action-utils": "^1.0.0",
-    "@metamask/auto-changelog": "^4.0.0",
+    "@metamask/auto-changelog": "^6.1.0",
     "@metamask/utils": "^9.0.0",
     "debug": "^4.3.4",
     "execa": "^8.0.1",
@@ -93,8 +93,17 @@
     "vite": "^6.2.0"
   },
   "peerDependencies": {
+    "oxfmt": "^0.45.0",
     "prettier": ">=3.0.0"
   },
+  "peerDependenciesMeta": {
+    "oxfmt": {
+      "optional": true
+    },
+    "prettier": {
+      "optional": true
+    }
+  },
   "packageManager": "yarn@3.2.1",
   "engines": {
     "node": "^18.18 || >=20"

src/command-line-arguments.ts

@@ -9,6 +9,7 @@ export type CommandLineArguments = {
   defaultBranch: string;
   interactive: boolean;
   port: number;
+  formatter: string;
 };
 
 /**
@@ -66,6 +67,11 @@ export async function readCommandLineArguments(
       type: 'number',
       default: 3000,
     })
+    .option('formatter', {
+      describe: 'The formatter to use for changelog formatting.',
+      choices: ['oxfmt', 'prettier'],
+      default: 'prettier',
+    })
     .help()
     .strict()
     .parse();

src/initial-parameters.test.ts

@@ -38,6 +38,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -60,6 +61,7 @@ describe('initial-parameters', () => {
         defaultBranch: 'main',
         interactive: false,
         port: 3000,
+        formatter: 'prettier',
       });
     });
 
@@ -78,6 +80,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -110,6 +113,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -142,6 +146,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -174,6 +179,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -204,6 +210,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -234,6 +241,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')
@@ -264,6 +272,7 @@ describe('initial-parameters', () => {
           defaultBranch: 'main',
           interactive: false,
           port: 3000,
+          formatter: 'prettier',
         });
       jest
         .spyOn(envModule, 'getEnvironmentVariables')

src/initial-parameters.ts

@@ -15,6 +15,11 @@ import { readProject, Project } from './project.js';
  */
 export type ReleaseType = 'ordinary' | 'backport';
 
+/**
+ * The name of the formatter to use for formatting the changelog.
+ */
+export type Formatter = 'oxfmt' | 'prettier';
+
 type InitialParameters = {
   project: Project;
   tempDirectoryPath: string;
@@ -23,6 +28,7 @@ type InitialParameters = {
   defaultBranch: string;
   interactive: boolean;
   port: number;
+  formatter: Formatter;
 };
 
 /**
@@ -65,5 +71,6 @@ export async function determineInitialParameters({
     releaseType: args.backport ? 'backport' : 'ordinary',
     interactive: args.interactive,
     port: args.port,
+    formatter: args.formatter as Formatter,
   };
 }

src/main.test.ts

@@ -32,6 +32,7 @@ describe('main', () => {
         releaseType: 'backport',
         interactive: false,
         port: 3000,
+        formatter: 'prettier',
       });
     const followMonorepoWorkflowSpy = jest
       .spyOn(monorepoWorkflowOperations, 'followMonorepoWorkflow')
@@ -50,6 +51,7 @@ describe('main', () => {
       firstRemovingExistingReleaseSpecification: true,
       releaseType: 'backport',
       defaultBranch: 'main',
+      formatter: 'prettier',
       stdout,
       stderr,
     });
@@ -69,6 +71,7 @@ describe('main', () => {
         releaseType: 'backport',
         interactive: true,
         port: 3000,
+        formatter: 'prettier',
       });
     const startUISpy = jest.spyOn(ui, 'startUI').mockResolvedValue();
 
@@ -84,6 +87,7 @@ describe('main', () => {
       releaseType: 'backport',
       defaultBranch: 'main',
       port: 3000,
+      formatter: 'prettier',
       stdout,
       stderr,
     });
@@ -103,6 +107,7 @@ describe('main', () => {
         releaseType: 'backport',
         interactive: false,
         port: 3000,
+        formatter: 'prettier',
       });
     const followMonorepoWorkflowSpy = jest
       .spyOn(monorepoWorkflowOperations, 'followMonorepoWorkflow')

src/main.ts

@@ -34,6 +34,7 @@ export async function main({
     defaultBranch,
     interactive,
     port,
+    formatter,
   } = await determineInitialParameters({ argv, cwd, stderr });
 
   if (project.isMonorepo) {
@@ -47,6 +48,7 @@ export async function main({
         releaseType,
         defaultBranch,
         port,
+        formatter,
         stdout,
         stderr,
       });
@@ -57,6 +59,7 @@ export async function main({
         firstRemovingExistingReleaseSpecification: reset,
         releaseType,
         defaultBranch,
+        formatter,
         stdout,
         stderr,
       });