scalafix.interfaces.ScalafixLintID Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of scalafix-interfaces Show documentation

interfaces

There is a newer version: 2.3.0-RC1

package scalafix.interfaces;

/**
 * A unique identifier for this category of lint diagnostics
 * 
 * The contract of id is that all diagnostics of the same "category" will have the same id.
 * For example, the DisableSyntax rule has a unique ID for each category such as "noSemicolon"
 * or "noTabs".
 */
public interface ScalafixLintID {

    /**
     * @return The name of the rule that produced this diagnostic. For example, "Disable".
     */
    String ruleName();

    /**
     * @return the sub-category within this rule, if any.
     * Empty if the rule only reports diagnostics of a single
     * category. For example, "get" when the full lint ID
     * is "Disable.get".
     */
    String categoryID();

}