open-index/open-npm huggingface dataset:
npm package: @secretlint/messages-to-markdown
Description: Create Markdown text from rule's messages(ids)
Author: azu
Latest version: 11.6.0

# @secretlint/messages-to-markdown

Create Markdown text from rule&#39;s messages(ids)

## Install

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

    npm install @secretlint/messages-to-markdown

## Usage

    Usage
      $ npx @secretlint/messages-to-markdown [index.js|index.ts]
 
    Options
 
    Examples
      $ snpx @secretlint/messages-to-markdown src/index.ts

## Changelog

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

## 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](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
npm package: @secretlint/node
Description: Secretlint client library for Node.js
Author: azu
Latest version: 11.6.0

# @secretlint/node

Secretlint client library for Node.js.

An engine handles

- Read files and Lint these and Output results
    - IO and Core and Formatter

## Install

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

    npm install @secretlint/node

## Usage

```js
import { createEngine } from "@secretlint/node";
(async () => {
    const engine = await createEngine({
        color: false,
        cwd: path.join(__dirname, "fixtures/valid-config"),
        formatter: "stylish"
    });
    const output = await engine.executeOnFiles({ filePathList: [path.join(__dirname, "fixtures/SECRET.txt")] });
    console.log(output); /*
[TEST_DIR]/fixtures/SECRET.txt
1:8  warning  found secret: SECRET  example

✖ 1 problem (0 errors, 1 warning)
*/
})();
```

## Changelog

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

## 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](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
npm package: @secretlint/profiler
Description: Profile manager for Secretlint.
Author: azu
Latest version: 11.6.0

# @secretlint/profiler

Profile manager for Secretlint.

## Install

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

    npm install @secretlint/profiler

## Usage

- [ ] Write usage instructions

## Changelog

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

## 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](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
npm package: @secretlint/quick-start
Description: Quick Stater CLI for secretlint.
Author: azu
Latest version: 11.6.0

# @secretlint/quick-start

Quick Stater CLI for secretlint.

This package for Quick Start. It is not production use.

## Features

- No Configuration
- Built-in rules
    - [@secretlint/secretlint-rule-preset-recommend](https://www.npmjs.com/package/@secretlint/secretlint-rule-preset-recommend)

## Install & Usage

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

    npx @secretlint/quick-start "**/*"

## Internal

It is a wrapper of `secretlint` package and built-in some rules.
It aim to work without configuration by design.
So, It does not aim to get flexibility.

## Changelog

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

## 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](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
npm package: @secretlint/resolver
Description: Module Resolver Utility for Secretlint
Author: azu
Latest version: 11.6.0

# @secretlint/resolver

Resolver/Dynamic Import helper for SecretLint

## Install

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

    npm install @secretlint/resolver

## Feature

- Try to resolve package name to file path
- Resolver/Import Hooks
  - Binary Compiler use this hooks to resolve dynamic import as statically

## Changelog

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

## 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](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
npm package: @secretlint/secretlint-formatter-sarif
Description: A secretlint formatter for SARIF format
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-formatter-sarif

A secretlint formatter for SARIF format

## Install

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

    npm install @secretlint/secretlint-formatter-sarif

## Usage

```
npm install @secretlint/secretlint-formatter-sarif --save-dev
secretlint --format @secretlint/secretlint-formatter-sarif "**/*"
# output as sarif format
```

## Changelog

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

## 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](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

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

## License

MIT © azu
npm package: @secretlint/secretlint-rule-1password
Description: A secretlint rule for 1password
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-1password

An example rule for secretlint.

## Install

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

    npm install @secretlint/secretlint-rule-1password

## MessageIDs

### OPS_TOKEN
> found 1Password Service Account token: {token}

1Password Service Account token was found.
This token is used for 1Password CLI.
It should be treated as a secret.

- [1Password Service Account security | 1Password Developer](https://developer.1password.com/docs/service-accounts/security/)

## 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

## License

MIT © azu
npm package: @secretlint/secretlint-rule-anthropic
Description: A secretlint rule for detecting Anthropic Claude API keys
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-anthropic

A rule for detecting Anthropic Claude API keys in your code.

## Install

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

    npm install @secretlint/secretlint-rule-anthropic

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-anthropic"
        }
    ]
}
```

## MessageIDs

### ANTHROPIC_API_KEY

Anthropic Claude API key is detected.

**NG** examples:

```
sk-ant-api03-R2D2C3P0BEEP_BOOP_BUZZ_WHIRR_CLICK_SPIN_TURN_JUMP_SKIP_HOP_DANCE_SING_PLAY_WORK_LEARN_GROW_LOVE_LIVEigAA
```

## 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

## License

MIT © azu
npm package: @secretlint/secretlint-rule-aws
Description: A secretlint rule for AWS.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-aws

A secretlint rule for AWS.

## Install

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

    npm install @secretlint/secretlint-rule-aws

## Usage

Via `.secretlintrc.json`

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-aws"
        }
    ]
}
```

