lot's of standardizing with the refacto
This commit is contained in:
@@ -50,3 +50,60 @@ of precedence: `syspkgs`, `flatpkgs`, `snappkgs`, `appimages`.
|
||||
|
||||
In that order, `syspkgs` and `caskpkgs` have equal weight, as it applies
|
||||
to macOS.
|
||||
|
||||
## Formatting rules
|
||||
|
||||
- Use indentation explicitness. Lists should be indented:
|
||||
|
||||
```yaml
|
||||
# Good
|
||||
my_good_list:
|
||||
- my_list_item
|
||||
|
||||
# Bad
|
||||
my_bad_list:
|
||||
- my_list_item
|
||||
```
|
||||
|
||||
- Variables should be in snake case, separating words
|
||||
- Short names are fine if they are explicit. ie `vers` can be used instead of `version`
|
||||
- If more then one variable starts with the same words, put it into a dict if it makes sense:
|
||||
|
||||
```yaml
|
||||
# variables that should be a dict
|
||||
cargo_locked: true
|
||||
cargo_pkg: alacritty
|
||||
|
||||
# better to just be
|
||||
cargo:
|
||||
locked: true
|
||||
pkg: alacritty
|
||||
```
|
||||
- Tasks **MUST** follow the convention in this example:
|
||||
|
||||
```yaml
|
||||
- name: Capitalize first letter of name
|
||||
when:
|
||||
- each condition has it's own line
|
||||
- (brackets around conditions with) or
|
||||
(to show they are separate)
|
||||
become: "{{ not use_local }}" # must be able to be used with use_local
|
||||
become_user: # this should not be needed, but always follows become if it is
|
||||
loop: "{{ my_loopable_list }}"
|
||||
loop_control: # **MUST** always use at least loop_var for any loop
|
||||
loop_var: my_item
|
||||
ansible.builtin.set_fact: # always use the full module name
|
||||
...
|
||||
```
|
||||
|
||||
- `name`: Every task needs a name, and the first letter must be capitalized
|
||||
- `when`: If a when clause exists, it follows the name
|
||||
- Each clause must have it's own line, including and `or` clause, as seen above
|
||||
- `become`: must follow the when clause if it exists, name otherwise
|
||||
- Any other `become_` settings follow `become` in alphabetical order
|
||||
- `loop`: must be defined just before the module invocation
|
||||
- Every loop needs to rename the `loop_var` to something that makes sense
|
||||
- `until` is consider the same as `loop` for the purposes of placement
|
||||
- The last item must be the module invocation, using the fully qualified name
|
||||
- For example, don't use `set_fact:`, use `ansible.builtin.set_fact:`
|
||||
|
||||
|
||||
Reference in New Issue
Block a user