@secretlint/secretlint-rule-preset-canary

Canary rule preset of secretlint. Canary means that is experimental.

This preset similar with secretlint-rule-preset-recommend, but it does not base on Semantic Versioning.

In other words, This rule preset always be experimental release. It may introduce breaking change in patch release.

Versioning Policy

• Patch release
  • BREAKING CHANGE
• Minor release
  • BREAKING CHANGE
• Major release
  • BREAKING CHANGE

Install

Install with npm:

npm install @secretlint/secretlint-rule-preset-canary

Usage

Via .secretlintrc.json

{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-preset-canary"
        }
    ]
}

Options

{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-preset-canary",
            // You can override preset default options for each rule
            "rules": [
                {
                     "id": "@secretlint/secretlint-rule-aws",
                     "options": {
                          "allows": ["allowed token"]
                     }
                }
            ]
        }
    ]
}

Notes

This preset module is bundled by Rollup. It is performance reason. Bundled file will reduce loading cost.

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:

npm test

Contributing

Pull requests and stars are always welcome.

For bugs and feature requests, please create an issue.

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
• twitter/azu_re

License

MIT © azu