@secretlint/secretlint-rule-github

A secretlint rule for sendgrid api keys.

Usage no npm install needed!

<script type="module">
  import secretlintSecretlintRuleGithub from 'https://cdn.skypack.dev/@secretlint/secretlint-rule-github';
</script>

README

@secretlint/secretlint-rule-github

A secretlint rule for GitHub.

Install

Install with npm:

npm install @secretlint/secretlint-rule-github

Usage

Via .secretlintrc.json(Recommended)

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

MessageIDs

GITHUB_TOKEN

found GitHub Token({{typeName}}): {{KEY}}

Disallow to write GitHub Token.

ghp_ for Personal Access Tokens
gho_ for OAuth Access tokens
ghu_ for GitHub App user-to-server tokens
ghs_ for GitHub App server-to-server tokens
ghr_ for GitHub App refresh tokens

This rule can detect a new format of GitHub Token.

Authentication token format updates are generally available | GitHub Changelog

Options

allows: string[]
- Allows a list of RegExp-like String

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.

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

Author

License

MIT © azu