Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Backport 1.x] [CODE STYLE] Switch checkstyle to spotless #298

Merged
merged 2 commits into from
Feb 18, 2022
Merged

[Backport 1.x] [CODE STYLE] Switch checkstyle to spotless #298

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
95c4b00
Switch checkstyle to spotless (#297)
jmazanec15 Feb 18, 2022
baac28d
Update ratchetFrom to 1.x
jmazanec15 Feb 18, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 27 additions & 0 deletions DEVELOPER_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,6 +74,33 @@ You can import the OpenSearch project into IntelliJ IDEA as follows.
2. In the subsequent dialog navigate to the root `build.gradle` file
3. In the subsequent dialog select **Open as Project**

## Java Language Formatting Guidelines

Taken from [OpenSearch's guidelines](https://github.com/opensearch-project/OpenSearch/blob/main/DEVELOPER_GUIDE.md):

Java files in the OpenSearch codebase are formatted with the Eclipse JDT formatter, using the [Spotless Gradle](https://github.com/diffplug/spotless/tree/master/plugin-gradle) plugin. The formatting check can be run explicitly with:

./gradlew spotlessJavaCheck

The code can be formatted with:

./gradlew spotlessApply

Please follow these formatting guidelines:

* Java indent is 4 spaces
* Line width is 140 characters
* Lines of code surrounded by `// tag::NAME` and `// end::NAME` comments are included in the documentation and should only be 76 characters wide not counting leading indentation. Such regions of code are not formatted automatically as it is not possible to change the line length rule of the formatter for part of a file. Please format such sections sympathetically with the rest of the code, while keeping lines to maximum length of 76 characters.
* Wildcard imports (`import foo.bar.baz.*`) are forbidden and will cause the build to fail.
* If *absolutely* necessary, you can disable formatting for regions of code with the `// tag::NAME` and `// end::NAME` directives, but note that these are intended for use in documentation, so please make it clear what you have done, and only do this where the benefit clearly outweighs the decrease in consistency.
* Note that JavaDoc and block comments i.e. `/* ... */` are not formatted, but line comments i.e `// ...` are.
* There is an implicit rule that negative boolean expressions should use the form `foo == false` instead of `!foo` for better readability of the code. While this isn't strictly enforced, if might get called out in PR reviews as something to change.

In order to gradually introduce the spotless formatting, we use the
[ratchetFrom](https://github.com/diffplug/spotless/tree/main/plugin-gradle#ratchet) spotless functionality. This makes
it so only files that are changed compared to the origin branch are inspected. Because of this, ensure that your
origin branch is up to date with the plugins upstream when testing locally.

## Build

OpenSearch k-NN uses a [Gradle](https://docs.gradle.org/6.6.1/userguide/userguide.html) wrapper for its build.
Expand Down
18 changes: 3 additions & 15 deletions build.gradle
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ plugins {
id 'nebula.ospackage' version "8.3.0" apply false
id 'idea'
id 'jacoco'
id 'checkstyle'
id "com.diffplug.spotless" version "6.3.0" apply false
}

repositories {
Expand All @@ -47,18 +47,10 @@ repositories {
maven { url "https://plugins.gradle.org/m2/" }
}

apply from: 'gradle/formatting.gradle'
apply plugin: 'opensearch.opensearchplugin'
apply plugin: 'opensearch.rest-test'


checkstyle {
toolVersion = '9.3'
configFile file("checkstyle/checkstyle.xml")
}

checkstyleMain.ignoreFailures = true
checkstyleTest.ignoreFailures = true

def usingRemoteCluster = System.properties.containsKey('tests.rest.cluster') || System.properties.containsKey('tests.cluster')
def usingMultiNode = project.properties.containsKey('numNodes')
// Only apply jacoco test coverage if we are running a local single node cluster
Expand Down Expand Up @@ -94,6 +86,7 @@ jacoco {
toolVersion = "0.8.5"
}

check.dependsOn spotlessCheck
check.dependsOn jacocoTestReport

opensearchplugin {
Expand Down Expand Up @@ -127,11 +120,6 @@ dependencies {
compile group: 'com.google.guava', name: 'guava', version:'30.0-jre'
compile group: 'commons-lang', name: 'commons-lang', version: '2.6'
testImplementation "org.opensearch.test:framework:${opensearch_version}"
configurations.all {
resolutionStrategy {
force "com.puppycrawl.tools:checkstyle:${project.checkstyle.toolVersion}"
}
}
}

licenseHeaders.enabled = true
Expand Down
Loading