## MessageIDs

### AWSAccountID
> found AWS Account ID: {{ID}}

[git-secrets](https://github.com/awslabs/git-secrets) detect it as secret.

### AWSSecretAccessKey
> found AWS Secret Access Key: {{KEY}}

AWS's Access key is credential data. It should be private.

- https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html 

### AWSAccessKeyID
> found AWS Access Key ID: {{ID}}

[git-secrets](https://github.com/awslabs/git-secrets) detect it as secret.

## Options

- `allows: string[]`
    - Allows a list of [RegExp-like String](https://github.com/textlint/regexp-string-matcher#regexp-like-string)
- `enableIDScanRule: boolean`
    - Default: `false`
    - Enable ID scan rules
      - `AWSAccountID`
      - `AWSAccessKeyID`
    - These rules may be false-positive. You can enable it by setting `true`.

## Examples

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-aws",
            // Ignore error related to IDs
            "allowMessageIds": ["AWSAccountID", "AWSAccessKeyID"],
            "options": {
                // allow list
                "allows": ["/IT_IS_PUBLIC/"]
            }
        }
    ]
}
```


## Changelog

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

## 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](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
npm package: @secretlint/secretlint-rule-azure
Description: A secretlint rule for Azure.
Author: bittrance
Latest version: 11.6.0

# @secretlint/secretlint-rule-azure

A secretlint rule for Azure (i.e. Azure AD) secrets. This rule takes aim at two common credentials leaks:

- [Service principals in code and config](https://learn.microsoft.com/en-us/azure/active-directory/fundamentals/service-accounts-principal)
- [Standard environment variables](https://learn.microsoft.com/en-us/dotnet/api/azure.identity.environmentcredential)

Note that unlike other secretlint PaaS rules, Azure does not have a standard file format for credentials and all
sensitive information is fully random, so discovering Azure AD credentials is purely heuristical.

## Install

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

    npm install @secretlint/secretlint-rule-azure

## Usage

Via `.secretlintrc.json`

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-azure"
        }
    ]
}
```

## MessageIDs

### AzureTenantId

> found Azure AD tenant ID: {{ID}}

This is the GUID of an Azure AD tenant. While this ID can be discovered from the domain name, knowing the tenant ID
increases the chance that credentials can be exploited. It is thus a good idea to treat the tenant ID as sensitive.

### AzureClientId

> found Azure client id: {{ID}}

This is the equivalent of a username and should be treated as sensitive.

### AzureClientSecret

> found Azurre client secret: {{SECRET}}

This is the long-lived secret for a user or service principal and should be kept secret.

## Options

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

## Examples

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-azure",
            // Ignore error related to IDs
            "allowMessageIds": ["AzureTenantId", "AzureClientId"],
            "options": {
                // allow list
                "allows": ["/IT_IS_PUBLIC/"]
            }
        }
    ]
}
```


## Changelog

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

## 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](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/bittrance](https://github.com/bittrance)

## License

MIT © [Xenit AB](https://github.com/xenitab)
npm package: @secretlint/secretlint-rule-basicauth
Description: A secretlint rule that check Basic Authentication.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-basicauth

A secretlint rule that check Basic Authentication.

## Install

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

    npm install @secretlint/secretlint-rule-basicauth

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-basicauth"
        }
    ]
}
```

