Merge pull request #4 from fingerprintjs/feat/heading-option

This update supports an optional `heading` field in the plugin configuration.

Author: erayaydin

src/@types/pluginConfig.ts

@@ -12,4 +12,5 @@ export default interface PluginConfig {
   iOS?: IOSPlatformConfiguration
   /** @deprecated Use `platforms.android` instead */
   android?: AndroidPlatformConfiguration
+  heading?: string
 }

src/generateNotes.ts

@@ -37,13 +37,21 @@ const generateNotes = async (config: PluginConfig, ctx: GenerateNotesContext) =>
     ctx.logger.log(`Detected iOS Version: \`${iOSVersion}\``)
   }
 
-  return Object.keys(platformVersions)
+  let notes = ''
+
+  if (config.heading) {
+    notes += `### ${config.heading}\n\n`
+  }
+
+  notes += Object.keys(platformVersions)
     .map((platformKey) => {
       const platform = platformKey as keyof PlatformConfig
       const version = platformVersions[platform]
       return `${platforms[platform]?.displayName ?? platform} Version Range: **\`${version}\`**`
     })
     .join('\n\n')
+
+  return notes
 }
 
 export default generateNotes

test/index.test.ts

@@ -108,5 +108,42 @@ describe('index', () => {
     it('throws error when no platform specified', async () => {
       await expect(generateNotes({}, generateNotesContext)).rejects.toThrowErrorMatchingSnapshot('noPlatform')
     })
+    describe('heading', () => {
+      const heading = 'Example Heading'
+      const { iOS, android } = pluginConfig.platforms
+
+      const expectedHeading = `### ${heading}`
+      const expectedAndroid = `${android.displayName} Version Range: **\`>= 1.2.3 and < 4.5.6\`**`
+      const expectedIOS = `${iOS.displayName} Version Range: **\`>= 1.2.3 and < 4.5.6\`**`
+
+      const subTestCases = [
+        {
+          platforms: { iOS, android },
+          expected: [expectedHeading, expectedAndroid, expectedIOS].join('\n\n'),
+        },
+        {
+          platforms: { iOS },
+          expected: [expectedHeading, expectedIOS].join('\n\n'),
+        },
+        {
+          platforms: { android },
+          expected: [expectedHeading, expectedAndroid].join('\n\n'),
+        },
+      ]
+
+      subTestCases.forEach((testCase) => {
+        it(`adds heading when specified for platforms: ${Object.keys(testCase.platforms).join(', ')}`, async () => {
+          await expect(
+            generateNotes(
+              {
+                platforms: testCase.platforms,
+                heading,
+              },
+              generateNotesContext
+            )
+          ).resolves.toBe(testCase.expected)
+        }, 30000)
+      })
+    })
   })
 })