-
Notifications
You must be signed in to change notification settings - Fork 0
/
index.js
424 lines (351 loc) · 13.2 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
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
// Importing required modules and dependencies
const configLogic = require("./config/configLogic");
const inquirer = require("inquirer");
const banner = require('./utils/banner');
const markdownTemplate = require("./templates/markdown");
const licenseTemplate = require("./templates/license");
const copyImage = require("./utils/copyImages");
const writeFile = require("./utils/writeFiles");
const generateFolderName = require("./utils/idsGenerator");
const showHelp = require("./help/help");
// Parsing command line arguments
const argv = require('minimist')(process.argv.slice(2))
// Loading configuration from file
const config = require("./config/config.json");
// Clearing the console screen
const clearScreen = require('./utils/clearScreen');
// Load configuration
configLogic();
// clear screen
clearScreen();
// Check for --help flag
if (argv.help) {
showHelp();
} else{
// Main program logic
// CValidation function for text inputs
function validation(input, textType){
if(input.trim() === ''){
return `${textType} cannot be empty.`;
} else if(input.length < 5){
return `${textType} needs to be at least 5 characters.`;
}
return true;
}
// Function to prompt for text input
function promptText(textType, msg) {
return inquirer.prompt([
{
type: 'input',
message: msg,
name: textType,
validate: (input) => validation(input, textType),
},
]);
}
// Function to prompt for confirmation and additional text input
function promptTextConfirm(textType) {
const has_text = `has_${textType}`;
return inquirer.prompt([
{
type: "confirm",
message: `Any ${textType} to this project?`,
name: has_text,
default: false,
},
{
type: "input",
message: "Enter the GitHub usernames (comma separated)",
name: `${textType}Text`,
when: (answers) => answers[has_text],
},
]);
}
// Function to prompt for image input
function promptImage(imgType){
const has_img = `has_${imgType}`;
return inquirer.prompt([
{
type: "confirm",
message: `Do you want to include a ${imgType} image? (Ensure it's in 'temp/images' before proceeding) `,
name: has_img,
default: false,
},
{
type: "input",
message: "Enter the name of your image file (with extension) ",
name: `${imgType}Image`,
when: (answers) => answers[has_img],
},
]);
}
// Function to prompt for repeating input
async function promptRepeat(textType, msg) {
const answers = [];
if(textType === 'module' || textType === 'test'){
const isProcede = await inquirer.prompt([
{
type: 'confirm',
name: textType,
message: `Do you want to add ${textType} section?`,
default: false,
},
]);
if(!isProcede[textType]) {
return {[textType]: false}
};
}
let askAgain = true;
while (askAgain) {
const response = await inquirer.prompt([
{
type: 'input',
name: textType,
message: msg,
validate : (input) => validation(input, textType),
},
{
type: 'input',
name: `${textType}Desc`,
message: `Enter the ${
textType === 'instalation' || textType === 'test' ?
`${textType} command` : `${textType} description`
}`,
validate : (input) => validation(input, textType),
},
{
type: 'confirm',
name: 'askAgain',
message: `Want to enter another ${
textType === 'test' ?
`${textType} step` : `${textType} description`
} (enter for YES)?`,
default: true,
},
]);
answers.push({name: response[textType], description: response[`${textType}Desc`]});
askAgain = response.askAgain;
}
return {[textType]: answers };
}
// Function to prompt for technology selection
function promptTechnology(){
return inquirer.prompt([
{
type: 'checkbox',
message: 'Select technologies used in this project',
name: 'technologies',
choices: ['JavaScript', 'React', 'Node.js', 'CSS', 'MySQL', 'SQL', 'JQuery', 'HTML'],
validate(answer) {
if (answer.length < 1) {
return 'You must choose at least one technology.';
}
return true;
},
}
])
}
// Function to prompt for license selection
function promptLicense(){
return inquirer.prompt([
{
type: 'list',
name: 'license',
message: 'What kind of license should your project have?',
choices: ['MIT', 'BSD3', 'GPLv3', 'MPL2', 'Apache2'],
},
])
}
// Markdown icons
const icons = {
table: "📖",
overview: "📄",
screenshot: "🖼️",
features: "🚀",
installation: "⚙️",
usage: "🔍",
modules: "📦",
contributing: "🤝",
test: "🧪",
questions: "❓",
license: "📜",
acknowledge: "🙏",
};
// Function to filter table of contents based on user responses
function filterTableOfContents(answers) {
const tableOfContents = {
description: `- [${icons.overview} Overview](#-overview)`,
has_screenshot: `- [${icons.screenshot} Screenshot](#️-screenshot)`,
feature: `- [${icons.features} Features](#-features)`,
installation: `- [${icons.installation} Installation](#️-installation)`,
usage: `- [${icons.usage} How to use it](#-how-to-use-it)`,
module: `- [${icons.modules} Modules](#-modules)`,
repo: `- [${icons.contributing} Contributing](#-contributing)`,
test: `- [${icons.test} Testing](#-testing)`,
email: `- [${icons.questions} Questions](#-questions)`,
licenseType: `- [${icons.license} License](#-license)`,
acknowledge: `- [${icons.acknowledge} Acknowledgments](#-acknowledgments)`,
};
// Filtered data entries user didnt choose
const filteredEntries =Object.entries(answers)
.filter(([_, value]) => value) // Filter 'false' values / not choosen
.map(([key]) => key); // Getting keys of filtered entries
// Return the Table of Contents which user has chosen
return Object.entries(tableOfContents)
.filter(([key]) => filteredEntries.includes(key))
.map(([_, value]) => value).join('\n');
}
// Function to ask questions
async function askQuestions() {
// Display the banner
if (config.banner === true) {
banner();
}
try {
// GitHub username
const githubUserNameAnswer = await promptText('GitHub', 'What is your GitHub username?');
// User email address
const emailAnswer = await promptText('email', 'What is your email address?');
// Repository name
const repoAnswer = await promptText('repo', 'What is your repository name?');
// License type
const licenseBadgesAnswer = await promptLicense();
const licensesBadges = {
'MIT':'https://img.shields.io/badge/License-MIT-yellow.svg',
'BSD3':'https://img.shields.io/badge/License-BSD_3--Clause-orange.svg',
'GPLv3':'https://img.shields.io/badge/License-GPLv3-blue.svg',
'MPL2':'https://img.shields.io/badge/License-MPL_2.0-brightgreen.svg',
'Apache2':'https://img.shields.io/badge/License-Apache_2.0-yellowgreen.svg',
};
const licenseBadge = {
licenseType: licenseBadgesAnswer['license'],
licenseUrl: licensesBadges[licenseBadgesAnswer['license']]
};
// Technologies used
const technologyAnswer = await promptTechnology();
const technologies = {
"JavaScript" : '[![JavaScript](https://img.shields.io/badge/JavaScript-ES6-yellow.svg)](https://developer.mozilla.org/en-US/docs/Web/JavaScript)',
"React" : '[![React](https://img.shields.io/badge/React-18.x-blue.svg)](https://reactjs.org/)',
"Node.js" : '[![Node.js](https://img.shields.io/badge/Node.js-18.x-green.svg)](https://nodejs.org/)',
"CSS" : '[![CSS](https://img.shields.io/badge/CSS3-orange.svg)](https://developer.mozilla.org/en-US/docs/Web/CSS)',
"MySQL" : '[![MySQL](https://img.shields.io/badge/MySQL-lightgrey.svg)](https://www.mysql.com/)',
"SQL" : '[![SQL](https://img.shields.io/badge/SQL-lightgrey.svg)](https://www.mysql.com/)',
"JQuery" : '[![jQuery](https://img.shields.io/badge/jQuery-3.x-blueviolet.svg)](https://jquery.com/)',
"HTML" : '[![HTML](https://img.shields.io/badge/HTML5-orange.svg)](https://developer.mozilla.org/en-US/docs/Web/HTML)'
}
const technologiesPicked = Object.entries(technologies)
.filter((technology) => JSON.stringify([technologyAnswer['technologies']]).includes(technology[0]))
.map(url => url[1])
.join(' ');
// Project title
const projectNameAnswer = await promptText('title', 'What is your project\'s title?');
// Project description
const descriptionAnswer = await promptText('description', 'Please write a short description of your project');
// Project installation process
const instalationAnswer = await promptRepeat('instalation', 'Please provide installation description');
const installation = instalationAnswer['instalation'].map((steps, index) => {
return `${index + 1}. ${steps.name}:\n\`\`\`sh\n${steps.description}\n\`\`\`\n`
}).join('');
// How to use project
const usageAnswer = await promptText('usage', 'What does the user need to know about using the repo? (sentance separated with fullstop)');
const usage = usageAnswer['usage']
.split('.')
.filter(empty => empty !== '')
.map((str, index) => `${index + 1}. ${str.trim()}`)
.join('\n')
// Project features
const featuresTableAnswer = await promptRepeat('feature', 'Please provide name of the project feature');
const features = featuresTableAnswer['feature'].map((feature) => `| ${feature.name} | ${feature.description} |`).join('\n');
// Project logo
const logoAnswer = await promptImage('logo');
// Project screenshot
const screenshotAnswer = await promptImage('screenshot');
let screenDescriptionAnswer = {};
if(screenshotAnswer['has_screenshot']){
screenDescriptionAnswer = await promptText('screenshotDesc', 'Please write an short screenshot description');
}
// Project modules
const modulesTableAnswer = await promptRepeat('module', 'Enter module name (with extension)');
let module = false;
if(modulesTableAnswer['module']){
module = modulesTableAnswer['module'].map((file) => {
return `| ${file.name} | ${file.description} |`
}).join('\n');
}
// Project test process
const testAnswer = await promptRepeat('test', 'What commands should be run to run the tests?');
let test = false;
if(testAnswer['test']){
test = testAnswer['test'].map((steps, index) => {
return `${index + 1}. ${steps.name}:\n\`\`\`sh\n${steps.description}\n\`\`\`\n`
}).join('');
}
// Acknowledge
const acknowledAnswer = await promptTextConfirm('acknowledgments');
let acknowledge = false;
if(acknowledAnswer['acknowledgmentsText']){
acknowledge = acknowledAnswer['acknowledgmentsText']
.split(',')
.filter(empty => empty !== '')
.map((str) => `- ${str.trim()}\n`)
.join('')
}
// All answers
const allAnswers = {
...githubUserNameAnswer,
...emailAnswer,
...repoAnswer,
...licenseBadge,
...{tech: technologiesPicked},
...projectNameAnswer,
...descriptionAnswer,
...{installation: installation},
...{usage: usage},
...{feature: features},
...logoAnswer,
...screenshotAnswer,
...screenDescriptionAnswer,
...{module: module},
...{test: test},
...{acknowledge: acknowledge},
};
// Generate unique folder name with current date
const folderName = generateFolderName();
// Output folder got Readme files
const folderPath = `./output/${folderName}`;
// Filtered Table of Contents
const table = filterTableOfContents(allAnswers);
// Data for generating the Readme file
const readme = markdownTemplate({
...allAnswers,
...{table: table},
...{icons: icons},
});
// Generating the Readme file
writeFile(`${folderPath}/README.md`, readme);
// Data for generating the Readme file
const license = licenseTemplate({
...projectNameAnswer,
...licenseBadge,
...emailAnswer,
});
console.log('Generating README...');
// Generate the license
writeFile(`${folderPath}/LICENSE.md`, license);
// Copy the logo image
if(logoAnswer['has_logo']){
const logoImage = JSON.stringify(logoAnswer['logoImage']).split('"')[1];
copyImage(`./temp/images/${logoImage}`, `./output//${folderName}/images/${logoImage}`);
}
// Copy the screenshot image
if(screenshotAnswer['has_screenshot']){
const screenshotImage = JSON.stringify(screenshotAnswer['screenshotImage']).split('"')[1];
copyImage(`./temp/images/${screenshotImage}`, `./output//${folderName}/images/${screenshotImage}`);
}
} catch (error) {
console.error('Error during question prompts:', error);
}
}
// Call the main function to start asking questions
askQuestions();
}