Skip to content

Commit

Permalink
✨ Add author information in README
Browse files Browse the repository at this point in the history
  • Loading branch information
kefranabg committed Jun 4, 2019
2 parents a5b5a4c + 5d4cf6f commit 2337d6b
Show file tree
Hide file tree
Showing 7 changed files with 54 additions and 8 deletions.
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,7 @@
<h1 align="center">readme-cli</h1>

> Generate README file
## 👤 Author

- Github 👉[@ttest](https://twitter.com/ttest)
14 changes: 10 additions & 4 deletions src/cli.js
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,23 @@ const inquirer = require('inquirer')

const { getTemplate, createReadme } = require('./utils')
const {
getProjectNameQuestion,
getProjectDescriptionQuestion
getProjectName,
getProjectDescription,
getAuhtorName,
getAuhtorGithub,
getAuhtorTwitter
} = require('./questions')

/**
* Ask user questions and return context to generate a README
*/
const askQuestions = async () => {
const questions = [
getProjectNameQuestion(),
await getProjectDescriptionQuestion()
getProjectName(),
await getProjectDescription(),
await getAuhtorName(),
getAuhtorGithub(),
getAuhtorTwitter()
]

return inquirer.prompt(questions)
Expand Down
5 changes: 5 additions & 0 deletions src/questions/author-github.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = () => ({
type: 'input',
message: 'Enter your Github username',
name: 'authorGithubUsername'
})
14 changes: 14 additions & 0 deletions src/questions/author-name.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
const get = require('lodash/get')

const { getPackageJson } = require('../utils')

module.exports = async () => {
const packageJson = await getPackageJson()

return {
type: 'input',
message: 'Enter your name',
name: 'authorName',
default: get(packageJson, 'author', undefined)
}
}
5 changes: 5 additions & 0 deletions src/questions/author-twitter.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
module.exports = () => ({
type: 'input',
message: 'Enter your Twitter username',
name: 'authorTwitterUsername'
})
14 changes: 10 additions & 4 deletions src/questions/index.js
Original file line number Diff line number Diff line change
@@ -1,7 +1,13 @@
const getProjectNameQuestion = require('./project-name')
const getProjectDescriptionQuestion = require('./project-description')
const getProjectName = require('./project-name')
const getProjectDescription = require('./project-description')
const getAuhtorName = require('./author-name')
const getAuhtorGithub = require('./author-github')
const getAuhtorTwitter = require('./author-twitter')

module.exports = {
getProjectNameQuestion,
getProjectDescriptionQuestion
getProjectName,
getProjectDescription,
getAuhtorName,
getAuhtorGithub,
getAuhtorTwitter
}
6 changes: 6 additions & 0 deletions templates/default.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,9 @@
<h1 align="center"><%= projectName %></h1>
<% if (projectDescription) { %>
> <%= projectDescription %><% } %>
<% if (authorName || authorTwitterUsername || authorGithubUsername) { %>
## 👤 Author
<% if (authorName) { %>**<%= authorName %>**<% } %>
<% if (authorTwitterUsername) { %>- Twitter 👉[@<%= authorTwitterUsername %>](https://twitter.com/<%= authorTwitterUsername %>) <% } %>
<% if (authorGithubUsername) { %>- Github 👉[@<%= authorGithubUsername %>](https://twitter.com/<%= authorGithubUsername %>) <% } %>
<% } %>

0 comments on commit 2337d6b

Please sign in to comment.