## MessageIDs

### BasicAuth
> found basic auth credential: {{CREDENTIAL}}

Disallow to use `<protocol>://<user>:<pass>@<host>` in plain text.

Basic Authentication includes a credential like `user:pass@host`.

## 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

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](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
npm package: @secretlint/secretlint-rule-example
Description: An example rule for secretlint. It it for testing.
Author: azu
Latest version: 11.6.0

# @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
npm package: @secretlint/secretlint-rule-filter-comments
Description: secretlint-disable comment directive.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-filter-comments

secretlint-disable comment directive.

## Install

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

    npm install @secretlint/secretlint-rule-filter-comments

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
  "rules": [
    {
      "id": "@secretlint/secretlint-rule-filter-comments"
    }
  ]
}
```

## secretlint-disable directives

- `secretlint-disable` disable 
- `secretlint-enable`: enable again
- `secretlint-disable-line`: ignore current line
- `secretlint-disable-next-line`: ignore next line

### Examples

To temporarily disable rule warnings in your file, use block comments in the following format:

You can replace `//` with any characters like `#` or `/*` etc...
`@secretlint/secretlint-rule-filter-comments` only look up `/(?<type>secretlint-(?:disable-next-line|disable-line|disable|enable))(?<options>.*)/g` pattern.

```
// secretlint-disable

THIS IS IGNORED SECRET

// secretlint-enable

THIS WILL REPORTED SECRET
```

You can also disable or enable warnings for specific rules:

```js
/* secretlint-disable @secretlint/secretlint-rule-github */
const TOKEN = "ghs-<github token>";

/* secretlint-enable @secretlint/secretlint-rule-github */
```

