feat!: reformat changelog output (#27)

Resolves #19

## Changes

- reformat changelog output
  - the new output looks like: "#PR (USER): MESSAGE"
- remove explicit return statements on every typescript functions

Author: mheob

.changeset/cuddly-carrots-train.md

@@ -0,0 +1,5 @@
+---
+'@mheob/changeset-changelog': major
+---
+
+reformat the changelog output to displzy first the PR and user

.commitlintrc.cjs

@@ -5,5 +5,6 @@ module.exports = {
 	...defaultConfig,
 	prompt: {
 		...defaultConfig.prompt,
+		allowEmptyScopes: true,
 	},
 };

README.md

@@ -1,8 +1,13 @@
 # `@mheob/changeset-changelog`
 
-[![Release](https://github.com/mheob/changeset-changelog/actions/workflows/release.yml/badge.svg)](https://github.com/mheob/changeset-changelog/actions/workflows/release.yml) [![Check](https://github.com/mheob/changeset-changelog/actions/workflows/check.yml/badge.svg)](https://github.com/mheob/changeset-changelog/actions/workflows/check.yml) [![codecov](https://codecov.io/gh/mheob/changeset-changelog/branch/main/graph/badge.svg?token=E7RZLWHMEX)](https://codecov.io/gh/mheob/changeset-changelog)
+[![Release](https://github.com/mheob/changeset-changelog/actions/workflows/release.yml/badge.svg)](https://github.com/mheob/changeset-changelog/actions/workflows/release.yml)
+[![Check](https://github.com/mheob/changeset-changelog/actions/workflows/check.yml/badge.svg)](https://github.com/mheob/changeset-changelog/actions/workflows/check.yml)
+[![codecov](https://codecov.io/gh/mheob/changeset-changelog/branch/main/graph/badge.svg?token=E7RZLWHMEX)](https://codecov.io/gh/mheob/changeset-changelog)
 
-Add my own style for the changelogs generated by the awesome [changesets](https://github.com/changesets/changesets) library. The style was inspired by the original [@changesets/changelog-github](https://github.com/changesets/changesets/tree/main/packages/changelog-github) and the [@svitejs/changesets-changelog-github-compact](https://github.com/svitejs/changesets-changelog-github-compact) packages.
+Add my own style for the changelogs generated by the awesome [changesets](https://github.com/changesets/changesets) library. The
+style was inspired by the original
+[@changesets/changelog-github](https://github.com/changesets/changesets/tree/main/packages/changelog-github) and the
+[@svitejs/changesets-changelog-github-compact](https://github.com/svitejs/changesets-changelog-github-compact) packages.
 
 ## Installation
 
@@ -54,8 +59,8 @@ There are differences between this changelog output and the others:
 
 <!-- markdownlint-enable MD024 -->
 
-- Add nice feature to the project with a PR and commit --> ([#PR](#)) by [@user](#)
-- Add nice feature to the project without a PR --> ([commit](#)) by [@user](#)
+- [PR](#) ([@user](#)): Add nice feature to the project with a PR and commit
+- [commit](#) ([@user](#)): Add nice feature to the project without a PR
 
 ## Additional feature: linking issues
 

src/getDependencyReleaseLine.ts

@@ -3,10 +3,7 @@ import type { GetDependencyReleaseLine, NewChangesetWithCommit } from '@changese
 
 import { errorMessage } from './utils';
 
-async function getDependencyReleaseLinks(
-	changesets: NewChangesetWithCommit[],
-	repository: string,
-): Promise<string> {
+async function getDependencyReleaseLinks(changesets: NewChangesetWithCommit[], repository: string) {
 	const changesetLinks = await Promise.all(
 		changesets.map(async (cs) => {
 			// istanbul ignore next: because of our mocked get-github-info -- @preserve

src/getReleaseLine.ts

@@ -44,7 +44,7 @@ async function getGitHubLinks(
 	commit?: string,
 	commitFromSummary?: string,
 	prFromSummary?: number,
-): Promise<GithubLinks> {
+) {
 	let githubLinks: GithubLinks = { commit: undefined, pull: undefined, user: undefined };
 
 	if (prFromSummary) {
@@ -82,7 +82,7 @@ async function getGitHubLinks(
 	return githubLinks;
 }
 
-function getUserLink(usersFromSummary: string[], user?: string): string | undefined {
+function getUserLink(usersFromSummary: string[], user?: string) {
 	const userLink =
 		usersFromSummary.length > 0
 			? usersFromSummary
@@ -91,12 +91,12 @@ function getUserLink(usersFromSummary: string[], user?: string): string | undefi
 					.trim()
 			: user;
 
-	return userLink ? `by ${userLink}` : undefined;
+	return userLink ? `(${userLink})` : '';
 }
 
 // add links to issue hints (fix #123) => (fix [#123](https://....))
 // thanks to https://github.com/svitejs/changesets-changelog-github-compact
-function linkifyIssue(line: string, repository: string): string {
+function linkifyIssue(line: string, repository: string) {
 	return line.replace(/(?<=\( ?(?:fix|fixes|resolves|see) )(#\d+)(?= ?\))/g, (issue) => {
 		return `[${issue}](https://github.com/${repository}/issues/${issue.slice(1)})`;
 	});
@@ -118,14 +118,13 @@ export const getReleaseLine: GetReleaseLine = async (changeset, _type, options)
 		.split('\n')
 		.map((line) => linkifyIssue(line.trimEnd(), options['repo']));
 
-	const prMessage = pull ? `(${pull})` : '';
-	const commitMessage = commit ? `(${commit})` : '';
-	const userLinkMessage = userLink ?? '';
+	const prMessage = pull ? `${pull}` : '';
+	const commitMessage = commit ? `${commit}` : '';
 	// istanbul ignore next: because of our mocked get-github-info -- @preserve
-	const printPrOrCommit = pull !== '' ? prMessage : commitMessage;
-	const suffix = printPrOrCommit.trim() ? ` --> ${printPrOrCommit.trim()} ${userLinkMessage}` : '';
+	const printPrOrCommit = (pull !== '' ? prMessage : commitMessage).trim();
+	const prefix = printPrOrCommit ? `${printPrOrCommit} ${userLink}: ` : '';
 
 	const futureLinesMessage = futureLines.map((line) => `  ${line}`).join('\n');
 
-	return `\n\n- ${firstLine}${suffix}\n${futureLinesMessage}`;
+	return `\n\n- ${prefix}${firstLine}\n${futureLinesMessage}`;
 };

src/index.test.ts

@@ -112,23 +112,23 @@ describe('getReplacedChangelog', () => {
 		);
 		const result = await getReleaseLine(changeset, 'minor', { repo: data.repo });
 		expect(result).toBe(
-			'\n\n- An awesome feature. --> ([#2](https://github.com/mheob/changeset-changelog/pull/2)) by [@mheob](https://github.com/mheob)\n',
+			'\n\n- [#2](https://github.com/mheob/changeset-changelog/pull/2) ([@mheob](https://github.com/mheob)): An awesome feature.\n',
 		);
 	});
 
 	it('should return the changelog in a string format with data from commit', async () => {
 		const changeset = getChangeset('An awesome feature.', data.commit);
 		const result = await getReleaseLine(changeset, 'minor', { repo: data.repo });
 		expect(result).toBe(
-			'\n\n- An awesome feature. --> ([#2](https://github.com/mheob/changeset-changelog/pull/2)) by [@mheob](https://github.com/mheob)\n',
+			'\n\n- [#2](https://github.com/mheob/changeset-changelog/pull/2) ([@mheob](https://github.com/mheob)): An awesome feature.\n',
 		);
 	});
 
 	it('should return the changelog in a string format with data from commit', async () => {
 		const changeset = getChangeset('An awesome feature, (resolves #9)', data.commit);
 		const result = await getReleaseLine(changeset, 'minor', { repo: data.repo });
 		expect(result).toBe(
-			'\n\n- An awesome feature, (resolves [#9](https://github.com/mheob/changeset-changelog/issues/9)) --> ([#2](https://github.com/mheob/changeset-changelog/pull/2)) by [@mheob](https://github.com/mheob)\n',
+			'\n\n- [#2](https://github.com/mheob/changeset-changelog/pull/2) ([@mheob](https://github.com/mheob)): An awesome feature, (resolves [#9](https://github.com/mheob/changeset-changelog/issues/9))\n',
 		);
 	});