/
vcreate.v
333 lines (309 loc) · 7.51 KB
/
vcreate.v
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
// Copyright (c) 2019-2024 Alexander Medvednikov. All rights reserved.
// Use of this source code is governed by an MIT license that can be found in the LICENSE file.
module main
import os
import cli { Command, Flag }
// Note: this program follows a similar convention as Rust cargo:
// `init` creates the structure of project in the current directory,
// `new` creates the structure of a project in a sub directory.
struct Create {
mut:
name string
description string
version string
license string
files []ProjectFiles
new_dir bool
template Template
}
struct ProjectFiles {
path string
content string
}
enum Template {
bin
lib
web
}
fn main() {
flags := [
Flag{
flag: .bool
name: 'bin'
description: 'Use the template for an executable application [default].'
},
Flag{
flag: .bool
name: 'lib'
description: 'Use the template for a library project.'
},
Flag{
flag: .bool
name: 'web'
description: 'Use the template for a vweb project.'
},
]
mut cmd := Command{
flags: [
Flag{
flag: .bool
name: 'help'
description: 'Print help information.'
global: true
},
]
posix_mode: true
commands: [
Command{
name: 'new'
usage: '<project_name>'
description: [
'Creates a new V project in a directory with the specified project name.',
'',
'A setup prompt is started to create a `v.mod` file with the projects metadata.',
'The <project_name> argument can be omitted and entered in the prompts dialog.',
'If git is installed, `git init` will be performed during the setup.',
].join_lines()
parent: &Command{
name: 'v'
}
posix_mode: true
disable_man: true
flags: flags
pre_execute: validate
execute: new_project
},
Command{
name: 'init'
description: [
'Sets up a V project within the current directory.',
'',
"If no `v.mod` exists, a setup prompt is started to create one with the project's metadata.",
'If no `.v` file exists, a project template is generated. If the current directory is not a',
'git project and git is installed, `git init` will be performed during the setup.',
].join_lines()
parent: &Command{
name: 'v'
}
posix_mode: true
disable_man: true
flags: flags
pre_execute: validate
execute: init_project
},
]
}
cmd.parse(os.args)
}
fn validate(cmd Command) ! {
if cmd.flags.get_bool('help')! {
cmd.execute_help()
exit(0)
}
if cmd.args.len > 1 {
cerror('too many arguments.\n')
cmd.execute_help()
exit(2)
}
}
fn new_project(cmd Command) ! {
mut c := Create{
template: get_template(cmd)
new_dir: true
}
c.prompt(cmd.args)
println('Initialising ...')
// Generate project files based on `Create.files`.
c.create_files_and_directories()
c.write_vmod()
c.write_gitattributes()
c.write_editorconfig()
c.create_git_repo(c.name)
}
fn init_project(cmd Command) ! {
mut c := Create{
template: get_template(cmd)
}
dir_name := check_name(os.file_name(os.getwd()))
if !os.exists('v.mod') {
mod_dir_has_hyphens := dir_name.contains('-')
c.name = if mod_dir_has_hyphens { dir_name.replace('-', '_') } else { dir_name }
c.prompt(cmd.args)
c.write_vmod()
if mod_dir_has_hyphens {
println('The directory name `${dir_name}` is invalid as a module name. The module name in `v.mod` was set to `${c.name}`')
}
}
println('Initialising ...')
c.create_files_and_directories()
c.write_gitattributes()
c.write_editorconfig()
c.create_git_repo('.')
}
fn (mut c Create) prompt(args []string) {
if c.name == '' {
c.name = check_name(args[0] or { os.input('Input your project name: ') })
if c.name == '' {
eprintln('')
cerror('project name cannot be empty')
exit(1)
}
if c.name.contains('-') {
eprintln('')
cerror('`${c.name}` should not contain hyphens')
exit(1)
}
if os.is_dir(c.name) {
eprintln('')
cerror('`${c.name}` folder already exists')
exit(3)
}
}
c.description = os.input('Input your project description: ')
default_version := '0.0.0'
c.version = os.input('Input your project version: (${default_version}) ')
if c.version == '' {
c.version = default_version
}
default_license := 'MIT'
c.license = os.input('Input your project license: (${default_license}) ')
if c.license == '' {
c.license = default_license
}
}
fn get_template(cmd Command) Template {
bin := cmd.flags.get_bool('bin') or { false }
lib := cmd.flags.get_bool('lib') or { false }
web := cmd.flags.get_bool('web') or { false }
if (bin && lib) || (bin && web) || (lib && web) {
eprintln("error: can't use more then one template")
exit(2)
}
return match true {
lib { .lib }
web { .web }
else { .bin }
}
}
fn cerror(e string) {
eprintln('error: ${e}.')
}
fn check_name(name string) string {
if name.trim_space().len == 0 {
eprintln('')
cerror('project name cannot be empty')
exit(1)
}
if name.is_title() {
mut cname := name.to_lower()
if cname.contains(' ') {
cname = cname.replace(' ', '_')
}
eprintln('warning: the project name cannot be capitalized, the name will be changed to `${cname}`')
return cname
}
if name.contains(' ') {
cname := name.replace(' ', '_')
eprintln('warning: the project name cannot contain spaces, the name will be changed to `${cname}`')
return cname
}
return name
}
fn (c &Create) write_vmod() {
path := if c.new_dir { '${c.name}/v.mod' } else { 'v.mod' }
content := "Module {
name: '${c.name}'
description: '${c.description}'
version: '${c.version}'
license: '${c.license}'
dependencies: []
}
"
os.write_file(path, content) or { panic(err) }
}
fn (c &Create) write_gitattributes() {
path := if c.new_dir { '${c.name}/.gitattributes' } else { '.gitattributes' }
if !c.new_dir && os.exists(path) {
return
}
content := '* text=auto eol=lf
*.bat eol=crlf
**/*.v linguist-language=V
**/*.vv linguist-language=V
**/*.vsh linguist-language=V
**/v.mod linguist-language=V
'
os.write_file(path, content) or { panic(err) }
}
fn (c &Create) write_editorconfig() {
path := if c.new_dir { '${c.name}/.editorconfig' } else { '.editorconfig' }
if !c.new_dir && os.exists(path) {
return
}
content := '[*]
charset = utf-8
end_of_line = lf
insert_final_newline = true
trim_trailing_whitespace = true
[*.v]
indent_style = tab
'
os.write_file(path, content) or { panic(err) }
}
fn (c &Create) create_git_repo(dir string) {
// Initialize git and add a .gitignore file.
if !os.is_dir('${dir}/.git') {
res := os.execute('git init ${dir}')
if res.exit_code != 0 {
eprintln('')
cerror('unable to initialize a git repository')
exit(4)
}
}
ignore_path := '${dir}/.gitignore'
if os.exists(ignore_path) {
return
}
ignore_content := '# Binaries for programs and plugins
main
${c.name}
*.exe
*.exe~
*.so
*.dylib
*.dll
# Ignore binary output folders
bin/
# Ignore common editor/system specific metadata
.DS_Store
.idea/
.vscode/
*.iml
# ENV
.env
# vweb and database
*.db
*.js
'
os.write_file(ignore_path, ignore_content) or {}
}
fn (mut c Create) create_files_and_directories() {
// Set project template files for `v new` or when no `.v` files exists during `v init`.
if c.new_dir || os.walk_ext('.', '.v').len == 0 {
match c.template {
.bin { c.set_bin_project_files() }
.lib { c.set_lib_project_files() }
.web { c.set_web_project_files() }
}
}
for file in c.files {
os.mkdir_all(os.dir(file.path)) or { panic(err) }
os.write_file(file.path, file.content) or { panic(err) }
}
kind := match c.template {
.bin { 'binary (application)' }
.lib { 'library' }
.web { 'web' }
}
println('Created ${kind} project `${c.name}`')
}