Skip to content

abbenyyyyyy/ktruleset

Repository files navigation

简介

自定义 ktlint 规则.

  1. AndroidLogRule -- 不可使用 android.util.Log 方法.
  2. ExtendBaseRule -- 不可直接继承 Activity()Fragment() DialogFragment()Dialog() , 必须继承 BaseActivityBaseFragmentBaseDialogFragment.
  3. KclassNoteRule -- 继承 BaseActivityBaseFragment 的类必须要有注释.

使用方法

保证项目正常使用 ktlint ;

在项目根目录下的 build.gradle 文件添加 JitPack 仓库

allprojects {
	repositories {
		...
		maven { url 'https://jitpack.io' }
	}
}

在项目根目录下的 app 目录下的 build.gradle 文件引用该仓库 Jar

  ...
  dependencies {
    ...
    ktlint "com.github.abbenyyyyyy:ktruleset:1.0.5"
    ...
  }

在根目录的 .editorconfig 添加 ktlint_language=zh_CN 可以用简体中文输出警告,默认与系统语言一致

...
ktlint_language=zh_CN

构建

git clone https://github.com/abbenyyyyyy/ktruleset.git

需保证系统环境变量 java1.8 能正常使用,使用 Android Studio 打开项目,然后在 Android Studio 里的 File --> Project Structrue 里正确配置 JDK location . 然后执行

./gradlew build

然后你就可以在项目根目录下的 app --> build --> libs 里看到构建的 app.jar .

License

This Source Code Form is subject to the terms of the Mozilla Public License, v. 2.0. If a copy of the MPL was not distributed with this file, You can obtain one at https://mozilla.org/MPL/2.0/.