To disable rule warnings in an entire file, put a `/* secretlint-disable */` block comment at the top of the file.
Of course, you can use [.secretlintignore](https://github.com/secretlint/secretlint/blob/master/docs/configuration.md#secretlintignore) instead of it.

```
// secretlint-disable

.... all ignored ....
```

You can also disable or enable specific rules for an entire file:

```
// secretlint-disable @secretlint/secretlint-rule-github

GITHUB TOKEN WILL NOT DETECT!
```

To disable all rules on a specific line using `secretlint-disable-line`:

```
THIS IS SECRET BUT IT WILL BE IGNORED // secretlint-disable-line
```

To disable all rules on a next line using `secretlint-disable-nextline`:

```
// secretlint-disable-next-line
THIS IS SECRET BUT IT WILL BE IGNORED
```

All disable/enable syntax can include comment using `-- comment`.

```
// secretlint-disable @secretlint/secretlint-rule-github -- disable github rule
```

## MessageIDs

### IGNORE_MESSAGE
> disable by secretlint-disable comment

Ignored messages. It will not appear on result.

## Options

- [ ] No Options yet

## Changelog

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

## 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](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

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

## License

MIT © azu
npm package: @secretlint/secretlint-rule-gcp
Description: A secretlint rule for GCP.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-gcp

A secretlint rule for GCP.

## Install

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

    npm install @secretlint/secretlint-rule-gcp

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-gcp"
        }
    ]
}
```

## MessageIDs

### PrivateKeyP12
> found GCP Service Account's private key(p12): {{FILE_NAME}}

This p12 file includes private key for GCP Service Account.

GCP Service Account's private key(PKCS12 format) is not encrypted data.
Because, the pass phase for this p12 file is `notasecret`.

- https://cloud.google.com/iam/docs/reference/rest/v1/projects.serviceAccounts.keys#serviceaccountprivatekeytype

### PrivateKeyJSON
> found GCP Service Account's private key(json): {{FILE_NAME}}

This JSON file includes private key for GCP Service Account.

## 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

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## 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
npm package: @secretlint/secretlint-rule-github
Description: A secretlint rule for sendgrid api keys.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-github

A secretlint rule for GitHub.

## Install

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

    npm install @secretlint/secretlint-rule-github

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "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.

- [Authentication token format updates are generally available | GitHub Changelog](https://github.blog/changelog/2021-03-31-authentication-token-format-updates-are-generally-available/)
- [Introducing fine-grained personal access tokens for GitHub | The GitHub Blog](https://github.blog/2022-10-18-introducing-fine-grained-personal-access-tokens-for-github/)

## 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

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](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
npm package: @secretlint/secretlint-rule-internal-test-cjs
Description: An example CJS rule for secretlint. It it for testing.
Author: azu
Latest version: 8.1.2

# @secretlint/secretlint-rule-internal-test-cjs

Internal Rule Package in written CJS

- Pure Deps
  - Prevent Dependency cycles
- ALWAYS MATCH "SECRET" string.

## MessageIDs

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

An example error message.

## 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
npm package: @secretlint/secretlint-rule-internal-test-esm
Description: An example ESM rule for secretlint. It it for testing.
Author: azu
Latest version: 8.1.2

# @secretlint/secretlint-rule-internal-test-esm

Internal Rule Package in written ESM

- Pure Deps
  - Prevent Dependency cycles
- ALWAYS MATCH "SECRET" string.

## Install

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

    npm install @secretlint/secretlint-rule-internal-test-esm

## MessageIDs

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

An example error message.

## 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
npm package: @secretlint/secretlint-rule-internal-test-pure-deps
Description: An example rule for secretlint. It it for testing.
Author: azu
Latest version: 6.2.4

# @secretlint/secretlint-rule-internal-test-pure-deps

Internal Example Package.

- Pure Deps
  - Prevent Dependency cycles
- ALWAYS MATCH "SECRET" string.

## Install

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

    npm install @secretlint/secretlint-rule-internal-test-pure-deps

## MessageIDs

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

An example error message.

## 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
npm package: @secretlint/secretlint-rule-linear
Description: A secretlint rule for linear
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-linear

[Linear](https://linear.app) rule for secretlint.

## Install

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

    npm install @secretlint/secretlint-rule-linear

## MessageIDs

### LINEAR_API_TOKEN
> found linear api token: ${props.ID}

Linear API tokens should be private.

## 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

## License

MIT © azu
npm package: @secretlint/secretlint-rule-no-dotenv
Description: A secretlint rule for dotenv
Author: Munieru
Latest version: 11.6.0

# @secretlint/secretlint-rule-no-dotenv
A secretlint rule for dotenv.

Prevents commits  `.env` file because it may contain credentials.

## Install

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

    npm install @secretlint/secretlint-rule-no-dotenv

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-no-dotenv",
            "options": {
                "allowFileNames": [".env.local", ".env.test"]
            }
        }
    ]
}
```

The `allowFileNames` option allows you to specify certain .env files that should be allowed. This is useful for environment-specific configuration files that are safe to commit. Note that this option works alongside `.secretlintignore`, giving you flexibility in how you want to manage your environment files.

## MessageIDs

### FOUND_DOTENV_FILE
> found .env file

Disallow to commit `.env` file, because dotenv document describe that

> Should I commit my .env file?
> 
> No. We strongly recommend against committing your .env file to version control.
> 
> -- <https://github.com/motdotla/dotenv#should-i-commit-my-env-file>

You can tell Secretlint to ignore `.env` file by [`.secretlintignore`](https://github.com/secretlint/secretlint/blob/master/docs/configuration.md#secretlintignore) configuration.

For more details `.secretlintignore`, see following document.

- <https://github.com/secretlint/secretlint/blob/master/docs/configuration.md#secretlintignore>

## Author

- [Munieru](https://github.com/munierujp)

## License

MIT © secretlint
npm package: @secretlint/secretlint-rule-no-homedir
Description: A secretlint rule that disallow to include user's homedir path.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-no-homedir

A secretlint rule that disallow to include user's homedir path.

For example, The user homedir is `/Usrs/exampleuser`, then this rule check if `/Usrs/exampleuser` is included. 

## Install

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

    npm install @secretlint/secretlint-rule-no-homedir

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-no-homedir"
        }
    ]
}
```

## MessageIDs

### HOMEDIR
> found user's homedir path: {{PATH}}

If it is expected exposed, please ignore it by following way.

- `.secretlintignore`: ignore specific file

## Options

## Changelog

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

## Running tests

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## 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
npm package: @secretlint/secretlint-rule-no-k8s-kind-secret
Description: A secretlint rule that disallow to use Kind: Secret in Kubernetes repository.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-no-k8s-kind-secret

A secretlint rule that disallow to use [Kind: Secret](https://kubernetes.io/docs/concepts/configuration/secret/) in Kubernetes repository. 

## Install

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

    npm install @secretlint/secretlint-rule-no-k8s-kind-secret

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-no-k8s-kind-secret"
        }
    ]
}
```

