forked from sindresorhus/conduct
-
Notifications
You must be signed in to change notification settings - Fork 0
/
cli.js
executable file
·208 lines (173 loc) · 5.37 KB
/
cli.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
#!/usr/bin/env node
import path from 'node:path';
import process from 'node:process';
import {fileURLToPath} from 'node:url';
import fs from 'node:fs';
import meow from 'meow';
import inquirer from 'inquirer';
import {globbySync} from 'globby';
import getEmails from 'get-emails';
import chalk from 'chalk';
import Conf from 'conf';
import execa from 'execa';
import logSymbols from 'log-symbols';
const __dirname = path.dirname(fileURLToPath(import.meta.url));
const config = new Conf({
projectName: 'conduct',
defaults: {
language: 'en',
},
});
let filename = 'code-of-conduct';
const extension = '.md';
const cli = meow(`
Usage
$ conduct
Example
$ conduct --language=de
Options
--uppercase, -c Use uppercase characters (e.g. CODE-OF-CONDUCT.md)
--underscore, -u Use underscores instead of dashes (e.g. code_of_conduct.md)
--language, -l The language of the Code of Conduct [Default: en]
--directory, -d The output directory [Default: .]
`, {
importMeta: import.meta,
flags: {
uppercase: {
type: 'boolean',
default: false,
alias: 'c',
},
underscore: {
type: 'boolean',
default: false,
alias: 'u',
},
language: {
type: 'string',
alias: 'l',
},
directory: {
type: 'string',
default: '.',
alias: 'd',
},
},
});
function readmeIsUpperCase() {
const results = globbySync('readme.*', {caseSensitiveMatch: false});
if (results.length > 0) {
const fileObject = path.parse(results[0]);
return fileObject.name.toUpperCase() === fileObject.name;
}
return false;
}
const {flags} = cli;
if (flags.email) {
config.set('email', flags.email);
}
if (flags.uppercase || readmeIsUpperCase()) {
filename = filename.toUpperCase();
}
if (flags.underscore) {
filename = filename.replace(/-/g, '_');
}
if (typeof flags.language === 'string') {
const language = flags.language.toLowerCase();
const availableLanguages = loadLanguages();
if (!availableLanguages.has(language)) {
console.error(`${logSymbols.error} Unsupported language '${language}' was provided. Conduct currently supports:\n\n${[...availableLanguages].sort().join(', ')}`);
process.exit(1);
}
config.set('language', language);
}
const filePath = path.join(flags.directory, `${filename}${extension}`);
function loadLanguages() {
const vendorFiles = fs.readdirSync(path.join(__dirname, 'vendor'));
const languages = vendorFiles.map(file => file.match(/\.([a-z-]+)\.md/)[1]);
return new Set(languages);
}
function findGitConfigEmail() {
try {
return execa.sync('git', ['config', 'user.email']).stdout.trim();
} catch {}
}
async function findEmail(existingSrc) {
// Always override with CLI flag
if (cli.flags.email) {
return cli.flags.email;
}
let email;
// Load from existing Code of Conduct
if (existingSrc) {
const [existingEmail] = [...getEmails(existingSrc)];
email = existingEmail;
}
// Check config
if (!email) {
email = config.get('email');
}
// Infer from Git
if (!email) {
email = findGitConfigEmail();
}
// Prompt user
if (!email && process.stdout.isTTY) {
const answers = await inquirer.prompt([{
type: 'input',
name: 'email',
message: 'Couldn\'t infer your email. Please enter your email:',
validate: x => x.includes('@'),
}]);
email = answers.email;
}
if (email) {
config.set('email', email);
return email;
}
console.error(`Run \`${chalk.cyan('conduct [email protected]')}\` once to save your email.`);
process.exit(1);
}
function write(filepath, email, fileToRemove) {
const target = `vendor/code-of-conduct.${config.get('language')}.md`;
const source = fs.readFileSync(path.join(__dirname, target), 'utf8');
fs.mkdirSync(path.dirname(filepath), {recursive: true});
fs.writeFileSync(filepath, source.replace('[INSERT EMAIL ADDRESS]', email));
if (fileToRemove) {
fs.unlinkSync(fileToRemove);
console.log(`${logSymbols.warning} Deleted ${fileToRemove}`);
}
}
function generate(filepath, email) {
write(filepath, email);
console.log(`${logSymbols.success} Added a Code of Conduct to your project ❤️\n\n${chalk.bold('Please carefully read this document and be ready to enforce it.')}\n\nAdd the following to your contributing.md or readme.md:\nPlease note that this project is released with a [Contributor Code of Conduct](${filepath}). By participating in this project you agree to abide by its terms.`);
}
async function init() {
const directoryPathParts = process.platform === 'win32' ? flags.directory.split(path.sep) : [flags.directory];
const results = globbySync([
path.posix.join(...directoryPathParts, 'code_of_conduct.*'),
path.posix.join(...directoryPathParts, '.github', 'code_of_conduct.*'),
path.posix.join(...directoryPathParts, 'code-of-conduct.*'),
path.posix.join(...directoryPathParts, '.github', 'code-of-conduct.*'),
], {caseSensitiveMatch: false});
// Update existing
if (results.length > 0) {
const [existing] = results;
const existingSrc = fs.readFileSync(existing, 'utf8');
const email = await findEmail(existingSrc);
if (cli.flags.underscore || cli.flags.uppercase) {
// If the existing file is different from the
// intended file, pass it in for removal
write(filePath, email, existing !== filePath && existing);
} else {
// Otherwise, just update the original
write(existing, email);
}
console.log(`${logSymbols.success} Updated your Code of Conduct`);
return;
}
// Generate new
const email = await findEmail();
generate(filePath, email);
}
init();