Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rickbusarow/ktrules
https://github.com/rickbusarow/ktrules
Last synced: about 22 hours ago
JSON representation
- Host: GitHub
- URL: https://github.com/rickbusarow/ktrules
- Owner: rickbusarow
- License: apache-2.0
- Created: 2023-03-26T01:10:43.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2025-01-16T11:31:27.000Z (9 days ago)
- Last Synced: 2025-01-18T20:48:35.087Z (7 days ago)
- Language: Kotlin
- Size: 878 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 30
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
[](https://search.maven.org/search?q=com.rickbusarow.ktrules)
[](https://oss.sonatype.org/#nexus-search;quick~com.rickbusarow.ktrules)
[](https://opensource.org/licenses/Apache-2.0)
# ktrules
**ktrules** is a collection of KtLint rules designed to improve the quality, consistency, and
readability of Kotlin code.
The rules in ktrules cover a wide range of coding styles and best practices, from formatting and
indentation to naming conventions and documentation. Some of the specific areas covered by the rules
include:
## Rules
```editorconfig
# KtLint specific settings
# noinspection EditorConfigKeyCorrectness
[{*.kt,*.kts}]
ktlint_kt-rules_kdoc-blank-lines = enabled
ktlint_kt-rules_kdoc-collapse = enabled
ktlint_kt-rules_kdoc-content-wrapping = enabled
ktlint_kt-rules_kdoc-indent-after-leading-asterisk = enabled
ktlint_kt-rules_kdoc-leading-asterisk = enabled
ktlint_kt-rules_kdoc-tag-order = enabled
ktlint_kt-rules_kdoc-tag-param-or-property = enabled
ktlint_kt-rules_no-duplicate-copyright-header = enabled
ktlint_kt-rules_no-gradle-with-type-with-lambda = enabled
ktlint_kt-rules_no-leading-blank-lines = enabled
ktlint_kt-rules_no-since-in-kdoc = enabled
ktlint_kt-rules_no-space-in-annotation-with-target = enabled
ktlint_kt-rules_no-trailing-space-in-raw-string-literal = enabled
ktlint_kt-rules_no-useless-constructor-keyword = enabled
kt-rules_project_version = 1.0.0
kt-rules_wrapping_style = equal
[{*.kt,*.kts}]
# actual kotlin settings go here
```
| Rule | Description |
| :---------------------------------------: | :----------------------------------------------------------------------------------------------------------------------------------------: |
| `kdoc-blank-lines` | ensures that there are no consecutive or extraneous blank lines within a KDoc comment's content |
| `kdoc-collapse` | collapses short KDoc comments into a single line, like `/** my comment */` |
| `kdoc-content-wrapping` | ensures consistent wrapping of KDoc comments to improve readability |
| `kdoc-indent-after-leading-asterisk` | ensures that there's a space after every leading asterisk in a KDoc comment, except for blank lines |
| `kdoc-leading-asterisk` | ensures that the leading asterisk in a KDoc comment is followed by a space |
| `kdoc-tag-order` | sorts KDoc tags by their declaration order in the class or function |
| `kdoc-tag-param-or-property` | ensures that KDoc tags use `@property` for vals or vars, and `@param` for non-property parameters. |
| `no-duplicate-copyright-header` | ensures that each file has only one copyright header |
| `no-leading-blank-lines` | ensures that there are no leading blank lines in files |
| `no-gradle-with-type-with-lambda` | nsures calls to Gradle's `withType(...)` use `configureEach { }` for the lambda. |
| `no-since-in-kdoc` | ensures that there is no @since tag in KDoc comments |
| `no-space-in-annotation-with-target` | ensures that targeted annotations (annotations with a target specifier such as @get:, @set:, etc.) have no space before or after the colon |
| `no-trailing-space-in-raw-string-literal` | ensures that there are no trailing spaces in raw string literals |
| `no-useless-constructor-keyword` | removes the unnecessary constructor keyword from class constructors |
## Gradle Usage
To use ktrules in your project, follow the documentation for your existing integration solution
using third-party extensions. Typically, your plugin or custom tasks will have a Gradle
configuration named `ktlint`.
In order to maintain compatibility with older versions of KtLint, KtRules publishes different
artifacts which rely upon the different KtLint api versions. You should choose only one of these
artifacts corresponding to the KtLint version your project is using.
```kotlin
// build.gradle.kts
dependencies {
// Using the current KtLint (1.3.1) apis
ktlint("com.rickbusarow.ktrules:ktrules:1.4.0")
// ... or using the KtLint 1.1.x apis
ktlint("com.rickbusarow.ktrules:ktrules-110:1.4.0")
// ... or using the KtLint 1.0.x apis
ktlint("com.rickbusarow.ktrules:ktrules-100:1.4.0")
// ... or using the KtLint 0.50.x apis
ktlint("com.rickbusarow.ktrules:ktrules-50:1.4.0")
// ... or using the KtLint 0.49.x apis
ktlint("com.rickbusarow.ktrules:ktrules-49:1.4.0")
// ... or using the KtLint 0.48.x apis
ktlint("com.rickbusarow.ktrules:ktrules-48:1.4.0")
// ... or using the KtLint 0.47.x apis
ktlint("com.rickbusarow.ktrules:ktrules-47:1.4.0")
}
```
## `@since` tags
The `NoSinceInKDocRule` must know your project's current version in order to automatically add tags.
It can read that version from an editorconfig property named `project_version` or a System property
named `ktrules.project_version`.
This can be set inside your KtLint task's configuration. For example, if the version is defined
inside `libs.versions.toml` it would look like this:
```kotlin
tasks.withType {
// set the project's version as a System property so that it can be read by NoSinceInKDocRule
System.getProperties()
.setIfAbsent("ktrules.project_version") { libs.versions.currentVersion.get() }
}
fun java.util.Properties.setIfAbsent(name: String, value: () -> String) {
if (getProperty(name) == null) {
setProperty(name, value())
}
}
```
## Contributing
If you'd like to contribute to ktrules, please submit a pull request with your changes. Bug reports
or new rule requests are also welcome in the issue tracker.
### License
```text
Copyright (C) 2023 Rick Busarow
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
https://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.
```