Hey guys, I’m looking for some recommendations/adv...

# announcements

[mjthornton]

Hey guys, I’m looking for some recommendations/advice!

I’m trying to automate code standards for my project….

First want to do simple things such as:
• Check the top of the file to ensure it has a copyright + specific comment format
• Enforce Kdoc/JavaDoc format for our functions
I would like it to either Flag Bitbucket PR’s or reject builds if they do not comply

I’ve already used File Templates & Live Templates… But this acts more of an aid instead of actually enforcing standards

My current thinking is to use Android Lint and tie it to gradle to fail builds if they don’t comply, but I haven’t really researched this approach yet…
• Starting to read up KTlint

[Sha Sha Chu]

ktlint should be able to handle those, but you'd need to write custom rules.

[Sha Sha Chu]

(I work for Pinterest, who took over maintenance of ktlint)

[Sha Sha Chu]

You can invoke it yourself anytime during the build process and it can either auto correct or just fail

[Sha Sha Chu]

There are a couple popular ktlint Gradle plugins (linked from GitHub) you can use if you like

[mjthornton]

Wow you’re a beast! Thank you

[Sha Sha Chu]

We personally use phabrciator+arc so we invoke it pre-commit during the arc lint process

[mjthornton]

Yes that’d be perfect

[mjthornton]

It’d be annoying to have to add more commits in order to fix issues

[mjthornton]

@Sha Sha Chu For KtLint, I’m trying to detect comments but I can’t find a category under KtNodeTypes that seems to match comments

[mjthornton]

Same with Todo’s… What would that classify as?

[Sha Sha Chu]

in one of our custom rules we check node is PsiComment

[Sha Sha Chu]

and i believe TODO is just a regular kotlin function defined in the stdlib