-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
282 lines (278 loc) · 7.78 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
281
282
// Packages needed
const inquirer = require('inquirer');
const fs = require('fs');
const generateMarkdown = require('./assets/utils/generateMarkdown');
// Array of questions for user input
const questions = [
{
type: "input",
message: "Enter your project title: ",
name: "name",
validate: answers => {
if (!answers.trim()) {
return 'Please give a name to your project!';
}
else {
return true;
}
}
},
{
type: "list",
message: "Choose a style: ",
name: "style",
choices: ['Classic', 'Creative']
},
{
type: "confirm",
message: "Does your app have a logo?",
name: "logo",
when(answers) {
return answers.style === "Creative";
}
},
{
type: "input",
message: "Provide a short description explaining the what, why, and how of your project: ",
name: "description",
validate: answers => {
if (!answers.trim()) {
return 'Provide a short description explaining the what, why, and how of your project.';
}
else {
return true;
}
}
},
{
type: "confirm",
message: "Would you like to add a table of contents? ",
name: "tableOfContents"
},
{
type: "confirm",
message: "Does your app require instalation?",
name: "installationQues",
},
{
type: "input",
message: "What are the steps required to install your project? ",
name: "installation",
when(answers) {
return answers.installationQues === true;
},
validate: answers => {
if (!answers.trim()) {
return 'Provide a step-by-step description of how to get the development environment running.';
}
else {
return true;
}
}
},
{
type: "confirm",
message: "Does your app have a website?",
name: "website",
},
{
type: "input",
message: "Please enter your website's URL: ",
name: "websiteURL",
when(answers) {
return answers.website === true;
},
validate: answers => {
if (!answers.trim()) {
return "Provide your website's URL";
}
else {
return true;
}
}
},
{
type: "confirm",
message: "Would you like to add an image or gif of your app? ",
name: "mockup",
},
{
type: "input",
message: "Provide instructions and examples for use: ",
name: "usage",
validate: answers => {
if (!answers.trim()) {
return 'An application is useless if no one knows how to use it!';
}
else {
return true;
}
}
},
{
type: "input",
message: "Enter an email address in case the user has questions about your project: ",
name: "email",
validate: (answers) => {
const valid = /^[^\s@]+@[^\s@]+\.[^\s@]+$/.test(answers)
if (valid) {
return true;
} else {
console.log("\n Please enter a valid email")
return false;
}
}
},
{
type: "input",
message: "Enter your github username (without the @): ",
name: "github",
validate: answers => {
if (!answers.trim()) {
return 'Please enter your github username!';
}
else {
return true;
}
}
},
{
type: "confirm",
message: "Would you like other developers to contribute to your app?",
name: "contributingQues"
},
{
type: "input",
message: "Please enter guidelines for how to contribute to your app: ",
name: "contributing",
when(answers) {
return answers.contributingQues === true;
},
validate: answers => {
if (!answers.trim()) {
return 'Please enter your contribution guidelines!';
}
else {
return true;
}
}
},
{
type: "confirm",
message: "Would you like to write tests for your application?",
name: "testsQues"
},
{
type: "input",
message: "Please provide examples on how to run the tests: ",
name: "tests",
when(answers) {
return answers.testsQues === true;
},
validate: answers => {
if (!answers.trim()) {
return 'Please provide test instructions!';
}
else {
return true;
}
}
},
{
type: "input",
message: "Enter all the libraries, frameworks and other code/app you've used in your project: ",
name: "acknowledgements",
filter(answers) {
return answers.split(/[ ,]+/).filter(Boolean);
},
validate(answers) {
if (answers.length < 1) {
return "Mention at least one library/framework/code/app! They deserve the credit!";
}
else {
return true;
}
},
},
{
type: "confirm",
message: "Has anyone else helped you build this app?",
name: "authorsQues"
},
{
type: "input",
message: "Enter all the authors name: ",
name: "authors",
when(answers) {
return answers.authorsQues === true;
},
filter(answers) {
return answers.split(/[ ,]+/).filter(Boolean);
},
validate(answers) {
if (answers.length < 1) {
return 'They deserve the credit too!';
}
else {
return true;
}
},
},
{
type: "list",
message: "Enter your project's license: ",
name: "license",
choices: ['Apache License 2.0', 'MIT License', 'GNU GPLv3', 'GNU LGPLv3', 'GNU AGPLv3', 'ISC License', 'Mozilla Public License 2.0', 'Boost Software License 1.0', 'None']
},
{
type: "confirm",
message: "Would you like to add badges?",
name: "badgesQues"
},
{
type: "list",
message: "Choose one color for your badges: ",
name: "badgesColor",
choices: ['green', 'blue', 'yellow', 'red', 'pink', 'light blue', 'grey', 'orange', 'violet'],
when(answers) {
return answers.badgesQues === true;
}
},
{
type: "input",
message: "Enter the name of your repository exactly as it is displayed on GitHub: ",
name: "repository",
when(answers) {
return answers.contributingQues === true || answers.badgesQues === true || answers.license !== "none";
},
validate: answers => {
if (!answers.trim()) {
return 'Please provide your repository name!';
}
else {
return true;
}
}
},
];
// Initialize app
const init = () => {
return inquirer.prompt(questions);
}
// Function call to initialize app
init()
.then(answers => {
generateMarkdown(answers);
writeToFile(answers);
})
.catch(err => {
console.log(err);
})
// Function to write README file
const writeToFile = (answers) => {
const fileName = './dist/README.md';
console.log("Generating your file...");
fs.writeFile(fileName, generateMarkdown(answers), (err) =>
err ? console.log(err) : console.log('Your README.md has been successfully generated!')
);
}