Mirrors/mas
2
0
Fork 0
mirror of https://github.com/mas-cli/mas synced 2024-11-22 03:23:08 +00:00
Code Issues Projects Releases Packages Wiki Activity

Improve style.md.

Browse source 
Partial #592

Signed-off-by: Ross Goldberg <484615+rgoldberg@users.noreply.github.com>
This commit is contained in:
Ross Goldberg 2024-10-20 08:05:11 -04:00
parent c2892626d7
commit 57da9e0f51
No known key found for this signature in database
1 changed files with 6 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

13
docs/style.md
View file

@ -5,7 +5,9 @@
- Use `script/lint` to look for these before committing. - Use `script/lint` to look for these before committing.
- Note that [two trailing spaces](https://gist.github.com/shaunlebron/746476e6e7a4d698b373) - Note that [two trailing spaces](https://gist.github.com/shaunlebron/746476e6e7a4d698b373)
is intentional in markdown documents to create a line break like `<br>`, so these should _not_ be removed. is intentional in markdown documents to create a line break like `<br>`, so these should _not_ be removed.
- End each file with a [newline character](https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file#18789). - End each file with a [newline character](
https://unix.stackexchange.com/questions/18743/whats-the-point-in-adding-a-new-line-to-the-end-of-a-file#18789
).
## Swift ## Swift
@ -14,13 +16,13 @@
- Avoid [force unwrapping optionals](https://blog.timac.org/2017/0628-swift-banning-force-unwrapping-optionals/) - Avoid [force unwrapping optionals](https://blog.timac.org/2017/0628-swift-banning-force-unwrapping-optionals/)
with `!` in production code with `!` in production code
- Production code is what gets shipped with the app. Basically, everything under the - Production code is what gets shipped with the app. Basically, everything under the
[`mas-cli/`](https://github.com/mas-cli/mas/tree/main/mas-cli) folder. [`Sources/mas`](https://github.com/mas-cli/mas/tree/main/Sources/mas) folder.
- However, force unwrapping is **encouraged** in tests for less code and tests - However, force unwrapping is **encouraged** in tests for less code and tests
_should_ break when any expected conditions aren't met. _should_ break when any expected conditions aren't met.
- Prefer `struct`s over `class`es wherever possible - Prefer `struct`s over `class`es wherever possible
- Default to marking classes as `final` - Default to marking classes as `final`
- Prefer protocol conformance to class inheritance - Prefer protocol conformance to class inheritance
- Break long lines after 120 characters - Break lines at 120 characters
- Use 4 spaces for indentation - Use 4 spaces for indentation
- Use `let` whenever possible to make immutable variables - Use `let` whenever possible to make immutable variables
- Name all parameters in functions and enum cases - Name all parameters in functions and enum cases
@ -28,10 +30,7 @@ with `!` in production code
- Let the compiler infer the type whenever possible - Let the compiler infer the type whenever possible
- Group computed properties below stored properties - Group computed properties below stored properties
- Use a blank line above and below computed properties - Use a blank line above and below computed properties
- Group methods into specific extensions for each level of access control - Group functions into separate extensions for each level of access control
- When capitalizing acronyms or initialisms, follow the capitalization of the first letter. - When capitalizing acronyms or initialisms, follow the capitalization of the first letter.
- When using `Void` in function signatures, prefer `()` for arguments and `Void` for return types. - When using `Void` in function signatures, prefer `()` for arguments and `Void` for return types.
- Prefer strong `IBOutlet` references.
- Avoid evaluating a weak reference multiple times in the same scope. Strongify first, then use the strong reference. - Avoid evaluating a weak reference multiple times in the same scope. Strongify first, then use the strong reference.
- Prefer to name `IBAction` and target/action methods using a verb describing the action it will trigger, instead
of the user action (e.g., `edit:` instead of `editTapped:`)