Skip to content

SwiftLint 0.45.1 adaptation #292

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

SwiftLint 0.45.1 adaptation #292

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 4 additions & 1 deletion xcode/.swiftlint.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -107,12 +107,15 @@ enum_case_associated_values_count:
identifier_name:
excluded:
- id
- to
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Не соглашусь, с этим исключением. from и to как названия переменных не отражают типа своего содержимого.

В случае с примером

func foo(from: Date, to: Date) {
    // code
}

на мой взгляд лучше сделать так:

func foo(from fromDate: Date, to toDate: Date) {
    // code
}

Получается понятно что за переменные и что в себе содержат.

- ok
- URL
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

SwiftLint и так не агрится на такое название, можно удалить

- x
- y
- z

opening_brace:
allow_multiline_func: true
Comment on lines +116 to +117
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ну, единственное что я могу заметить, у нас единственная ссылка на свифт код стайл гайд лежащая вот тут https://github.com/TouchInstinct/Styleguide/blob/90dfb56c398440926c60b619f83be06d5ed2337c/IOS/OnboardingGuide.md#ios-developer-onboarding-letter ведет на гайд от raywenderlich в котором сказано:

  • Method braces and other braces (if/else/switch/while etc.) always open on the same line as the statement but close on a new line.

Поэтому лично мне в целом не критично конечно, но получается некоторое противоречие между линтером и предложеным кодстайлом) Так что этот момент можно было бы обсудить)

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

При этом замечал, что люди часто нарушают пункт оттуда же:

  • There should be no blank lines after an opening brace or before a closing brace.

Пишут так, чтобы разграничить визуально тело функции от заголовка:

func foo(bar: ParameterClosure<WibbleWobbleWubble>,
         baz: @escaping VoidClosure,
         qux: @escaping ParameterClosure<WibbleWobbleWubble>) {

    let keke = 123
    let lele = 123
}

Хотя это куда нагляднее выглядит:

func foo(bar: ParameterClosure<WibbleWobbleWubble>,
         baz: @escaping VoidClosure,
         qux: @escaping ParameterClosure<WibbleWobbleWubble>)
{
    let keke = 123
    let lele = 123
}

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ещё отмечу, что правило срабатывает только в случае многострочных параметров, в остальных случаях линтер перенос убирает, т.е. такого не будет:

func foo(bar: ParameterClosure<WibbleWobbleWubble>) 
{
    // code
}

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ну, вообще есть 2 путя в таком случае:

  1. реквестировать правки код стайла у рея (возможно не дождемся, поскольку некоторые Issues там с 19 года висят)
  2. Сделать свой код стайл с переносами скобок (у нас где-то в стайлгайд репо лежит кстати ссылка на свой код стайл которого нет)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Но опять же, отмечу, стоит это обсудить, прежде чем рубить с плеча)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

При этом замечал, что люди часто нарушают пункт оттуда же:

  • There should be no blank lines after an opening brace or before a closing brace.

Пишут так, чтобы разграничить визуально тело функции от заголовка:

func foo(bar: ParameterClosure<WibbleWobbleWubble>,
         baz: @escaping VoidClosure,
         qux: @escaping ParameterClosure<WibbleWobbleWubble>) {

    let keke = 123
    let lele = 123
}

Хотя это куда нагляднее выглядит:

func foo(bar: ParameterClosure<WibbleWobbleWubble>,
         baz: @escaping VoidClosure,
         qux: @escaping ParameterClosure<WibbleWobbleWubble>)
{
    let keke = 123
    let lele = 123
}

Ну кстати, если уж си шарп стайл не зайдет, может быть есть правило, которое запретит пустую строку после открывающей скобки?


warning_threshold: 1

allow_zero_lintable_files: true
Expand Down
8 changes: 4 additions & 4 deletions xcode/build_phases/swiftlint.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -61,11 +61,11 @@ else
# Если файл существует, то просто его очистим, если нет - создадим
> ${lint_files_path}

# Путь к папке репозитория
path_prefix="`git rev-parse --show-toplevel`/"

# Проходимся по папкам, которые требуют линтовки
for SOURCE_DIR in ${SOURCES_DIRS}; do
# Путь к папке репозитория
path_prefix="`git rev-parse --show-toplevel`/"

# Отбираем файлы, которые были изменены или созданы
source_unstaged_files=$(git diff --diff-filter=d --name-only --line-prefix=${path_prefix} ${SOURCE_DIR} | grep "\.swift$")
source_staged_files=$(git diff --diff-filter=d --name-only --line-prefix=${path_prefix} --cached ${SOURCE_DIR} | grep "\.swift$")
Expand All @@ -81,6 +81,6 @@ else

swiftlint_files_path="@${lint_files_path}"

${SWIFTLINT_EXECUTABLE} autocorrect --path ${swiftlint_files_path} --config ${SWIFTLINT_CONFIG_PATH} --force-exclude --use-alternative-excluding
${SWIFTLINT_EXECUTABLE} --fix --path ${swiftlint_files_path} --config ${SWIFTLINT_CONFIG_PATH} --force-exclude --use-alternative-excluding
${SWIFTLINT_EXECUTABLE} --path ${swiftlint_files_path} --config ${SWIFTLINT_CONFIG_PATH} --force-exclude --use-alternative-excluding
fi