From 7f9c7ff4c4e459563327fcd77fd802fe0c9655c2 Mon Sep 17 00:00:00 2001 From: Michael Rebello Date: Fri, 14 Jun 2019 07:43:52 -0700 Subject: [PATCH] docs: update STYLE.md (#87) Signed-off-by: Michael Rebello Signed-off-by: JP Simard --- mobile/STYLE.md | 21 +++++++++++++++------ 1 file changed, 15 insertions(+), 6 deletions(-) diff --git a/mobile/STYLE.md b/mobile/STYLE.md index e0382a41a7c2..ed313bb1448b 100644 --- a/mobile/STYLE.md +++ b/mobile/STYLE.md @@ -1,13 +1,22 @@ -# Envoy Mobile style guide - ## C++ coding style -* C++ code uses the [Envoy style guide](https://github.com/envoyproxy/envoy/blob/master/STYLE.md) +- C++ code uses the [Envoy style guide](https://github.com/envoyproxy/envoy/blob/master/STYLE.md) +- Code is auto-formatted using `clang-format` with [these rules](./.clang-format) -## Swift coding style +## Java coding style + +- Java code is auto-formatted using `clang-format` with [these rules](./.clang-format) + +## Objective-C coding style -* TODO(rebello95): Fill this in. +- Objective-C code is auto-formatted using `clang-format` with [these rules](./.clang-format) ## Kotlin coding style -* TODO(buildbreaker): Fill this in. +- TODO(buildbreaker): Fill this in after https://github.com/lyft/envoy-mobile/issues/27 + +## Swift coding style + +- Swift code style is validated using [SwiftLint](https://github.com/realm/swiftlint) +- The rules enforced are available in the repo's [.swiftlint.yml file](./.swiftlint.yml) +- The linter may be run locally using `swiftlint` or auto-corrected with `swiftlint autocorrect`