-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.js
281 lines (186 loc) · 5.15 KB
/
index.js
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
// Declare variables to hold dependencies
const inquirer = require("inquirer");
const fs = require("fs");
// Declare variable to hold svg icons for programming languages
const languageIcons = {
HTML: '<img src="../assets/html5.svg" alt="HTML">',
CSS: '<img src="../assets/css3.svg" alt="CSS">',
JavaScript: '<img src="../assets/javascript.svg" alt="JavaScript">',
NodeJS: '<img src="../assets/nodejs.svg" alt="NodeJS">',
React: '<img src="../assets/react.svg" alt="React">',
Heroku: '<img src="../assets/heroku.svg" alt="Heroku">',
}
// Use inquirer to build questions to obtain data for professional readme
EDITOR='code --wait'
inquirer
.prompt([
{
type: 'input',
name: 'title',
message: 'What is the title of your project?',
},
{
type: 'input',
name: 'description',
message: 'Provide a short description explaining the what, why, and how of your project.',
},
{
type: 'confirm',
name: 'confirm',
message: 'Would you like to add a section to display the programming languages used in your project?',
},
{
type: 'checkbox',
name: 'languages',
message: 'Select the languages used in your project:',
choices: ["HTML","CSS","JavaScript","NodeJS","React","Heroku"],
when: (answers) => answers.confirm,
},
{
type: 'editor',
name: 'installation',
message: 'What are the steps required to install your project? Provide a step-by-step description of how to get the development environment running',
default: "Fork and clone repository to local machine and then Run npm i to install dependencies in local project directory"
},
{
type: 'editor',
name: 'usage',
message: 'Provide instructions and examples on how to use your project.',
default: "Open integrated terminal, Run node index.js, Answer the prompts that follow, A proREADME.md will be generated and stored in the 'readme' folder."
},
{
type: 'list',
name: 'license',
message: 'Select the license the project will have',
choices: ["MIT", "GLP3.0", "BSD2", "BSD3", "None"],
},
{
type: 'editor',
name: 'contribution',
message: 'List collaborators, third-parties assets or tutorials used to achieve your project',
default: "None"
},
{
type: 'editor',
name: 'tests',
message: 'Write tests for your application. Then provide examples on how to run them here.',
default: "npm test"
},
{
type: 'input',
name: 'github',
message: 'Type your GitHub user name.',
},
{
type: 'input',
name: 'email',
message: 'Type your email address.',
default: "user@domain.com"
},
])
.then((answers) => {
// function to generate license badge
const renderLicenseBadge = (license) => {
return license !== "None" ? `![Github License](https://img.shields.io/badge/license-${license}-blue.svg)` : '';
};
// function to generate license data
const renderLicenseData = (license) => {
return license !== "None" ? ` This project is licensed under the terms of the \`${license}\` license. ` : "None"
}
// function to generate selected programming lenguages icons
let renderLanguageIcons = "";
if (answers.confirm) {
renderLanguageIcons = answers.languages
.filter(language => languageIcons[language])
.map(language => languageIcons[language])
.join("\n");
}
console.log(renderLanguageIcons);
// Generate Programming Languages section
const renderLanguageSection = (confirm) => {
return confirm !== false ?
`
## ⌨️ Programming Languages
---
</br>
<div style="display: inline_block">
${renderLanguageIcons}
</div>
</br>
` : ""
}
// Variable that will store all markdown file data
const readmeContent =
`
# ${answers.title}
</br>
${renderLicenseBadge(answers.license)}
</br>
---
## 📝 Description
---
</br>
${answers.description}
</br>
---
${renderLanguageSection(answers.confirm)}
---
## 📑 Table of Contents
---
</br>
- [Installation](#💿-installation)
- [Usage](#💻-usage)
- [License](#🔏-license)
- [Contribution](#🛠️-contribution)
- [Tests](#🧪-tests)
- [Questions](#💬-questions)
</br>
---
## 💿 [Installation](#📑-table-of-contents)
---
</br>
\`\`\`
${answers.installation}
\`\`\`
</br>
---
## 💻 [Usage](#📑-table-of-contents)
---
</br>
${answers.usage}
</br>
---
## 🔏 [License](#📑-table-of-contents)
---
</br>
${renderLicenseData(answers.license)}
</br>
---
## 🛠️ [Contribution](#📑-table-of-contents)
---
</br>
${answers.contribution}
</br>
---
## 🧪 [Tests](#📑-table-of-contents)
---
</br>
\`\`\`
${answers.tests}
\`\`\`
</br>
---
## 💬 [Questions](#📑-table-of-contents)
---
</br>
Please contact me at ${answers.email} with any questions.
</br>
To view more of my work, please visit my [GitHub](https://github.com/${answers.github}/) page.
</br>
---
[Back to Top](#📝-description)
`;
fs.writeFile("./readme/proReadME.md", readmeContent, (err) =>
err ? console.log(err) : console.log('Successfully created readme file!')
);
});