Skip to content

Commit a13a1dc

Browse files
halotukozakhalotukozak
committed
update Analyzer.md to refine rule description for ImplicitValueClasses
1 parent 7456851 commit a13a1dc

File tree

1 file changed

+21
-21
lines changed

1 file changed

+21
-21
lines changed

‎docs/Analyzer.md

Lines changed: 21 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -16,27 +16,27 @@ and `@nowarn` annotation for warning suppression.
1616

1717
Here's a list of currently supported rules:
1818

19-
| Name | Default level | Description |
20-
|----------------------------|---------------|------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
21-
| `importJavaUtil` | warning | Rejects direct imports of `java.util` package. |
22-
| `valueEnumExhaustiveMatch` | warning | Enables (limited) exhaustive pattern match checking for [`ValueEnum`s](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/misc/ValueEnum.scala). |
23-
| `any2stringadd` | off | Disables `any2stringadd` (concatenating arbitrary values with strings using `+`). |
24-
| `bincompat` | warning | Enables [`@bincompat`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/bincompat.scala) checking |
25-
| `showAst` | error | Handles [`@showAst`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/showAst.scala). |
26-
| `findUsages` | warning | Issues a message for every occurrence of any of the symbols listed in the argument of this rule |
27-
| `varargsAtLeast` | warning | Enables [`@atLeast`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/atLeast.scala) checking |
28-
| `macroPrivate` | warning | Enables [`@macroPrivate`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/macroPrivate.scala) checking |
29-
| `explicitGenerics` | warning | Enables [`@explicitGenerics`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/explicitGenerics.scala) checking |
30-
| `discardedMonixTask` | warning | Makes sure that expressions evaluating to Monix `Task`s are not accidentally discarded by conversion to `Unit` |
31-
| `throwableObjects` | warning | Makes sure that objects are never used as `Throwable`s (unless they have stack traces disabled) |
32-
| `constantDeclarations` | off | Checks if constants are always declared as `final val`s with `UpperCamelCase` and no explicit type annotation for literal values |
33-
| `basePackage` | warning | Checks if all sources are within the specified base package |
34-
| `catchThrowable` | warning | Makes sure that code does not catch `Throwable` directly, which can hide critical errors like `OutOfMemoryError` |
35-
| `finalValueClasses` | warning | Makes sure that value classes are marked final. |
36-
| `finalCaseClasses` | warning | Makes sure that case classes are marked final. Does not affect inner classes due to SI-4440 |
37-
| `implicitParamDefaults` | warning | Makes sure that default values are not defined for implicit parameters |
38-
| `implicitValueClasses` | warning | Makes sure that implicit classes extend `AnyVal` (when applicable). Nested classes check can be enabled by passing the `true` argument. |
39-
| `implicitFunctionParams` | warning | Makes sure that implicit parameters are not function types or partial functions |
19+
| Name | Default level | Description |
20+
|----------------------------|---------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
21+
| `importJavaUtil` | warning | Rejects direct imports of `java.util` package. |
22+
| `valueEnumExhaustiveMatch` | warning | Enables (limited) exhaustive pattern match checking for [`ValueEnum`s](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/misc/ValueEnum.scala). |
23+
| `any2stringadd` | off | Disables `any2stringadd` (concatenating arbitrary values with strings using `+`). |
24+
| `bincompat` | warning | Enables [`@bincompat`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/bincompat.scala) checking |
25+
| `showAst` | error | Handles [`@showAst`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/showAst.scala). |
26+
| `findUsages` | warning | Issues a message for every occurrence of any of the symbols listed in the argument of this rule |
27+
| `varargsAtLeast` | warning | Enables [`@atLeast`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/atLeast.scala) checking |
28+
| `macroPrivate` | warning | Enables [`@macroPrivate`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/macroPrivate.scala) checking |
29+
| `explicitGenerics` | warning | Enables [`@explicitGenerics`](https://github.com/AVSystem/scala-commons/blob/master/commons-core/src/main/scala/com/avsystem/commons/annotation/explicitGenerics.scala) checking |
30+
| `discardedMonixTask` | warning | Makes sure that expressions evaluating to Monix `Task`s are not accidentally discarded by conversion to `Unit` |
31+
| `throwableObjects` | warning | Makes sure that objects are never used as `Throwable`s (unless they have stack traces disabled) |
32+
| `constantDeclarations` | off | Checks if constants are always declared as `final val`s with `UpperCamelCase` and no explicit type annotation for literal values |
33+
| `basePackage` | warning | Checks if all sources are within the specified base package |
34+
| `catchThrowable` | warning | Makes sure that code does not catch `Throwable` directly, which can hide critical errors like `OutOfMemoryError` |
35+
| `finalValueClasses` | warning | Makes sure that value classes are marked final. |
36+
| `finalCaseClasses` | warning | Makes sure that case classes are marked final. Does not affect inner classes due to SI-4440 |
37+
| `implicitParamDefaults` | warning | Makes sure that default values are not defined for implicit parameters |
38+
| `implicitValueClasses` | warning | Makes sure that implicit classes extend `AnyVal` (when applicable). Available options: `top-level-only` (default) - only checks implicit classes in top-level objects; `all` - checks both top-level and nested implicit classes. |
39+
| `implicitFunctionParams` | warning | Makes sure that implicit parameters are not function types or partial functions |
4040

4141
Rules may be enabled and disabled in `build.sbt` with Scala compiler options:
4242

0 commit comments

Comments
 (0)