# @secretlint/secretlint-rule-example

An example rule for secretlint. It is for testing.

ALWAYS MATCH "SECRET" string.

## Install

Install with [npm](https://www.npmjs.com/):

    npm install @secretlint/secretlint-rule-example

## MessageIDs

### EXAMPLE_MESSAGE
> found secret: {{ID}}

An example error message.

## Options

- `allows: string[]`
    - Allows a list of [RegExp-like String](https://github.com/textlint/regexp-string-matcher#regexp-like-string)

## Changelog

See [Releases page](https://github.com/secretlint/secretlint/releases).

## Running tests

No Test to avoid Dependency cycles.

## Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, [please create an issue](https://github.com/secretlint/secretlint/issues).

1. Fork it!
2. Create your feature branch: `git checkout -b my-new-feature`
3. Commit your changes: `git commit -am 'Add some feature'`
4. Push to the branch: `git push origin my-new-feature`
5. Submit a pull request :D

## Author

- [github/azu](https://github.com/azu)
- [twitter/azu_re](https://twitter.com/azu_re)

## License

MIT © azu