slack-lints
This repository contains a collection of custom Android/Kotlin lint checks we use in our Android and
Kotlin code bases at Slack.
This repo is effectively read-only and does not publish artifacts to Maven Central. We develop
these in the open though to knowledge share with the community.
As such, our issue tracker is closed and we don’t normally accept external PRs, but we welcome your
questions in the discussions section of the project!
We may later open source some of these lints. If you’re interested in this, feel free to raise in
a discussions post or vote for existing suggestions.
Highlights
Do Not Mock
The slack.lint.mocking package contains several detectors and utilities for detecting mocking
of types that should not be mocked. This is similar to ErrorProne’s DoNotMockChecker and acts as
an enforcement layer to APIs and classes annotated with @DoNotMock. This also detects common types
that should never be mocked, such as Kotlin data classes or AutoValue classes.
Inclusivity
In order to write more inclusive code, we have an InclusiveNamingChecker tool to check for a
configurable list of non-inclusive names.
Moshi
MoshiUsageDetector contains a wealth of checks for common programmer errors when writing classes
for use with Moshi and MoshiX.
And more!
JavaOnlyDetector– detects use of Java-only APIs from Kotlin. Based on the original unreleased implementation in uber/lint-checks.DaggerKotlinIssuesDetector– detects some known issues when using Dagger in Kotlin code.RetrofitUsageDetector– detects some common issues when using Retrofit.- …and a plethora of others!
License
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.
