42 lines
975 B
Markdown
42 lines
975 B
Markdown
# Naming convention
|
|
|
|
- [ ] Sequencer internal variables which are only used inside sequencer
|
|
|
|
* lower case
|
|
* prefix `_sqr_`
|
|
|
|
- [ ] Sequencer "global" variables which can be also used in seqs
|
|
|
|
* lower case
|
|
* prefix `sqr_`
|
|
|
|
- [ ] Sequencer provides some global seq related variables
|
|
|
|
* lower case
|
|
* prefix `seq_` or internal use `_seq_`
|
|
|
|
For variables inside seqs it is recommended to be prefixed with `sq_[SEQ SHORT]`
|
|
|
|
e.g. for nextcloud.sh
|
|
`sq_ncinstallDir="/var/www/nextcloud"`
|
|
|
|
For seq configuration variables it is recommended to prefix them with `sc_[SEQ SHORT]`
|
|
|
|
e.g. for nextcloud.cfg(.example)
|
|
`sc_ncinstallDir="/var/www/nextcloud"`
|
|
|
|
# Indentation
|
|
|
|
Sequencer.sh and all seqs use the following indentation rules
|
|
|
|
* indent style: space
|
|
* indent size : 2
|
|
|
|
# Auto indentation
|
|
|
|
Please use the seq `vim.sh setup` to:
|
|
|
|
* configure vim for auto indentation
|
|
* install vim indent script for .sh files
|
|
* install [editorconfig](https://github.com/editorconfig/editorconfig-vim)
|