🐛 Escape markdown characters in social network questions answers (#183)

package.json

@@ -14,8 +14,9 @@
     "inquirer": "~7.0.0",
     "load-json-file": "^6.0.0",
     "lodash": "^4.17.11",
-    "ora": "4.0.3",
+    "markdown-escape": "^1.0.2",
     "node-fetch": "^2.6.0",
+    "ora": "4.0.3",
     "yargs": "^14.0.0"
   },
   "devDependencies": {

src/questions/author-patreon.js

@@ -1,5 +1,8 @@
+const { cleanSocialNetworkUsername } = require('../utils')
+
 module.exports = () => ({
   type: 'input',
   message: '❤️  Patreon username (use empty value to skip)',
-  name: 'authorPatreonUsername'
+  name: 'authorPatreonUsername',
+  filter: cleanSocialNetworkUsername
 })

src/questions/author-patreon.spec.js

@@ -7,7 +7,8 @@ describe('askPatreonUsername', () => {
     expect(result).toEqual({
       type: 'input',
       message: '❤️  Patreon username (use empty value to skip)',
-      name: 'authorPatreonUsername'
+      name: 'authorPatreonUsername',
+      filter: expect.any(Function)
     })
   })
 })

src/utils.js

@@ -5,6 +5,7 @@ const boxen = require('boxen')
 const path = require('path')
 const getReposName = require('git-repo-name')
 const fetch = require('node-fetch')
+const escapeMarkdown = require('markdown-escape')
 const { execSync } = require('child_process')
 
 const END_MSG = `README.md was successfully generated.
@@ -118,12 +119,14 @@ const getDefaultAnswers = questions =>
   )
 
 /**
- * Clean social network username by removing the @ prefix
+ * Clean social network username by removing the @ prefix and
+ * escaping markdown characters
  *
  * @param input social network username input
- * @returns {*} input without the prefix
+ * @returns {*} escaped input without the prefix
  */
-const cleanSocialNetworkUsername = input => input.replace(/^@/, '')
+const cleanSocialNetworkUsername = input =>
+  escapeMarkdown(input.replace(/^@/, ''))
 
 /**
  * Get author's website from Github API

src/utils.spec.js

@@ -217,11 +217,20 @@ describe('utils', () => {
 
   describe('cleanSocialNetworkUsername', () => {
     it('should remove prefixed @', () => {
-      expect(cleanSocialNetworkUsername('@Slashgear_')).toEqual('Slashgear_')
+      expect(cleanSocialNetworkUsername('@Slashgear')).toEqual('Slashgear')
     })
 
-    it('should return the same string when string is not prefixed', () => {
-      expect(cleanSocialNetworkUsername('Slashgear_')).toEqual('Slashgear_')
+    it('should escape markdown characters', () => {
+      expect(cleanSocialNetworkUsername('Slashgear__')).toEqual(
+        'Slashgear\\_\\_'
+      )
+      expect(cleanSocialNetworkUsername('Slashgear**')).toEqual(
+        'Slashgear\\*\\*'
+      )
+    })
+
+    it('should return the same string when string is not prefixed or contains markdown chars', () => {
+      expect(cleanSocialNetworkUsername('Slashgear')).toEqual('Slashgear')
     })
   })