feat(style): use <sup> for author info

antfu · Jul 2, 2022 · b51c075 · b51c075
1 parent b105f30
commit b51c075
Show file tree

Hide file tree

Showing 3 changed files with 12 additions and 1 deletion.
diff --git a/src/cli.ts b/src/cli.ts
@@ -19,6 +19,7 @@ cli
   .option('--capitalize', 'Should capitalize for each comment message')
   .option('--emoji', 'Use emojis in section titles', { default: true })
   .option('--group', 'Nest commit messages under their scopes')
+  .option('--sup', 'Use <sup> for author info', { default: true })
   .option('--dry', 'Dry run')
   .help()
 

diff --git a/src/markdown.ts b/src/markdown.ts
@@ -37,9 +37,14 @@ function formatLine(commit: Commit, options: ResolvedChangelogOptions) {
   if (authors)
     authors = `by ${authors}`
 
+  let refs = [authors, prRefs, hashRefs].filter(i => i?.trim()).join(' ')
+
+  if (options.sup && refs)
+    refs = `<sup>${refs}</sup>`
+
   const description = options.capitalize ? capitalize(commit.description) : commit.description
 
-  return [description, authors, prRefs, hashRefs].filter(i => i?.trim()).join(' ')
+  return [description, refs].filter(i => i?.trim()).join(' ')
 }
 
 function formatTitle(name: string, options: ResolvedChangelogOptions) {

diff --git a/src/types.ts b/src/types.ts
@@ -70,6 +70,11 @@ export interface ChangelogOptions extends Partial<ChangelogenOptions> {
    * @default true
    */
   emoji?: boolean
+  /**
+   * Use <sup> for author info
+   * @default true
+   */
+  sup?: boolean
 }
 
 export type ResolvedChangelogOptions = Required<ChangelogOptions>