slack lints

슬랙 린트

이 저장소에는 Slack의 Android 및 Kotlin Code Base에서 사용하는 맞춤형 Android/Kotlin Lint Checks 모음이 포함되어 있습니다.

우리는 Maven Central에 아티팩트를 게시하지만 일부 린트 검사는 실제로 Slack의 코드베이스와 관련이있을 수 있습니다. 우리는 커뮤니티와의 지식 공유로 개방적으로 개발합니다.

설치

lintChecks 구성에 종속성을 추가하십시오. 참고 비 Android 프로젝트의 경우 com.android.lint Gradle 플러그인을 적용하려면이를 사용해야합니다.

dependencies {
  lintChecks( " com.slack.lint:slack-lint-checks:<version> " )
}

개요

조롱하지 마십시오

slack.lint.mocking 패키지에는 조롱해서는 안되는 유형의 조롱을 감지하기위한 여러 탐지기와 유틸리티가 포함되어 있습니다. 이는 ErrorProne의 DoNotMockChecker 와 유사하며 @DoNotMock 과 주석이 달린 API 및 클래스에 대한 시행 계층 역할을합니다. 또한 Kotlin data 클래스 또는 자동 클래스와 같이 조롱해서는 안되는 일반적인 유형도 감지합니다.

포괄 성

보다 포괄적 인 코드를 작성하려면 포함 할 수없는 이름의 비 포함 이름 목록을 확인하는 InclusiveNamingChecker 도구가 있습니다.

모시

MoshiUsageDetector 에는 Moshi 및 Moshix와 함께 사용하기 위해 수업을 작성할 때 일반적인 프로그래머 오류에 대한 풍부한 수표가 포함되어 있습니다.

기타

• JavaOnlyDetector Kotlin에서 Java 전용 API 사용을 감지합니다. Uber/Lint-Checks의 원래 미공개 구현을 기반으로합니다.
• DaggerKotlinIssuesDetector Kotlin 코드에서 단검을 사용할 때 알려진 몇 가지 문제를 감지합니다.
• RetrofitUsageDetector 개조를 사용할 때 몇 가지 일반적인 문제를 감지합니다.
• DenyListedApi - 사용해서는 안되는 API의 사용을 감지합니다.
• MustUseNamedParams - 항상 명명 된 매개 변수를 사용해야하는 기능에 사용할 수 있습니다. 많은 매개 변수가 있고/또는 순서를 변경할 수 있으며 변경 사항을 소스 호환 상태로 유지하려는 API에 유용합니다.
• ... 그리고 다른 사람들의 과다한!

특허

 Copyright 2021 Slack Technologies, LLC

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.