Skip to content

Conversation

azu
Copy link
Member

@azu azu commented Aug 11, 2025

Summary

  • Add missing rules to README.md that are included in @secretlint/secretlint-rule-preset-recommend
  • Ensure all rules in the preset are properly documented

Added Rules

The following rules were included in the preset but missing from the README documentation:

  • @secretlint/secretlint-rule-anthropic: Detects Anthropic/Claude API keys (pattern: sk-ant-api0\d-[A-Za-z0-9_-]{90,128}AA)
  • @secretlint/secretlint-rule-database-connection-string: Detects database credentials in connection strings (MongoDB, MySQL, PostgreSQL, etc.)
  • @secretlint/secretlint-rule-1password: Detects 1Password secrets
  • @secretlint/secretlint-rule-filter-comments: Supports ignoring secrets with comments like secretlint-disable

These rules are already part of the recommended preset, so users are already benefiting from them. This PR ensures they are properly documented in the main README.

🤖 Generated with Claude Code

azu and others added 2 commits August 11, 2025 14:05
Add documentation for rules that are included in @secretlint/secretlint-rule-preset-recommend but were missing from the README:
- @secretlint/secretlint-rule-anthropic: Detects Anthropic/Claude API keys
- @secretlint/secretlint-rule-database-connection-string: Detects database credentials in connection strings
- @secretlint/secretlint-rule-1password: Detects 1Password secrets
- @secretlint/secretlint-rule-filter-comments: Supports ignoring secrets with comments

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
…rules

Add missing rules to the preset-recommend README:
- @secretlint/secretlint-rule-openai
- @secretlint/secretlint-rule-anthropic
- @secretlint/secretlint-rule-database-connection-string

Also reordered the list to match the actual order in src/index.ts for consistency.

🤖 Generated with [Claude Code](https://claude.ai/code)

Co-Authored-By: Claude <noreply@anthropic.com>
@azu azu marked this pull request as ready for review August 11, 2025 05:12
@azu azu added the Type: Documentation Documentation only changes label Aug 11, 2025
@azu azu merged commit b69d46e into master Aug 11, 2025
16 checks passed
@azu azu deleted the docs/add-missing-rules-to-readme branch August 11, 2025 05:12
@github-actions github-actions bot mentioned this pull request Aug 11, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Type: Documentation Documentation only changes
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant