Skip to content

NaturalCycles/ktlint

Repository files navigation

@naturalcycles/ktlint

ktlint conveniently published to npm registry

npm code style: prettier ktlint

Current ktlint version: 1.3.1

Quick start

Just run it without installation:

npx @naturalcycles/ktlint --version

Or, install it like this:

yarn add -D @naturalcycles/ktlint

Run ktlint (locally installed into ./node_modules):

yarn ktlint --version

No Step 3!

API

You can run ktlint programmatically via Node.js by calling ktlintAll() function exposed by this module. It returns a Promise (rejects on non-zero code from ktlint, resolves on success).

Development

To update the ktlint version that is shipped here:

  • Check the ktlint release notes
  • Change it in scripts/install.ts to the new version (and in this readme.md too)
  • Delete resources/ktlint
  • Run yarn tsn install, which will download the new version
  • Test it with yarn ktlint --version, it should print the new version
  • Test it with yarn ktlint -F