Loading...
Loading...
Implement FireCrawl lint rules, policy enforcement, and automated guardrails. Use when setting up code quality rules for FireCrawl integrations, implementing pre-commit hooks, or configuring CI policy checks for FireCrawl best practices. Trigger with phrases like "firecrawl policy", "firecrawl lint", "firecrawl guardrails", "firecrawl best practices check", "firecrawl eslint".
npx skill4agent add jeremylongshore/claude-code-plugins-plus-skills firecrawl-policy-guardrails// eslint-plugin-firecrawl/rules/no-hardcoded-keys.js
module.exports = {
meta: {
type: 'problem',
docs: {
description: 'Disallow hardcoded FireCrawl API keys',
},
fixable: 'code',
},
create(context) {
return {
Literal(node) {
if (typeof node.value === 'string') {
if (node.value.match(/^sk_(live|test)_[a-zA-Z0-9]{24,}/)) {
context.report({
node,
message: 'Hardcoded FireCrawl API key detected',
});
}
}
},
};
},
};// .eslintrc.js
module.exports = {
plugins: ['firecrawl'],
rules: {
'firecrawl/no-hardcoded-keys': 'error',
'firecrawl/require-error-handling': 'warn',
'firecrawl/use-typed-client': 'warn',
},
};# .pre-commit-config.yaml
repos:
- repo: local
hooks:
- id: firecrawl-secrets-check
name: Check for FireCrawl secrets
entry: bash -c 'git diff --cached --name-only | xargs grep -l "sk_live_" && exit 1 || exit 0'
language: system
pass_filenames: false
- id: firecrawl-config-validate
name: Validate FireCrawl configuration
entry: node scripts/validate-firecrawl-config.js
language: node
files: '\.firecrawl\.json$'// Enforce typed configuration
interface FireCrawlStrictConfig {
apiKey: string; // Required
environment: 'development' | 'staging' | 'production'; // Enum
timeout: number; // Required number, not optional
retries: number;
}
// Disallow any in FireCrawl code
// @ts-expect-error - Using any is forbidden
const client = new Client({ apiKey: any });
// Prefer this
const client = new FireCrawlClient(config satisfies FireCrawlStrictConfig);# ADR-001: FireCrawl Client Initialization
## Status
Accepted
## Context
We need to decide how to initialize the FireCrawl client across our application.
## Decision
We will use the singleton pattern with lazy initialization.
## Consequences
- Pro: Single client instance, connection reuse
- Pro: Easy to mock in tests
- Con: Global state requires careful lifecycle management
## Enforcement
- ESLint rule: firecrawl/use-singleton-client
- CI check: grep for "new FireCrawlClient(" outside allowed files# firecrawl-policy.rego
package firecrawl
# Deny production API keys in non-production environments
deny[msg] {
input.environment != "production"
startswith(input.apiKey, "sk_live_")
msg := "Production API keys not allowed in non-production environment"
}
# Require minimum timeout
deny[msg] {
input.timeout < 10000
msg := sprintf("Timeout too low: %d < 10000ms minimum", [input.timeout])
}
# Require retry configuration
deny[msg] {
not input.retries
msg := "Retry configuration is required"
}# .github/workflows/firecrawl-policy.yml
name: FireCrawl Policy Check
on: [push, pull_request]
jobs:
policy:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v4
- name: Check for hardcoded secrets
run: |
if grep -rE "sk_(live|test)_[a-zA-Z0-9]{24,}" --include="*.ts" --include="*.js" .; then
echo "ERROR: Hardcoded FireCrawl keys found"
exit 1
fi
- name: Validate configuration schema
run: |
npx ajv validate -s firecrawl-config.schema.json -d config/firecrawl/*.json
- name: Run ESLint FireCrawl rules
run: npx eslint --plugin firecrawl --rule 'firecrawl/no-hardcoded-keys: error' src/// Prevent dangerous operations in production
const BLOCKED_IN_PROD = ['deleteAll', 'resetData', 'migrateDown'];
function guardFireCrawlOperation(operation: string): void {
const isProd = process.env.NODE_ENV === 'production';
if (isProd && BLOCKED_IN_PROD.includes(operation)) {
throw new Error(`Operation '${operation}' blocked in production`);
}
}
// Rate limit protection
function guardRateLimits(requestsInWindow: number): void {
const limit = parseInt(process.env.FIRECRAWL_RATE_LIMIT || '100');
if (requestsInWindow > limit * 0.9) {
console.warn('Approaching FireCrawl rate limit');
}
if (requestsInWindow >= limit) {
throw new Error('FireCrawl rate limit exceeded - request blocked');
}
}| Issue | Cause | Solution |
|---|---|---|
| ESLint rule not firing | Wrong config | Check plugin registration |
| Pre-commit skipped | --no-verify | Enforce in CI |
| Policy false positive | Regex too broad | Narrow pattern match |
| Guardrail triggered | Actual issue | Fix or whitelist |
npx eslint --plugin firecrawl --rule 'firecrawl/no-hardcoded-keys: error' src/firecrawl-architecture-variants