📋 Rules Guide

Complete reference for all 11 linting rules implemented in Linterman.

11
Total Rules
4
ERROR Rules
7
WARNING Rules
5
Auto-Fixable

❌ ERROR Rules (Critical)

These issues must be fixed. Impact: -15% per issue

HTTP Status Test Mandatory

ERROR Auto-Fix

Every request must test the HTTP status code

Testing-15%

Test Description with URI

ERROR Auto-Fix

Test descriptions should include URI segments or use location variable

Testing-15%

Collection Documentation

ERROR

Collection must have complete Overview documentation

Documentation-15%

Request Examples Required

ERROR

Each request must have quality response examples

Documentation-15%

⚠️ WARNING Rules (Important)

These issues should be fixed. Impact: -8% per issue

Response Time Test Mandatory

WARNING Auto-Fix

Each request should test response time

Testing-8%

Body Content Validation

WARNING

Requests should validate response body content

Testing-8%

Schema Validation Recommended

WARNING

JSON schema validation recommended for robustness

Testing-8%

Request Naming Convention

WARNING Auto-Fix

Requests should start with HTTP method

Structure-8%

Response Time Threshold

WARNING Auto-Fix

Response time thresholds should be reasonable (≤2000ms)

Performance-8%

Environment Variables Usage

WARNING

URLs should use environment variables

Best Practices-8%

Test Coverage Minimum

WARNING

Collection should have minimum 80% test coverage

Best Practices-8%

🔧 Auto-Fix Summary

5/11 rules can be fixed automatically (45%).

Auto-Fixable Rules:

  • HTTP Status Test Mandatory
  • Test Description with URI
  • Response Time Test Mandatory
  • Request Naming Convention
  • Response Time Threshold

🎯 Achieving 100% Score

  1. ✅ Fix all ERROR rules (priority)
  2. ✅ Use auto-fix for the 5 supported rules
  3. ✅ Manually fix the remaining 6 rules
  4. ✅ Get the bonus: 0 errors AND ≤ 2 warnings = +5%

📚 Learn More