slack lints

Slack-Lints

Este repositório contém uma coleção de verificações personalizadas do Android/Kotlin Lint que usamos em nossas bases de código Android e Kotlin no Slack.

Enquanto publicamos artefatos no Maven Central, alguns dos fianos podem realmente ser realmente relevantes para a base de código do Slack. Nós os desenvolvemos em aberto ao compartilhamento de conhecimento com a comunidade.

Instalação

Adicione a dependência à configuração lintChecks . Nota para projetos não-Android, você deve aplicar o plug-in com.android.lint gradle para usá-lo.

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

Visão geral

Não zombe

O pacote slack.lint.mocking contém vários detectores e serviços públicos para detectar zombaria de tipos que não devem ser ridicularizados. Isso é semelhante ao DoNotMockChecker do ErrorProne e atua como uma camada de aplicação das APIs e classes anotadas com @DoNotMock . Isso também detecta tipos comuns que nunca devem ser ridicularizados, como classes data Kotlin ou classes de autovalor.

Inclusão

Para escrever um código mais inclusivo, temos uma ferramenta InclusiveNamingChecker para verificar se há uma lista configurável de nomes não inclusivos.

Moshi

MoshiUsageDetector contém uma riqueza de verificações por erros de programador comuns ao escrever aulas para uso com Moshi e Moshix.

Misc

• JavaOnlyDetector - detecta o uso de APIs apenas Java de Kotlin. Com base na implementação original não lançada em verificações Uber/Finchecas.
• DaggerKotlinIssuesDetector - detecta alguns problemas conhecidos ao usar a Dagger no código Kotlin.
• RetrofitUsageDetector - detecta alguns problemas comuns ao usar a retrofit.
• DenyListedApi - detecta o uso de APIs que simplesmente não devem ser usadas.
• MustUseNamedParams - pode ser usado em funções que sempre devem usar parâmetros nomeados. Útil para APIs que possuem muitos parâmetros e/ou podem alterar seu pedido e você deseja manter as alterações compatíveis com a fonte.
• ... e uma infinidade de outros!

Licença

 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.