The great rename #326
Merged
The great rename #326
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Contributor
olafurpg
commented
Sep 6, 2017
olafurpg
commented
- s/Rewrite/Rule/ A mostly backwards source and binary compatible API will remain throughout v0.5. Fixes Rename Rewrite to Checker/Rule? #293
- s/ExplicitReturnTypes/ExplicitResultTypes/
- no more implicit macro magic to infer rule names, they must be provided explicitly from now on.
This setup is more verbose but it's less magic.
This is more appropriate scala lingo, according to Seb.
This was about time.
This scheme involves less boilerplate for rule authors.
Turns out the tests from NoValInForComprehension were still using the old .source testing system.
gabro
reviewed
Sep 6, 2017
CONTRIBUTING.md
Outdated
| @@ -3,7 +3,7 @@ Contributing | |||
|
|
|||
| ## Modules | |||
|
|
|||
| - `scalafix-core/` the rewrite rules | |||
| - `scalafix-core/` data structures and algorithms for scalafix rules (linters/checkers/rewrites/fixes) | |||
There was a problem hiding this comment.
linters/checkers/rewrites/fixes?
gabro
requested changes
Sep 6, 2017
readme/Configuration.scalatex
Outdated
| you can load it with the @code{https:} or @code{http:} protocol | ||
| @config | ||
| rewrite = "https://gist.githubusercontent.com/olafurpg/fc6f43a695ac996bd02000f45ed02e63/raw/dfce7784d61dffda183a582b9a1750399c2c465b/ExampleRewrite.scala" | ||
| rule = "https://gist.githubusercontent.com/olafurpg/fc6f43a695ac996bd02000f45ed02e63/raw/f96587ec5afe8ed139b2c543c65a417dcafca79e/ExampleRewrite.scala" |
There was a problem hiding this comment.
Can you rename the file on gist to ExampleRule?
readme/Rules.scalatex
Outdated
| @config | ||
| explicitReturnTypes.memberKind = [Val, Def, Var] | ||
| explicitReturnTypes.memberVisibility = [Public, Protected] | ||
| // Experimental, shorten fully qualified names and insert missing imports | ||
| // By default, names are fully qualified and prefixed with _root_. | ||
| unsafeShortenNames = true // false by default. | ||
|
|
||
| @sect{ExplicitReturnTypes} | ||
| This rewrite has been renamed into @sect.ref{ExplicitResultTypes} |
There was a problem hiding this comment.
Old habit, wrote it after running sed replace. Fixed.
| import metaconfig.ConfDecoder | ||
| import metaconfig.Configured | ||
|
|
||
| /** A Scalafix Rule is a checker/linter/rewrite/auto-fixer. |
There was a problem hiding this comment.
same as above, this checker/linter/rewrites/whatever is a bit confusing.
|
|
||
| /** A Scalafix Rule is a checker/linter/rewrite/auto-fixer. | ||
| * | ||
| * To implement a rewrite/auto-fixer, override the `fix` method. Example: |
There was a problem hiding this comment.
Maybe
To provide an automatic fix for this rule, ...
There was a problem hiding this comment.
Good suggestion, done.
| * } | ||
| * }}} | ||
| * | ||
| * To implement a linter/checker, override the `check` method. Example: |
There was a problem hiding this comment.
same as above, I would pick a name and stick to it instead of providing alternatives linter/checker
There was a problem hiding this comment.
Agreed, went with "To report violations of this rule (without automatic fix)"
olafurpg
commented
Sep 6, 2017
CONTRIBUTING.md
Outdated
| @@ -3,7 +3,7 @@ Contributing | |||
|
|
|||
| ## Modules | |||
|
|
|||
| - `scalafix-core/` the rewrite rules | |||
| - `scalafix-core/` data structures and algorithms for scalafix rules (linters/checkers/rewrites/fixes) | |||
readme/Rules.scalatex
Outdated
| @config | ||
| explicitReturnTypes.memberKind = [Val, Def, Var] | ||
| explicitReturnTypes.memberVisibility = [Public, Protected] | ||
| // Experimental, shorten fully qualified names and insert missing imports | ||
| // By default, names are fully qualified and prefixed with _root_. | ||
| unsafeShortenNames = true // false by default. | ||
|
|
||
| @sect{ExplicitReturnTypes} | ||
| This rewrite has been renamed into @sect.ref{ExplicitResultTypes} |
There was a problem hiding this comment.
Old habit, wrote it after running sed replace. Fixed.
| import metaconfig.ConfDecoder | ||
| import metaconfig.Configured | ||
|
|
||
| /** A Scalafix Rule is a checker/linter/rewrite/auto-fixer. |
|
|
||
| /** A Scalafix Rule is a checker/linter/rewrite/auto-fixer. | ||
| * | ||
| * To implement a rewrite/auto-fixer, override the `fix` method. Example: |
There was a problem hiding this comment.
Good suggestion, done.
| * } | ||
| * }}} | ||
| * | ||
| * To implement a linter/checker, override the `check` method. Example: |
There was a problem hiding this comment.
Agreed, went with "To report violations of this rule (without automatic fix)"
gabro
approved these changes
Sep 6, 2017
|
|
🎆
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.