refactor: make formatter a sync function

MetaMask · Sep 22, 2023 · 976f9ce · 976f9ce
1 parent b6f95b2
commit 976f9ce
Show file tree

Hide file tree

Showing 4 changed files with 11 additions and 8 deletions.
diff --git a/src/changelog.ts b/src/changelog.ts
@@ -13,7 +13,10 @@ const changelogDescription = `All notable changes to this project will be docume
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).`;
 
-export type Formatter = (changelog: string) => Promise<string>;
+/**
+ * Formatter function that formats a Markdown changelog string.
+ */
+export type Formatter = (changelog: string) => string;
 
 type ReleaseMetadata = {
   /**
@@ -272,7 +275,7 @@ export default class Changelog {
   constructor({
     repoUrl,
     tagPrefix = 'v',
-    formatter = async (changelog) => changelog,
+    formatter = (changelog) => changelog,
   }: {
     repoUrl: string;
     tagPrefix?: string;
@@ -454,7 +457,7 @@ export default class Changelog {
    *
    * @returns The stringified changelog.
    */
-  async toString(): Promise<string> {
+  toString(): string {
     const changelog = `${changelogTitle}
 ${changelogDescription}
 

diff --git a/src/cli.ts b/src/cli.ts
@@ -168,7 +168,7 @@ async function validate({
   const changelogContent = await readChangelog(changelogPath);
 
   try {
-    await validateChangelog({
+    validateChangelog({
       changelogContent,
       currentVersion,
       repoUrl,
@@ -430,7 +430,7 @@ async function main() {
     }
   }
 
-  const formatter = async (changelog: string) => {
+  const formatter = (changelog: string) => {
     return usePrettier
       ? prettier.format(changelog, { parser: 'markdown' })
       : changelog;

diff --git a/src/init.ts b/src/init.ts
@@ -8,7 +8,7 @@ import Changelog from './changelog';
  * @param options.tagPrefix - The prefix used in tags before the version number.
  * @returns The initial changelog text.
  */
-export async function createEmptyChangelog({
+export function createEmptyChangelog({
   repoUrl,
   tagPrefix = 'v',
 }: {

diff --git a/src/validate-changelog.ts b/src/validate-changelog.ts
@@ -100,7 +100,7 @@ type ValidateChangelogOptions = {
  * `true` and the changelog contains uncategorized changes.
  * @throws `ChangelogFormattingError` - Will throw if there is a formatting error.
  */
-export async function validateChangelog({
+export function validateChangelog({
   changelogContent,
   currentVersion,
   repoUrl,
@@ -141,7 +141,7 @@ export async function validateChangelog({
     }
   }
 
-  const validChangelog = await changelog.toString();
+  const validChangelog = changelog.toString();
   if (validChangelog !== changelogContent) {
     throw new ChangelogFormattingError({
       validChangelog,