## MessageIds

### disallowToUseKindSecret
> disallow to use Kind: Secret in manifest: {{FILE_NAME}}

Kubernetes's [`Kind: Secret`]((https://kubernetes.io/docs/concepts/configuration/secret)) includes credentials as plain format.
It just base64 encoded value.

```yaml
apiVersion: v1
kind: Secret
metadata:
  name: mysecret
type: Opaque
data:
  username: YWRtaW4=
  password: MWYyZDFlMmU2N2Rm
```

So, `Kind: Secret` manifest is not committable file into a repository.

- [Secrets - Kubernetes](https://kubernetes.io/docs/concepts/configuration/secret/)

In GitOps context, you can use another solution like [SealedSecret](https://github.com/bitnami-labs/sealed-secrets), [Vault](https://www.vaultproject.io/) etc...

- [GitOps - Frequently Asked Questions](https://www.weave.works/technologies/gitops-frequently-asked-questions/#manage-secrets)
- [Secret Management - Argo CD - Declarative GitOps CD for Kubernetes](https://argoproj.github.io/argo-cd/operator-manual/secret-management/)

## Options

- No Options

## Changelog

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

## Running tests

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## 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
npm package: @secretlint/secretlint-rule-npm
Description: A secretlint rule for npm.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-npm

A secretlint rule for npm.

## Install

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

    npm install @secretlint/secretlint-rule-npm

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-npm"
        }
    ]
}
```

## MessageIDs

### PackageJSON_xOauthToken
> found GitHub Token: {{TOKEN}}

Disallow to use `https://<token>@github.com/owner/repo.git` in `package.json` or `package-lock.json`.

Often, `https://<token>@github.com/owner/repo.git` is used for installing module from private repository.

- [Easier builds and deployments using Git over HTTPS and OAuth - The GitHub Blog](https://github.blog/2012-09-21-easier-builds-and-deployments-using-git-over-https-and-oauth/)

If you want to use some module as private, please use private registry like npm, [GitHub Package Registry](https://help.github.com/packages/publishing-and-managing-packages/about-github-packages), or [Verdaccio](https://verdaccio.org/).

- [About private packages | npm Documentation](https://docs.npmjs.com/about-private-packages)

### Npmrc_authToken
> found npmrc authToken: {{TOKEN}}

Disallow to include `<registry>:_authToken=<TOKEN>` in `.npmrc`.

The `TOKEN` is credential data.

- [npm - Using auth tokens in .npmrc - Stack Overflow](https://stackoverflow.com/questions/53099434/using-auth-tokens-in-npmrc)

### NPM_ACCESS_TOKEN
> found npm access token: {{TOKEN}}

Disallow to include npm access token.

The `TOKEN` is credential data.

- [About access tokens | npm Docs](https://docs.npmjs.com/about-access-tokens)
- [Announcing npm’s new access token format | The GitHub Blog](https://github.blog/2021-09-23-announcing-npms-new-access-token-format/)

## 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

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](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
npm package: @secretlint/secretlint-rule-openai
Description: An example rule for secretlint.
Author: Natsuki Ikeguchi
Latest version: 11.6.0

# @secretlint/secretlint-rule-openai

A secretline rule for OpenAI.

## Install

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

    npm install @secretlint/secretlint-rule-openai

## MessageIDs

### OPENAI_TOKEN

> found OpenAI API Token: {{KEY}}

OpenAI API tokens should be private.

## Options

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

## Examples

```json5

{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-openai",
            // Ignore error related to IDs
            "allowMessageIds": ["OPENAI_TOKEN"],
            "options": {
                // allow list
                "allows": ["/IT_IS_PUBLIC/"]
            }
        }
    ]
}
```

## Changelog

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

## 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](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/siketyan](https://github.com/siketyan)
- [twitter/s6n_jp](https://twitter.com/s6n_jp)

## License

MIT © Natsuki Ikeguchi
npm package: @secretlint/secretlint-rule-preset-canary
Description: Canary rule preset of secretlint.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-preset-canary

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

This preset similar with [secretlint-rule-preset-recommend](https://www.npmjs.com/package/@secretlint/secretlint-rule-preset-recommend), but it does not base on [Semantic Versioning](https://semver.org/).

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](https://www.npmjs.com/):

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

## Usage


Via `.secretlintrc.json`

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

## Options

```json5
{
    "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](https://rollupjs.org).
It is performance reason. Bundled file will reduce loading cost.

## Changelog

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

## 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](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
npm package: @secretlint/secretlint-rule-privatekey
Description: A secretlint rule for PrivateKey.
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-privatekey

A secretlint rule for PrivateKey.

## Install

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

    npm install @secretlint/secretlint-rule-privatekey

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/privatekey"
        }
    ]
}
```

## MessageIDs

### PrivateKey
> found private key: {{KEY}}

Private Key should be private.

- https://en.wikipedia.org/wiki/Public-key_cryptography

## 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

Install devDependencies and Run `npm test`:

    npm i -d && npm test

## 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
npm package: @secretlint/secretlint-rule-secp256k1-privatekey
Description: A secretlint rule that checks for secp256k1 private keys.
Author: mtsalenc
Latest version: 11.6.0

# @secretlint/secretlint-rule-secp256k1-privatekey

A secretlint for secp256k1 curve private keys such as used by Bitcoin an Ethereum.

## Install

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

    npm install @secretlint/secretlint-rule-secp256k1-privatekey

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-secp256k1-privatekey"
        }
    ]
}
```


## MessageIDs

### secp256k1Priv
> found secp256k1 private key: {{KEY}}

Secp256k1 curve private keys such as used by Bitcoin an Ethereum.
It should be treated as credentials.

## 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

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](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/mtsalenc](https://github.com/mtsalenc)
- [twitter/mtsalenc](https://twitter.com/mtsalenc)

## License

MIT © mtsalenc
npm package: @secretlint/secretlint-rule-sendgrid
Description: A secretlint rule for sendgrid api keys.
Author: mtsalenc
Latest version: 11.6.0

# @secretlint/secretlint-rule-sendgrid

A secretlint rule for sendgrid.

## Install

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

    npm install @secretlint/secretlint-rule-sendgrid

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-sendgrid"
        }
    ]
}
```

## MessageIDs

### SENDGRID_KEY
> found sendgrid api key: {{KEY}}

Disallow to write sendgrid api key.

- [Manage SendGrid API Keys | SendGrid Documentation](https://sendgrid.com/docs/ui/account-and-settings/api-keys/)

## 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

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](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/mtsalenc](https://github.com/mtsalenc)
- [twitter/mtsalenc](https://twitter.com/mtsalenc)

## License

MIT © mtsalenc
npm package: @secretlint/secretlint-rule-shopify
Description: A secretlint rule for shopify
Author: azu
Latest version: 11.6.0

# @secretlint/secretlint-rule-shopify

A secretlint rule for sendgrid.

## Install

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

    npm install @secretlint/secretlint-rule-shopify

## Usage

Via `.secretlintrc.json`(Recommended)

```json
{
    "rules": [
        {
            "id": "@secretlint/secretlint-rule-shopify"
        }
    ]
}
```

## MessageIDs

### SHOPIFY_KEY
> found Shopify api key: {{KEY}}

Disallow to write Shopify api key.

## 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

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](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

## License

MIT © azu