♻️ Utils code refactoring

src/cli.js

@@ -2,7 +2,7 @@ const ejs = require('ejs')
 const path = require('path')
 const inquirer = require('inquirer')
 const getYear = require('date-fns/get_year')
-const { getPackageJson } = require('./utils')
+const { getProjectInfos } = require('./utils')
 
 const { getTemplate, createReadme } = require('./utils')
 const {
@@ -19,16 +19,16 @@ const {
  * Ask user questions and return context to generate a README
  */
 const askQuestions = async () => {
-  const packageJson = await getPackageJson()
+  const projectInfos = await getProjectInfos()
 
   const questions = [
-    askProjectName(),
-    askProjectDescription(packageJson),
-    askAuhtorName(packageJson),
+    askProjectName(projectInfos),
+    askProjectDescription(projectInfos),
+    askAuhtorName(projectInfos),
     askAuhtorGithub(),
     askAuhtorTwitter(),
-    askLicenseUrl(),
-    await askContributing(packageJson)
+    askLicenseUrl(projectInfos),
+    askContributing(projectInfos)
   ]
 
   return inquirer.prompt(questions)

src/questions/author-name.js

@@ -1,8 +1,6 @@
-const get = require('lodash/get')
-
-module.exports = packageJson => ({
+module.exports = projectInfos => ({
   type: 'input',
   message: 'Enter your name',
   name: 'authorName',
-  default: get(packageJson, 'author', undefined)
+  default: projectInfos.author
 })

src/questions/contributing.js

@@ -1,8 +1,6 @@
-const { getReposIssuesUrl } = require('../utils')
-
-module.exports = async packageJson => ({
+module.exports = packageJson => ({
   type: 'input',
   message: 'Enter the url of your issues (use empty value to skip)',
   name: 'contributingUrl',
-  default: await getReposIssuesUrl(packageJson)
+  default: packageJson.contributingUrl
 })

src/questions/project-description.js

@@ -1,8 +1,6 @@
-const get = require('lodash/get')
-
-module.exports = packageJson => ({
+module.exports = projectInfos => ({
   type: 'input',
   message: 'Enter your project description',
   name: 'projectDescription',
-  default: get(packageJson, 'description', undefined)
+  default: projectInfos.description
 })

src/questions/project-name.js

@@ -1,8 +1,6 @@
-const getProjectName = require('project-name')
-
-module.exports = () => ({
+module.exports = projectInfos => ({
   type: 'input',
   message: 'Enter your project name',
   name: 'projectName',
-  default: getProjectName() || undefined
+  default: projectInfos.name
 })

src/utils/index.js

@@ -5,14 +5,18 @@ const loadJsonFile = require('load-json-file')
 const get = require('lodash/get')
 const isNil = require('lodash/isNil')
 const exec = util.promisify(require('child_process').exec)
+const getProjectName = require('project-name')
 
 /**
  * Clean repository url by removing '.git' and 'git+'
  *
  * @param {string} cleanReposUrl
  */
 const cleanReposUrl = reposUrl => {
-  return reposUrl.replace('git+', '').replace('.git', '')
+  return reposUrl
+    .replace('\n', '')
+    .replace('git+', '')
+    .replace('.git', '')
 }
 
 /**
@@ -93,12 +97,25 @@ const getReposIssuesUrl = async packageJson => {
   return reposIssuesUrl
 }
 
+const getProjectInfos = async () => {
+  const packageJson = await getPackageJson()
+  const name = getProjectName() || undefined
+  const description = get(packageJson, 'description', undefined)
+  const author = get(packageJson, 'author', undefined)
+  const repositoryUrl = await getReposUrl(packageJson)
+  const contributingUrl = await getReposIssuesUrl(packageJson)
+
+  return {
+    name,
+    description,
+    author,
+    repositoryUrl,
+    contributingUrl
+  }
+}
+
 module.exports = {
-  getPackageJson,
   getTemplate,
   createReadme,
-  getReposUrlFromPackageJson,
-  getReposUrlFromGit,
-  getReposUrl,
-  getReposIssuesUrl
+  getProjectInfos
 }

templates/default.md

@@ -46,7 +46,7 @@ Contributions, issues and feature requests are welcome. Feel free to check [issu
 Please ⭐️ this repository if you like it.
 <% if (licenseUrl) { -%>
 
-##  License
+## License
 
 <% if (authorName && authorGithubUsername) { -%>
 Copyright © <%= currentYear %> [<%= authorName %>](https://github.com/<%= authorGithubUsername %>).