Skip to content
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

advertize amm/cs-friendly syntax for dependency: #1542

Closed
wants to merge 1 commit into from
Closed

advertize amm/cs-friendly syntax for dependency: #1542

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion docs/developers/tutorial.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -711,7 +711,7 @@ Once published, users can run your rule with the following sbt command.

```sh
// sbt shell
> scalafix dependency:NamedLiteralArguments@ch.epfl.scala:named-literal-arguments:VERSION
> scalafix dependency:NamedLiteralArguments@ch.epfl.scala::named-literal-arguments:VERSION
```

To permanently install the rule for a build, users can add the dependency to
Expand Down
30 changes: 15 additions & 15 deletions docs/rules/community-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,11 @@ rewriting the code when possible.

| Repository | Artifact | Description |
| - | - | - |
[ghostbuster91/scalafix-unified](https://github.com/ghostbuster91/scalafix-unified) | `io.github.ghostbuster91.scalafix-unified:unified` | Set of opinionated rules to unify your codebase
[jatcwang/scalafix-named-params](https://github.com/jatcwang/scalafix-named-params) | `com.github.jatcwang:scalafix-named-params` | Add named parameters for your constructor and method calls
[liancheng/scalafix-organize-imports](https://github.com/liancheng/scalafix-organize-imports) | `com.github.liancheng:organize-imports` | Help you organize Scala import statements
[vovapolu/scaluzzi](https://github.com/vovapolu/scaluzzi) | `com.github.vovapolu:scaluzzi` | Ensure a subset of [scalazzi](http://yowconference.com.au/slides/yowwest2014/Morris-ParametricityTypesDocumentationCodeReadability.pdf)
[xuwei-k/scalafix-rules](https://github.com/xuwei-k/scalafix-rules) | `com.github.xuwei-k:scalafix-rules` | Avoid ambiguous or redundant Scala syntax & features
[ghostbuster91/scalafix-unified](https://github.com/ghostbuster91/scalafix-unified) | `io.github.ghostbuster91.scalafix-unified::unified` | Set of opinionated rules to unify your codebase
[jatcwang/scalafix-named-params](https://github.com/jatcwang/scalafix-named-params) | `com.github.jatcwang::scalafix-named-params` | Add named parameters for your constructor and method calls
[liancheng/scalafix-organize-imports](https://github.com/liancheng/scalafix-organize-imports) | `com.github.liancheng::organize-imports` | Help you organize Scala import statements
[vovapolu/scaluzzi](https://github.com/vovapolu/scaluzzi) | `com.github.vovapolu::scaluzzi` | Ensure a subset of [scalazzi](http://yowconference.com.au/slides/yowwest2014/Morris-ParametricityTypesDocumentationCodeReadability.pdf)
[xuwei-k/scalafix-rules](https://github.com/xuwei-k/scalafix-rules) | `com.github.xuwei-k::scalafix-rules` | Avoid ambiguous or redundant Scala syntax & features

## Migration rules

Expand All @@ -37,12 +37,12 @@ for the service.

| Repository | Artifact | Description |
| - | - | - |
[ohze/scala-rewrites](https://github.com/ohze/scala-rewrites) | `com.sandinh:scala-rewrites` | Rewrites for Scala
[OlegYch/enumeratum-scalafix](https://github.com/OlegYch/enumeratum-scalafix) | `io.github.olegych:enumeratum-scalafix` | Replace `scala.Enumeration` with enumeratum
[scala/scala-collection-compat](https://github.com/scala/scala-collection-compat) | `org.scala-lang.modules:scala-collection-migrations` | Rewrite upgrades to the 2.13 collections
[scala/scala-rewrites](https://github.com/scala/scala-rewrites) | `org.scala-lang:scala-rewrites` | Rewrites for Scala
[xuwei-k/play-ws-scalafix](https://github.com/xuwei-k/play-ws-scalafix) | `com.github.xuwei-k:play-ws-scalafix` | Migrate to play-ws-standalone
[xuwei-k/replace-symbol-literals](https://github.com/xuwei-k/replace-symbol-literals) | `com.github.xuwei-k:replace-symbol-literals` | Replace deprecated scala.Symbol literals `s/'foo/Symbol("foo")/`
[ohze/scala-rewrites](https://github.com/ohze/scala-rewrites) | `com.sandinh::scala-rewrites` | Rewrites for Scala
[OlegYch/enumeratum-scalafix](https://github.com/OlegYch/enumeratum-scalafix) | `io.github.olegych::enumeratum-scalafix` | Replace `scala.Enumeration` with enumeratum
[scala/scala-collection-compat](https://github.com/scala/scala-collection-compat) | `org.scala-lang.modules::scala-collection-migrations` | Rewrite upgrades to the 2.13 collections
[scala/scala-rewrites](https://github.com/scala/scala-rewrites) | `org.scala-lang::scala-rewrites` | Rewrites for Scala
[xuwei-k/play-ws-scalafix](https://github.com/xuwei-k/play-ws-scalafix) | `com.github.xuwei-k::play-ws-scalafix` | Migrate to play-ws-standalone
[xuwei-k/replace-symbol-literals](https://github.com/xuwei-k/replace-symbol-literals) | `com.github.xuwei-k::replace-symbol-literals` | Replace deprecated scala.Symbol literals `s/'foo/Symbol("foo")/`

## Code generation rules

Expand All @@ -51,7 +51,7 @@ by taking a route similar, yet parallel to macros.

| Repository | Artifact | Description |
| - | - | - |
[earldouglas/linear-scala](https://github.com/earldouglas/linear-scala) | `com.earldouglas:linear-scala-scalafix` | Add support for linear types in Scala
[rtimush/zio-magic-comments](https://github.com/rtimush/zio-magic-comments) | `com.timushev:zio-magic-comments` | Add explanatory graphs as comments to zio-magic methods
[sake92/kalem](https://github.com/sake92/kalem) | `ba.sake:kalem-rules` | Generate `with*` methods for classes
[typelevel/simulacrum-scalafix](https://github.com/typelevel/simulacrum-scalafix) | `org.typelevel:simulacrum-scalafix-annotations` | Simulacrum as Scalafix rules
[earldouglas/linear-scala](https://github.com/earldouglas/linear-scala) | `com.earldouglas::linear-scala-scalafix` | Add support for linear types in Scala
[rtimush/zio-magic-comments](https://github.com/rtimush/zio-magic-comments) | `com.timushev::zio-magic-comments` | Add explanatory graphs as comments to zio-magic methods
[sake92/kalem](https://github.com/sake92/kalem) | `ba.sake::kalem-rules` | Generate `with*` methods for classes
[typelevel/simulacrum-scalafix](https://github.com/typelevel/simulacrum-scalafix) | `org.typelevel::simulacrum-scalafix-annotations` | Simulacrum as Scalafix rules
4 changes: 2 additions & 2 deletions docs/rules/external-rules.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,12 +12,12 @@ One method is to run rule dynamically with the following sbt command.

```sh
// sbt shell
> scalafix dependency:RULE@GROUP:ARTIFACT:VERSION
> scalafix dependency:RULE@GROUP::ARTIFACT:VERSION
```

Each parts stands for the following.
* `RULE`: A name of rule to be performed.
* `@GROUP:ARTIFACT:VERSION`: An id to specify a dependency containing rules.
* `@GROUP::ARTIFACT:VERSION`: An id to specify a dependency containing rules.

To permanently install the rule for a build, users can add the dependency to
`build.sbt` by updating `ThisBuild / scalafixDependencies`.
Expand Down