style: code formatting and checks in the CI #1120

azlekov · 2021-10-11T20:06:30Z

New Pull Request Checklist

I am not disclosing a vulnerability.
I am creating this PR in reference to an issue.

Issue Description

Related issue: #1119

Approach

Added Spotless formatter for most types of files in the project (eg. .java, .kt, .xml, .gradle).
Spotless is configured to use ktlint for Kotlin and Google Code Style AOSP for Java.

TODOs before merging

~~Add tests~~
Add changes to documentation (guides, repository pages, in-code descriptions)
A changelog entry is created automatically using the pull request title (do not manually add a changelog entry)

parse-github-assistant · 2021-10-11T20:06:40Z

Thanks for opening this pull request!

🎉 We are excited about your hands-on contribution!

codecov · 2021-10-11T20:49:46Z

Codecov Report

Merging #1120 (7d10d58) into master (dd9a9e6) will increase coverage by 0.21%.
The diff coverage is 65.51%.

@@             Coverage Diff              @@
##             master    #1120      +/-   ##
============================================
+ Coverage     65.06%   65.28%   +0.21%     
- Complexity     2208     2218      +10     
============================================
  Files           122      122              
  Lines          9463     9957     +494     
  Branches       1317     1337      +20     
============================================
+ Hits           6157     6500     +343     
- Misses         2799     2945     +146     
- Partials        507      512       +5

Impacted Files	Coverage Δ
.../src/main/java/com/parse/CacheQueryController.java	`5.76% <0.00%> (-1.05%)`	⬇️
...c/main/java/com/parse/KnownParseObjectDecoder.java	`50.00% <ø> (ø)`
parse/src/main/java/com/parse/Lists.java	`90.00% <ø> (ø)`
parse/src/main/java/com/parse/LocalIdManager.java	`68.00% <0.00%> (ø)`
...arse/src/main/java/com/parse/LocationNotifier.java	`0.00% <0.00%> (ø)`
parse/src/main/java/com/parse/LockSet.java	`0.00% <0.00%> (ø)`
...arse/src/main/java/com/parse/NoObjectsEncoder.java	`75.00% <ø> (ø)`
parse/src/main/java/com/parse/Numbers.java	`19.51% <ø> (ø)`
...rc/main/java/com/parse/OfflineQueryController.java	`100.00% <ø> (ø)`
parse/src/main/java/com/parse/PLog.java	`76.66% <ø> (ø)`
... and 148 more

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update dd9a9e6...7d10d58. Read the comment docs.

azlekov · 2021-10-11T20:57:39Z

@mtrezza this is now done. Pipeline will fail if the source code is not formatting well. I have update the CONTRIBUTING.md so newcomers are guided what to run to eliminate ping-pong. All the source code is formatted to Google AOSP style guide for Java and ktlint for Kotlin.

.github/workflows/ci.yml

azlekov · 2021-10-12T16:58:17Z

@mtrezza whenever your okay and ready feel free to merge.

mtrezza

Looks good!

mobilekosmos · 2021-10-13T23:33:12Z

build.gradle

