github/flutter
7
0
Fork 0
mirror of https://github.com/flutter/flutter.git synced 2025-06-03 00:51:18 +00:00
Code Issues Packages Projects Releases Wiki Activity
master
flutter/docs/platforms/android/Kotlin-android-studio-formatting.md
Gray Mackall 7f5a696d99
Point ktlint AS docs to the .editorconfig that is actually used by ci, instead of making a copy in the README (#165213) 
Points `ktlint` Android Studio setup docs to the `.editorconfig` that is
actually used by ci, instead of making a copy in the README

## Pre-launch Checklist

- [x] I read the [Contributor Guide] and followed the process outlined
there for submitting PRs.
- [x] I read the [Tree Hygiene] wiki page, which explains my
responsibilities.
- [x] I read and followed the [Flutter Style Guide], including [Features
we expect every widget to implement].
- [x] I signed the [CLA].
- [ ] I listed at least one issue that this PR fixes in the description
above.
- [x] I updated/added relevant documentation (doc comments with `///`).
- [x] I added new tests to check the change I am making, or this PR is
[test-exempt].
- [x] I followed the [breaking change policy] and added [Data Driven
Fixes] where supported.
- [x] All existing and new tests are passing.

If you need help, consider asking for advice on the #hackers-new channel
on [Discord].

<!-- Links -->
[Contributor Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#overview
[Tree Hygiene]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md
[test-exempt]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#tests
[Flutter Style Guide]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md
[Features we expect every widget to implement]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Style-guide-for-Flutter-repo.md#features-we-expect-every-widget-to-implement
[CLA]: https://cla.developers.google.com/
[flutter/tests]: https://github.com/flutter/tests
[breaking change policy]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Tree-hygiene.md#handling-breaking-changes
[Discord]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Chat.md
[Data Driven Fixes]:
https://github.com/flutter/flutter/blob/main/docs/contributing/Data-driven-Fixes.md

---------

Co-authored-by: Gray Mackall <mackall@google.com>
2025-03-14 22:35:04 +00:00

1.3 KiB
Raw Permalink Blame History

Setting up Kotlin formatting in Android Studio

Kotlin code in this repository is formatted and linted with ktlint. If you

  1. have submitted Kotlin code only to learn this when the analyzer check fails
  2. use Android Studio

then there is good news! Android Studio can be configured to use ktlint to automatically apply formatting and highlight issues. To do this:

  1. Install the ktlint extension for Android Studio

    a. On Mac, this is Android Studio > Settings > Plugins > Search for ktlint.

  2. Set the ruleset to be the same as the version used in .ci.yaml (as of writing this is 1.5), and the baseline to be dev/bots/test/analyze-test-input/ktlint-baseline.xml.

    a. Both of these options should be available under Android Studio > Settings > Tools > ktlint.

  3. Additionally, Kotlin code in the Flutter repository currently uses some additional rules for compatibility with older versions of Kotlin. These rules can only be configured by an .editorconfig file in the directory from which Android Studio was opened. To configure these rules, create a copy of the .editorconfig that is used by tests in the root directory you intend to open with Android Studio.