@secretlint/secretlint-rule-github
TypeScript icon, indicating that this package has built-in type declarations

8.2.3 • Public • Published

@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
  • github_pat_ for fine-grained personal access tokens

This rule can detect a new format of GitHub Token.

Options

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

License

MIT © azu

/@secretlint/secretlint-rule-github/

    Package Sidebar

    Install

    npm i @secretlint/secretlint-rule-github

    Weekly Downloads

    7,882

    Version

    8.2.3

    License

    MIT

    Unpacked Size

    15.7 kB

    Total Files

    8

    Last publish

    Collaborators

    • secretlint-bot
    • azu