Skip to content

Advertise some more compiler plugins #2011

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 5 commits into from
Jul 9, 2021
Merged

Advertise some more compiler plugins #2011

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
b0bd520
Advertise some more compiler plugins
kubukoz May 11, 2021
9aaff97
Remove some non-plugins and outdated plugins
kubukoz May 11, 2021
44a51b2
Add splain, clippy
kubukoz May 11, 2021
ecd4515
Rename better-tostring org
kubukoz May 16, 2021
3d94c2f
Update index.md
kubukoz Jun 2, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions _overviews/plugins/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,7 @@ include:
- Alternate compiler back ends such as [Scala.js](https://www.scala-js.org), [Scala Native](http://scala-native.org), and
[Fortify SCA for Scala](https://developer.lightbend.com/docs/fortify/current/).
- Linters such as [Wartremover](https://www.wartremover.org) and [Scapegoat](https://github.com/sksamuel/scapegoat).
<!-- is this even accurate? scalafmt is not a _compiler_ plugin I think, and scalafix relies on the semanticdb plugin? -->
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I would appreciate some help clarifying this. @tgodzik 🙏 :)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

👍 Scalafix and scalafmt are not compiler plugins. Scalafmt is totally separate entity, while scalafix uses semanticdb.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Removing scalafmt is fine (I had thought it was semanticdb-based, oops!).

Removing scalahost is fine, too.

But it was never my intention to imply, through poor phrasing, that scalafix is a compiler plugin. I wanted to include it because it's so important and because its existence is enabled by semanticdb-scalac, which is a compiler plugin. Not everyone knows what semanticdb is, but everybody knows about scalafix.

Wdyt about the following replacement phrasing:

Plugins that enable tooling. One such plugin is semanticdb-scalac, which enables scalafix (a well-known refactoring and listing tool) to do its work.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Semanticdb is currently mentioned next to Paradise, but I guess I can rephrase it to mention scalafix explicitly ;)

- Plugins that support reformatting and other changes
to source code, such as [scalafix](https://scalacenter.github.io/scalafix/) and [scalafmt](https://scalameta.org/scalafmt/) (which are
built on the [semanticdb](https://scalameta.org/docs/semanticdb/guide.html) and [scalahost](https://github.com/Duhemm/scalahost) compiler plugins).
Expand All @@ -54,6 +55,8 @@ include:
such as the code coverage tool [scoverage](https://github.com/scoverage/scalac-scoverage-plugin).
- Plugins that add metaprogramming facilities to Scala,
such as [Macro Paradise](https://github.com/scalamacros/paradise).
- Plugins that modify existing Scala constructs in user code,
- such as [better-monadic-for](https://github.com/oleg-py/better-monadic-for) and [better-tostring](https://github.com/kubukoz/better-tostring).
- Plugins that add entirely new constructs to Scala by
restructuring user code, such as [scala-continuations](https://github.com/scala/scala-continuations).

Expand Down