Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/scalameta/scalafmt

Code formatter for Scala
https://github.com/scalameta/scalafmt

formatter scala

Last synced: 1 day ago
JSON representation

Code formatter for Scala

Host: GitHub
URL: https://github.com/scalameta/scalafmt
Owner: scalameta
License: apache-2.0
Created: 2015-11-02T21:34:40.000Z (about 9 years ago)
Default Branch: main
Last Pushed: 2024-10-29T04:14:57.000Z (about 2 months ago)
Last Synced: 2024-10-29T15:05:17.641Z (about 2 months ago)
Topics: formatter, scala
Language: Scala
Homepage: http://scalameta.org/scalafmt
Size: 19.9 MB
Stars: 1,434
Watchers: 29
Forks: 277
Open Issues: 17
Metadata Files:
- Readme: readme.md
- Contributing: CONTRIBUTING.md

Awesome Lists containing this project

README

        # scalafmt

[![Build Status](https://img.shields.io/github/actions/workflow/status/scalameta/scalafmt/ci.yml)](https://github.com/scalameta/scalafmt/actions)

[![Build status](https://ci.appveyor.com/api/projects/status/7gha7cxm5lw8fsc3)](https://ci.appveyor.com/project/olafurpg/scalafmt/branch/master)

[![Join the discord chat](https://img.shields.io/discord/632642981228314653?label=discord)](https://discord.gg/N43mbnH)

[![Latest version](https://index.scala-lang.org/scalameta/scalafmt/scalafmt-core/latest.svg?color=orange&kill_cache=1)](https://index.scala-lang.org/scalameta/scalafmt/scalafmt-core)

### [User documentation][docs]

Head over to [the user docs][docs] for instructions on how to install scalafmt.

### Quick help

- `sbt compile` or `sbt core/compile` (specific project).

- Run all unit tests: `sbt test`

- Run only formatting tests: `tests/testOnly *FormatTests`.

- Write new formatting test: read [this doc](scalafmt-tests/shared/src/test/resources/readme.md).

- Build docs: See instructions on the [site][docs-guide] or locally at `./docs/contributing-website.md`.

- Hack on sbt plugin: run `sbt scripted`.

- Run jmh benchmarks: `./bin/run-benchmarks.sh`.

- Run formatter on millions of lines of code: `tests/test:runMain  org.scalafmt.ScalafmtProps` (slow, and requires a lot of memory/cpu)

- Debug performance: after each test run in `FormatTests`, a flamegraph report

  like [this one](https://github.com/scalameta/scalafmt/issues/140)

  is generated in `target/index.html`. 

  I usually keep a browser tab open at `localhost:3000/target/index.html`

  along with this background process:

  `browser-sync start --server --files "target/*.html"`.

  See [Browsersync](https://www.browsersync.io/).

### Team

The current maintainers (people who can merge pull requests) are:

* Ólafur Páll Geirsson - [`@olafurpg`](https://github.com/olafurpg)

* Pedro J Rodriguez Tavarez - [`@pjrt`](https://github.com/pjrt)

* Iurii Susuk - [`@ysusuk`](https://github.com/ysusuk)

* Paul Draper - [`@pauldraper`](https://github.com/pauldraper)

* Rikito Taniguchi [`@tanishiking`](https://github.com/tanishiking)

* Mikhail Chugunkov [`@poslegm`](https://github.com/poslegm)

An up-to-date list of contributors is available here: https://github.com/scalameta/scalafmt/graphs/contributors

We strive to offer a welcoming environment to learn, teach and contribute.

## Acknowledgements



  

 

[JProfiler](http://www.ej-technologies.com/products/jprofiler/overview.html) generously supports scalafmt with its full-featured Java Profiler.

[docs]: https://scalameta.org/scalafmt/

[docs-guide]: https://scalameta.org/scalafmt/docs/contributing-website.html