Add using npm funding field 💸

.all-contributorsrc

@@ -199,6 +199,15 @@
       "contributions": [
         "code"
       ]
+    },
+    {
+      "login": "MIKOLAJW197",
+      "name": "Mikołaj Wolicki",
+      "avatar_url": "https://avatars3.githubusercontent.com/u/42266201?v=4",
+      "profile": "https://github.com/MIKOLAJW197",
+      "contributions": [
+        "code"
+      ]
     }
   ],
   "contributorsPerLine": 7,

README.md

@@ -119,6 +119,7 @@ Feel free to check [issues page](https://github.com/kefranabg/readme-md-generato
     <td align="center"><a href="https://github.com/anku255"><img src="https://avatars1.githubusercontent.com/u/22813027?v=4" width="75px;" alt="Ankit Tiwari"/><br /><sub><b>Ankit Tiwari</b></sub></a><br /><a href="https://github.com/kefranabg/readme-md-generator/commits?author=anku255" title="Code">💻</a> <a href="https://github.com/kefranabg/readme-md-generator/commits?author=anku255" title="Tests">⚠️</a> <a href="https://github.com/kefranabg/readme-md-generator/issues?q=author%3Aanku255" title="Bug reports">🐛</a></td>
     <td align="center"><a href="https://github.com/Zenigata"><img src="https://avatars1.githubusercontent.com/u/1022393?v=4" width="75px;" alt="Johan Bonneau"/><br /><sub><b>Johan Bonneau</b></sub></a><br /><a href="https://github.com/kefranabg/readme-md-generator/commits?author=Zenigata" title="Code">💻</a></td>
     <td align="center"><a href="https://github.com/hgwood/blog"><img src="https://avatars0.githubusercontent.com/u/1656170?v=4" width="75px;" alt="Hugo Wood"/><br /><sub><b>Hugo Wood</b></sub></a><br /><a href="https://github.com/kefranabg/readme-md-generator/commits?author=hgwood" title="Code">💻</a></td>
+    <td align="center"><a href="https://github.com/MIKOLAJW197"><img src="https://avatars3.githubusercontent.com/u/42266201?v=4" width="75px;" alt="Mikołaj Wolicki"/><br /><sub><b>Mikołaj Wolicki</b></sub></a><br /><a href="https://github.com/kefranabg/readme-md-generator/commits?author=MIKOLAJW197" title="Code">💻</a></td>
   </tr>
 </table>
 

src/__snapshots__/readme.spec.js.snap

@@ -72,6 +72,8 @@ Give a ⭐️ if this project helped you!
   <img src=\\"https://c5.patreon.com/external/logo/[email protected]\\" width=\\"160\\">
 </a>
 
+
+
 ## 📝 License
 
 Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).<br />
@@ -142,6 +144,7 @@ Give a ⭐️ if this project helped you!
 [![support us](https://img.shields.io/badge/become-a patreon%20us-orange.svg?cacheSeconds=2592000)](https://www.patreon.com/FranckAbgrall)
 
 
+
 ## 📝 License
 
 Copyright © 2019 [Franck Abgrall](https://github.com/kefranabg).

src/project-infos.js

@@ -134,6 +134,7 @@ const getProjectInfos = async () => {
   const author = getAuthorName(packageJson)
   const version = get(packageJson, 'version', undefined)
   const licenseName = get(packageJson, 'license', undefined)
+  const fundingUrl = get(packageJson, 'funding.url', undefined)
   const homepage = get(packageJson, 'homepage', undefined)
   const usage = has(packageJson, 'scripts.start') ? 'npm run start' : undefined
   const testCommand = has(packageJson, 'scripts.test')
@@ -178,7 +179,8 @@ const getProjectInfos = async () => {
     isGithubRepos,
     usage,
     testCommand,
-    isJSProject
+    isJSProject,
+    fundingUrl
   }
 }
 

src/questions/index.js

@@ -6,6 +6,7 @@ module.exports = {
   askProjectHomepage: require('./project-homepage'),
   askProjectDemoUrl: require('./project-demo-url'),
   askProjectDocumentationUrl: require('./project-documentation-url'),
+  askProjectFundingUrl: require('./project-funding-url'),
   askAuhtorName: require('./author-name'),
   askAuthorGithub: require('./author-github'),
   askAuthorWebsite: require('./author-website'),

src/questions/index.spec.js

@@ -11,6 +11,7 @@ describe('questions', () => {
       'askProjectHomepage',
       'askProjectDemoUrl',
       'askProjectDocumentationUrl',
+      'askProjectFundingUrl',
       'askAuhtorName',
       'askAuthorGithub',
       'askAuthorWebsite',

src/questions/project-funding-url.js

@@ -0,0 +1,6 @@
+module.exports = projectInfos => ({
+  type: 'input',
+  message: '💸  Project funding url (use empty value to skip)',
+  name: 'projectFundingUrl',
+  default: projectInfos.fundingUrl
+})

src/questions/project-funding.spec-url.js

@@ -0,0 +1,17 @@
+const askProjectFundingUrl = require('./project-funding-url')
+
+describe('askProjectFunding', () => {
+  it('should return correct question format', () => {
+    const fundingUrl = 'fundingUrl'
+    const projectInfos = { fundingUrl }
+
+    const result = askProjectFundingUrl(projectInfos)
+
+    expect(result).toEqual({
+      type: 'input',
+      message: '💸  Project funding url (use empty value to skip)',
+      name: 'projectFundingUrl',
+      default: fundingUrl
+    })
+  })
+})

src/readme.spec.js

@@ -93,6 +93,7 @@ describe('readme', () => {
       projectHomepage:
         'https://github.com/kefranabg/readme-md-generator#readme',
       projectDemoUrl: 'https://github.com/kefranabg/readme-md-generator#-demo',
+      projectFundingUrl: null,
       authorName: 'Franck Abgrall',
       authorWebsite: 'https://www.franck-abgrall.me/',
       authorGithubUsername: 'kefranabg',

templates/default-no-html.md

@@ -102,6 +102,10 @@ Give a ⭐️ if this project helped you!
 [![support us](https://img.shields.io/badge/become-a patreon%20us-orange.svg?cacheSeconds=2592000)](https://www.patreon.com/<%= authorPatreonUsername %>)
 <% } -%>
 
+<% if (projectFundingUrl) { -%>
+You can also support this project [here.](<%= projectFundingUrl %>)
+<% } -%>
+
 <% if (licenseName && licenseUrl) { -%>
 
 ## 📝 License

templates/default.md

@@ -113,6 +113,11 @@ Give a ⭐️ if this project helped you!
   <img src="https://c5.patreon.com/external/logo/[email protected]" width="160">
 </a>
 <% } -%>
+
+<% if (projectFundingUrl) { -%>
+You can also support this project [here.](<%= projectFundingUrl %>)
+<% } -%>
+
 <% if (licenseName && licenseUrl) { -%>
 
 ## 📝 License