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

Readme updates: rule compatibilties + fs2 sync compiler instructions #150

Merged
merged 2 commits into from
Nov 6, 2023
Merged

Readme updates: rule compatibilties + fs2 sync compiler instructions #150

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
be3dd79
scala compatibility table
samspills Nov 6, 2023
3e7d028
fs2 sync compiler instructions
samspills Nov 6, 2023
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
19 changes: 19 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,6 +48,19 @@ rules = [
> scalafix TypelevelUnusedIO
```

### Scala compatibility

Not all rules function with Scala 3 yet.

| Rule | 2.13.x | 3.x |
|---------------------------------|--------------------|--------------------|
| TypelevelUnusedIO | :white_check_mark: | :x: |
| TypelevelMapSequence | :white_check_mark: | :white_check_mark: |
| TypelevelAs | :white_check_mark: | :white_check_mark: |
| TypelevelUnusedShowInterpolator | :white_check_mark: | :x: |
| TypelevelFs2SyncCompiler | :white_check_mark: | :x: |
| TypelevelHttp4sLiteralsSyntax | :white_check_mark: | :white_check_mark: |

## Rules for cats

### TypelevelMapSequence
Expand Down Expand Up @@ -144,6 +157,12 @@ IO.println("foo").timeout(50.millis).attemptNarrow[TimeoutException]

This rule detects usages of the fs2 `Sync` compiler which can have surprising semantics with regard to (lack of) interruption (e.g., [typelevel/fs2#2371](https://github.com/typelevel/fs2/issues/2371)).

To use this rule, you'll need to enable synthetics by adding the following to your `build.sbt`:
```scala
ThisBuild / semanticdbOptions += "-P:semanticdb:synthetics:on"
```


**Examples**

```scala
Expand Down