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

Jump to bottom

Add completion for Rules descriptions in zsh, bash and sbt. #260

Closed
olafurpg opened this issue Jul 18, 2017 · 2 comments · Fixed by #422
Closed

Add completion for Rules descriptions in zsh, bash and sbt. #260

olafurpg opened this issue Jul 18, 2017 · 2 comments · Fixed by #422
Labels
enhancement

Comments

@olafurpg
Copy link
Contributor

It would be helpful to be able to include descriptions of what rewrites do in the docs + --help
jun-19-2017 09-30-49
@olafurpg olafurpg modified the milestone: v0.5 Aug 16, 2017
@olafurpg olafurpg modified the milestone: v0.5 Aug 24, 2017
@olafurpg olafurpg changed the title Rewrites should have descriptions Rules should have descriptions Oct 6, 2017
@olafurpg
Copy link
Contributor Author

olafurpg commented Oct 6, 2017

This can be solved by adding a def description: String = "" (or Option[String], I have no strong preference) method on Rule. The harder part is to display this information in a useful way from the integrations, example zsh tab completion or maybe a scalafixHelp task in the sbt plugin.

ag91 added a commit to ag91/scalafix that referenced this issue Nov 7, 2017
@ag91
Make tests pass.
42ee57f 
Added documentation (scalacenter#260)
@ag91 ag91 mentioned this issue Nov 8, 2017
Merged
ag91 added a commit to ag91/scalafix that referenced this issue Nov 21, 2017
@ag91
Make tests pass.
1dacd0b 
Added documentation (scalacenter#260)
MasseGuillaume pushed a commit to ag91/scalafix that referenced this issue Dec 5, 2017
@ag91 @MasseGuillaume
Add description to Rules (fix scalacenter#260)
0d0678b
@MasseGuillaume MasseGuillaume reopened this Dec 7, 2017
@MasseGuillaume MasseGuillaume changed the title Rules should have descriptions Add completion for Rules descriptions in zsh, bash and sbt. Dec 7, 2017
This was referenced Feb 27, 2018
Merged
Merged
@olafurpg
Copy link
Contributor Author

Fixed in #639 and fixed in #642

bjaglin pushed a commit to liancheng/scalafix that referenced this issue May 23, 2023
@scala-steward
Update scalafmt-core to 3.4.2 (scalacenter#260)
fe3db39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Add descriptions to rules ag91/scalafix
2 participants
@MasseGuillaume @olafurpg