ember-template-lint/dev/new-rule/templates/doc.md

Linter for Ember or Handlebars templates.

# TODO: rule-name-goes-here

TODO: context about the problem goes here

TODO: what the rule does goes here

## Examples

This rule **forbids** the following:

```hbs
{{!-- TODO: Example 1  --}}
```

```hbs
{{!-- TODO: Example 2  --}}
```

This rule **allows** the following:

```hbs
{{!-- TODO: Example 1  --}}
```

```hbs
{{!-- 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

* [TODO-related-rule-name1](related-rule-name1.md)
* [TODO-related-rule-name2](related-rule-name2.md)

## References

* TODO: link to relevant documentation goes here
* TODO: link to relevant function spec goes here
* TODO: link to relevant guide goes here