Skip to content

Latest commit

 

History

History
57 lines (36 loc) · 1.44 KB

_TEMPLATE_.md

File metadata and controls

57 lines (36 loc) · 1.44 KB
Raw

TODO: rule-name-goes-here

(TODO: only include this line if the rule is fixable) 🔧 The --fix option on the command line can automatically fix some of the problems reported by this rule.

TODO: context about the problem goes here

Rule Details

TODO: what the rule does goes here

Examples

Examples of incorrect code for this rule:

// TODO: Example 1
// TODO: Example 2

Examples of correct code for this rule:

// TODO: Example 1
// TODO: Example 2

Migration

TODO: suggest any fast/automated techniques for fixing violations in a large codebase

  • TODO: suggestion on how to fix violations using find-and-replace / regexp
  • TODO: suggestion on how to fix violations using a codemod

Configuration

TODO: exclude this section if the rule has no extra configuration

  • object -- containing the following properties:
    • string -- parameterName1 -- TODO: description of parameter including the possible values and default value
    • boolean -- parameterName2 -- TODO: description of parameter including the possible values and default value

Related Rules

References

  • TODO: link to relevant documentation goes here)
  • TODO: link to relevant function spec goes here
  • TODO: link to relevant guide goes here