@secretlint/secretlint-rule-preset-recommend

Dependencies

Maintainers

Versions

Alerts

File Explorer

Advanced tools

License

Install Socket

Detect and block malicious and high-risk dependencies

Install

@secretlint/secretlint-rule-preset-recommend

Recommended rule preset of secretlint.

8.2.4
Source
npm

Version published: 6 months ago

Weekly downloads: 36K; increased by2.89%

Maintainers: 2

Weekly downloads

Created: 5 years ago

Source

Recommended rule preset for secretlint.

Install

Install with npm:

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

Usage

Via .secretlintrc.json

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

Options

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

If you want to ignore "AWSAccountID" and "AWSAccessKeyID" of "@secretlint/secretlint-rule-aws", you can configure following.

{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-preset-recommend",
      "rules": [
        {
          "id": "@secretlint/secretlint-rule-aws",
          "allowMessageIds": ["AWSAccountID", "AWSAccessKeyID"]
        }
      ]
    }
  ]
}

Rules

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

Import rule tests and update snapshot:

npm run import-test

:memo: It aims to test bundle version

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

Keywords

FAQs

What is @secretlint/secretlint-rule-preset-recommend?

Is @secretlint/secretlint-rule-preset-recommend popular?

Is @secretlint/secretlint-rule-preset-recommend well maintained?

Package last updated on 29 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install