-
Notifications
You must be signed in to change notification settings - Fork 21
/
cli.ts
220 lines (202 loc) · 6.52 KB
/
cli.ts
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
import chalk from "chalk"
import commander from "commander"
import * as fs from "fs"
import * as path from "path"
import * as readline from "readline"
import { Config } from "./config"
import { ConventionalCommits } from "./conventional-commits"
import { Devmoji } from "./devmoji"
export class Cli {
commits: ConventionalCommits
opts: { [key: string]: string | boolean | undefined }
constructor(public program: commander.Command, public devmoji: Devmoji) {
this.commits = new ConventionalCommits(devmoji)
this.opts = program.opts()
}
lint(text: string) {
text = text.split("\n")[0]
if (/^(Merge (remote-tracking )?branch)/.test(text)) return []
if (/^(fixup|squash)!/.test(text)) return []
if (/^([rR]evert)/.test(text)) return []
const errors = []
const match =
/^(?<type>:?[a-z-]+)(?:\((?<scope>[a-z-0-9]+)\))?(!?):\s+(?<description>.*)/iu.exec(
text
)
if (match) {
const type = match.groups?.type ?? ""
const description = match.groups?.description
if (!this.devmoji.config.options.types.includes(type)) {
errors.push(
`Type should be one of: ${chalk.grey(
this.devmoji.config.options.types.join(", ")
)}`
)
}
if (!description || description.trim().length == 0)
errors.push("Missing description")
} else {
errors.push(`Expecting a commit message like:`)
errors.push(
` ${
chalk.blue("type" + chalk.bold("(scope):")) +
chalk.dim(" description")
}`
)
}
if (errors.length) {
errors.push("Get help at https://www.conventionalcommits.org/")
}
return errors
}
format(
text: string,
format = "unicode",
processCommit = false,
processLog = false,
color = this.opts.color
) {
if (processCommit && this.opts.lint && !processLog) {
const errors = this.lint(text)
if (errors.length) {
errors.forEach((e) => console.error(chalk.red("✖"), e))
process.exit(1)
}
}
if (processLog) text = this.commits.formatLog(text, color ? true : false)
else if (processCommit)
text = this.commits.formatCommit(text, color ? true : false)
switch (format) {
case "unicode":
return this.devmoji.emojify(text)
case "shortcode":
return this.devmoji.demojify(text)
case "devmoji":
return this.devmoji.devmojify(text)
case "strip":
return this.devmoji.strip(text)
}
throw `Invalid format '${format}'`
}
list() {
console.log(chalk.blue.dim.underline("Available Devmoji"))
for (const code of this.devmoji.config.pack.codes.values()) {
let cc = ""
if (this.devmoji.config.options.types.includes(code.code)) {
cc = `${code.code}: `
}
if (code.code.includes("-")) {
const [type, scope] = code.code.split("-")
if (this.devmoji.config.options.types.includes(type)) {
cc = `${type}(${scope}): `
}
}
console.log(
this.devmoji.get(code.emoji),
" ",
chalk.blue(`:${code.code}:`.padEnd(15)),
chalk.green(cc) + (code.description ?? "")
)
}
}
error(msg: string) {
console.error(chalk.red("error ") + msg)
process.exit(1)
}
gitRoot(cwd = process.cwd()): string | undefined {
const p = path.resolve(cwd, "./.git")
if (fs.existsSync(p) && fs.lstatSync(p).isDirectory()) return p
const up = path.resolve(cwd, "../")
if (up == cwd) return
return this.gitRoot(up)
}
static async create(argv = process.argv, exitOverride = false) {
const program: commander.Command = new commander.Command()
if (exitOverride) program.exitOverride()
program
.option("-c|--config <file>", "location of the devmoji.config.js file")
.option("-l|--list", "list all known devmojis")
.option(
"-t|--text <text>",
"text to format. reads from stdin when omitted"
)
.option("--lint", "lint the conventional commit. disabled for --log")
.option(
"-f|--format <format>",
"format should be one of: unicode, shortcode, devmoji",
"unicode"
)
.option(
"--commit",
"automatically add a devmoji to the conventional commit header",
true
)
.option("--no-commit", "do not process conventional commit headers")
.option(
"-e|--edit",
"read last commit message from .git/COMMIT_EDITMSG in the git root"
)
.option("--log", "format conventional commits in text similar to git log")
.option(
"--color",
"use colors for formatting. Colors are enabled by default, unless output is piped to another command",
chalk.level > 0
)
.option("--no-color", "don't use colors")
// eslint-disable-next-line @typescript-eslint/no-var-requires, @typescript-eslint/no-unsafe-member-access
.version(require("../package.json").version as string, "--version")
.parse(argv)
const config = await Config.load(program.opts().config)
return new Cli(program, new Devmoji(config))
}
run() {
const opts = this.program.opts()
if (opts.list) return this.list()
if (opts.text)
return console.log(
this.format(opts.text, opts.format, opts.commit, opts.log)
)
if (opts.edit) {
let commitMsgFile = this.gitRoot()
if (commitMsgFile) {
commitMsgFile = path.resolve(commitMsgFile, "COMMIT_EDITMSG")
}
if (commitMsgFile && fs.existsSync(commitMsgFile)) {
let text = fs.readFileSync(commitMsgFile, "utf-8")
text = this.format(text, opts.format, opts.commit, false, false)
const out = this.format(text, opts.format, opts.commit, false, true)
fs.writeFileSync(commitMsgFile, text, "utf-8")
return console.log(chalk.green("✔"), out)
} else {
this.error("Couldn't find .git/COMMIT_EDITMSG")
}
return
}
if (!process.stdin.isTTY) {
const rl = readline.createInterface({
input: process.stdin,
terminal: false,
})
let firstLine = true
rl.on("line", (line) => {
try {
console.log(
this.format(line, opts.format, opts.commit && firstLine, opts.log)
)
firstLine = false
} catch (err) {
this.error(err)
}
})
return
}
this.program.outputHelp()
return process.exit(1)
}
}
export async function run(argv = process.argv) {
return Cli.create(argv).then((cli) => cli.run())
}
if (module === require.main) {
void run()
}