@@ -13,22 +13,53 @@ buildscript {
        classpath "org.jacoco:org.jacoco.core:$jacocoVersion"
        classpath "com.dicedmelon.gradle:jacoco-android:0.1.5"
        classpath "io.freefair.gradle:android-gradle-plugins:4.2.0-m1"
+        classpath "com.diffplug.spotless:spotless-plugin-gradle:5.16.0"


Do you really need this here if it's already defined as plugin below?

mobilekosmos · 2021-10-13T23:33:38Z

build.gradle


-task clean(type: Delete) {


Why have you removed the clean task?

Spotless which we are using for formatting is defining it.
diffplug/spotless#521

mobilekosmos · 2021-10-13T23:45:43Z

build.gradle

@@ -37,3 +68,13 @@ ext {
    minSdkVersion = 16
    targetSdkVersion = 30
 }
+
+task createSpotlessPreCommitHook() {


This doesn't compile on my end:

Cannot run program "bash": CreateProcess error=2 The system cannot find the file...

mobilekosmos · 2021-10-14T00:17:20Z

Cannot commit in Android Studio after this changes:

Running spotless check > Task :spotlessJava > Task :spotlessJavaApply > Task :spotlessKotlin FAILED Step 'ktlint' found problem in 'ktx\src\main\java\com\parse\ktx\ParseQuery.kt': Error on line: 4, column: 1 Wildcard import java.lang.AssertionError: Error on line: 4, column: 1 Wildcard import at

parseplatformorg · 2021-10-14T18:41:55Z

🎉 This pull request has been released in version 2.0.1

parseplatformorg · 2021-10-14T18:56:18Z

🎉 This pull request has been released in version 2.0.1

parseplatformorg · 2021-10-14T20:02:24Z

🎉 This pull request has been released in version 2.0.1

build.gradle

azlekov added 3 commits October 11, 2021 22:50

Setup spotless formatting

0bb4b54

Pleases Spotless by refactor all the project

5129703

Update the CI

86ecd34

azlekov changed the title ~~Code formatting and checks in the CI~~ style-ci: code formatting and checks in the CI Oct 11, 2021

azlekov changed the title ~~style-ci: code formatting and checks in the CI~~ style: code formatting and checks in the CI Oct 11, 2021

azlekov closed this Oct 11, 2021

azlekov reopened this Oct 11, 2021

mtrezza closed this Oct 11, 2021

mtrezza reopened this Oct 11, 2021

azlekov added 3 commits October 11, 2021 23:40

Add Spotless pre-commit hook

65add0b

Update ci.yaml

77ad9b1

Update ci.yaml

4794453

Update CONTRIBUTING.md

9f8d146

mtrezza reviewed Oct 11, 2021

View reviewed changes

.github/workflows/ci.yml Outdated Show resolved Hide resolved

azlekov added 4 commits October 12, 2021 10:04

Update ci.yaml

9a8c57c

Update ci.yaml

f35a99f

Update ci.yaml

d2e782b

Update ci.yaml

55466bf

azlekov requested a review from mtrezza October 12, 2021 07:25

mtrezza added 2 commits October 12, 2021 13:45

clean ci file

787d0a8

refactored ci file

7d10d58

mtrezza reviewed Oct 12, 2021

View reviewed changes

.github/workflows/ci.yml Show resolved Hide resolved

mtrezza merged commit 2945b30 into parse-community:master Oct 13, 2021

mtrezza reviewed Oct 13, 2021

View reviewed changes

mtrezza mentioned this pull request Oct 13, 2021

Add lint check to CI #1119

Closed

3 tasks

azlekov deleted the issue/1119-add-lint-check-to-ci branch October 13, 2021 12:34

mobilekosmos reviewed Oct 13, 2021

View reviewed changes

This was referenced Oct 14, 2021

createSpotlessPreCommitHook doesn't compile on my end #1125

Closed

Cannot commit in Android Studio after spotless addition #1126

Closed

parseplatformorg added the state:released Released as stable version label Oct 14, 2021

mobilekosmos reviewed Oct 16, 2021

View reviewed changes

build.gradle Show resolved Hide resolved

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

style: code formatting and checks in the CI #1120

style: code formatting and checks in the CI #1120

azlekov commented Oct 11, 2021 •

edited

parse-github-assistant bot commented Oct 11, 2021 •

edited

codecov bot commented Oct 11, 2021 •

edited

azlekov commented Oct 11, 2021

azlekov commented Oct 12, 2021

mtrezza left a comment

mobilekosmos Oct 13, 2021

mobilekosmos Oct 13, 2021

azlekov Oct 13, 2021

mobilekosmos Oct 13, 2021

mobilekosmos commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

style: code formatting and checks in the CI #1120

style: code formatting and checks in the CI #1120

Conversation

azlekov commented Oct 11, 2021 • edited

New Pull Request Checklist

Issue Description

Approach

TODOs before merging

parse-github-assistant bot commented Oct 11, 2021 • edited

Thanks for opening this pull request!

codecov bot commented Oct 11, 2021 • edited

Codecov Report

azlekov commented Oct 11, 2021

azlekov commented Oct 12, 2021

mtrezza left a comment

Choose a reason for hiding this comment

mobilekosmos Oct 13, 2021

Choose a reason for hiding this comment

mobilekosmos Oct 13, 2021

Choose a reason for hiding this comment

azlekov Oct 13, 2021

Choose a reason for hiding this comment

mobilekosmos Oct 13, 2021

Choose a reason for hiding this comment

mobilekosmos commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

parseplatformorg commented Oct 14, 2021

azlekov commented Oct 11, 2021 •

edited

parse-github-assistant bot commented Oct 11, 2021 •

edited

codecov bot commented Oct 11, 2021 •

edited