mirror/v
1
0
Fork 0
mirror of https://github.com/vlang/v.git synced 2023-08-10 21:13:21 +03:00
Code Issues Projects Releases Wiki Activity

doc: improve the cross-platform shell scripts documentation

Browse Source
This commit is contained in:
Hugo Locurcio 2020-03-10 14:23:55 +01:00 committed by GitHub
parent c9d30f78b7
commit baf25fe649
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 12 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
doc/docs.md
View File

@ -1558,10 +1558,15 @@ V can be used as an alternative to Bash to write deployment scripts, build scrip
The advantage of using V for this is the simplicity and predictability of the language, and The advantage of using V for this is the simplicity and predictability of the language, and
cross-platform support. "V scripts" run on Unix-like systems as well as on Windows. cross-platform support. "V scripts" run on Unix-like systems as well as on Windows.
Use .vsh file extension. It will make all functions in the `os` Use the `.vsh` file extension. It will make all functions in the `os`
module global (so that you can use `ls()` instead of `os.ls()`, for example). module global (so that you can use `ls()` instead of `os.ls()`, for example).
```v ```v
#!/usr/local/bin/v run
// The shebang above associates the file to V on Unix-like systems,
// so it can be run just by specifying the path to the file
// once it's made executable using `chmod +x`.
rm('build/*') rm('build/*')
// Same as: // Same as:
for file in ls('build/') { for file in ls('build/') {
@ -1579,10 +1584,13 @@ for file in ls('.') {
Now you can either compile this like a normal V program and get an executable you can deploy and run Now you can either compile this like a normal V program and get an executable you can deploy and run
anywhere: anywhere:
`v deploy.v && ./deploy` `v deploy.vsh && ./deploy`
Or just run it more like a traditional bash script: Or just run it more like a traditional Bash script:
`v run deploy.v` `v run deploy.vsh`
On Unix-like platforms, the file can be run directly after making it executable using `chmod +x`:
`./deploy.vsh`
## Appendix I: Keywords ## Appendix I: Keywords