Assuming you are located inside the directory myproject:

sbt new scalacenter/scalafix.g8
cd scalafix
sbt tests/test

If the repository is available on GitHub through at $USERNAME/myproject then users can run the rule with scalafix --rules github:$USERNAME/myproject/v1.

The v1 part is the name of you rule and can be any string. For example, if the rule contains migration rules for version 8 of your library it's good to call it v8. If the rule is a linter that prohibits vars, the name can be NoVars.

We keep here migration rules used to make easier the upgrade of Scalafix Versions when breaking binary and source compatibilities

• v0.6.x: a migration rule to help the migration to 0.6.x
• v0.9.28: After deprecating SemanticRule and SyntacticRule classes provided by scalafix-testkit, this rule will automatically fix SemanticRule class usage in code sources that still rely on it.

Written in 2020 by Scala Center

To the extent possible under law, the author(s) have dedicated all copyright and related and neighboring rights to this template to the public domain worldwide. This template is distributed without any warranty. See https://creativecommons.org/publicdomain/zero/1.0/.