feat: add wrapperTemplate option (#348)

all-contributors · Apr 26, 2023 · 2c07af8 · 2c07af8
1 parent 96534ec
commit 2c07af8
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 2 deletions.
diff --git a/src/generate/__tests__/__snapshots__/index.js.snap b/src/generate/__tests__/__snapshots__/index.js.snap
@@ -1,5 +1,31 @@
 // Jest Snapshot v1, https://goo.gl/fbAQLP
 
+exports[`replace the content between the ALL-CONTRIBUTORS-LIST tags by a custom wrapper around the list of contributors contained in the "bodyContent" tag 1`] = `
+"# project
+
+Description
+
+## Contributors
+These people contributed to the project:
+<!-- ALL-CONTRIBUTORS-LIST:START -->
+<!-- prettier-ignore-start -->
+<!-- markdownlint-disable -->
+<p>
+    <tr>
+      <td align=\\"center\\" valign=\\"top\\" width=\\"20%\\">Kent C. Dodds is awesome!</td>
+      <td align=\\"center\\" valign=\\"top\\" width=\\"20%\\">Divjot Singh is awesome!</td>
+      <td align=\\"center\\" valign=\\"top\\" width=\\"20%\\">Jeroen Engels is awesome!</td>
+    </tr>
+</p>
+
+<!-- markdownlint-restore -->
+<!-- prettier-ignore-end -->
+
+<!-- ALL-CONTRIBUTORS-LIST:END -->
+
+Thanks a lot everyone!"
+`;
+
 exports[`replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of contributors 1`] = `
 "# project
 

diff --git a/src/generate/__tests__/index.js b/src/generate/__tests__/index.js
@@ -69,6 +69,19 @@ test('replace the content between the ALL-CONTRIBUTORS-LIST tags by a table of c
   expect(result).toMatchSnapshot()
 })
 
+test('replace the content between the ALL-CONTRIBUTORS-LIST tags by a custom wrapper around the list of contributors contained in the "bodyContent" tag', () => {
+  const {kentcdodds, bogas04} = contributors
+  const {options, jfmengels, content} = fixtures()
+  const contributorList = [kentcdodds, bogas04, jfmengels]
+  const result = generate(
+    Object.assign(options, { wrapperTemplate: '<p><%= bodyContent %></p>'}),
+    contributorList,
+    content,
+  )
+
+  expect(result).toMatchSnapshot()
+})
+
 test('split contributors into multiples lines when there are too many', () => {
   const {kentcdodds} = contributors
   const {options, content} = fixtures()

diff --git a/src/generate/index.js b/src/generate/index.js
@@ -66,6 +66,10 @@ function formatFooter(options) {
 
 function generateContributorsList(options, contributors) {
   const tableFooter = formatFooter(options)
+  const defaultWrapperTemplate =  _.template('\n<table>\n  <tbody><%= bodyContent %>  </tbody>\n<%= tableFooterContent %></table>\n\n')
+  const wrapperTemplate = options.wrapperTemplate ? _.template(`\n${options.wrapperTemplate}\n\n`) : defaultWrapperTemplate
+  const seperator = options.wrapperTemplate ? '\n    </tr><br />\n    <tr>\n      ' : '\n    </tr>\n    <tr>\n      '
+
   let tableFooterContent = ''
 
   return _.flow(
@@ -81,12 +85,15 @@ function generateContributorsList(options, contributors) {
     _.map((currentLineContributors) => formatLine(
       options, currentLineContributors
     )),
-    _.join('\n    </tr>\n    <tr>\n      '),
+    _.join(seperator),
     newContent => {
       if (options.linkToUsage) {
         tableFooterContent = `  <tfoot>\n    ${tableFooter}\n  </tfoot>\n`
       }
-      return `\n<table>\n  <tbody>\n    <tr>\n      ${newContent}\n    </tr>\n  </tbody>\n${tableFooterContent}</table>\n\n`
+
+      const bodyContent = `\n    <tr>\n      ${newContent}\n    </tr>\n`
+
+      return wrapperTemplate({ bodyContent, tableFooterContent})
     },
   )(contributors)
 }
@@ -135,6 +142,7 @@ module.exports = function generate(options, contributors, fileContent) {
       ? '\n'
       : generateContributorsList(options, contributors)
   const badge = formatBadge(options, contributors)
+
   return _.flow(
     injectListBetweenTags(contributorsList),
     replaceBadge(badge),