Skip to content

NammaRust/devlint

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

DevLint

A fast, framework-agnostic project quality validator for environment variables, documentation, and API contracts.

Rust CLI License Status Version


Overview

DevLint is a Rust-powered command-line tool designed to identify common software quality issues before they reach production.

Instead of discovering configuration mistakes, incomplete documentation, or API contract mismatches during deployment, DevLint performs lightweight static validation directly within your project.

Built to be framework-agnostic, it works across multiple programming languages and integrates naturally into local development workflows and CI/CD pipelines.


Why DevLint?

Many production issues originate from simple but overlooked mistakes:

  • Missing environment variables
  • Unused configuration values
  • Empty configuration entries
  • Incomplete project documentation
  • API contract mismatches

These issues are often detected only during testing—or worse, after deployment.

DevLint helps catch them early with fast, actionable validation.


Features

Environment Validation

Analyze project source code and compare detected environment variables against configuration files.

Checks

  • Missing environment variables
  • Unused environment variables
  • Empty variable values

Supported Languages (v1)

  • Rust
  • Python
  • JavaScript
  • TypeScript

README Analysis

Evaluate project documentation for completeness and maintainability.

Checks

  • README existence
  • Installation section
  • Usage section
  • Contributing section
  • License section

Output

  • Documentation Quality Score
  • Missing section report
  • Improvement suggestions

API Contract Validation

Validate JSON payloads against expected schemas to ensure interface consistency.

Checks

  • Missing fields
  • Unexpected fields
  • Data type mismatches

Installation

Coming soon

cargo install devlint

Usage

Validate Environment Variables

devlint env .

Analyze README

devlint readme .

Validate API Contracts

devlint contract \
  --schema schema.json \
  --input response.json

Run Every Validator

devlint scan .

Example Output

Environment Validation:
[PASS] Environment Validation

[PASS] 18 variables found
[PASS] 17 configured
[WARN] Missing:
  DATABASE_URL

[WARN] Unused:
  OLD_API_KEY

Documentation Analysis:
[PASS] README exists
[INFO] Documentation Score: 88/100

API Contract:
[PASS] Schema validation passed

Roadmap

v1.0.0

  • Environment Validator
  • README Analyzer
  • JSON Contract Validator

Planned Features

  • License Validator
  • Docker Validator
  • CI/CD Configuration Validator
  • Security Configuration Validator
  • Git Ignore Validator
  • Dependency Health Checks
  • Project Structure Validation
  • GitHub Actions Support

Contributing

Contributions are welcome.

Please read CONTRIBUTING.md before submitting issues or pull requests.


License

This project is licensed under the MIT License.


Built by the NammaRust Developer Community

About

Framework-agnostic project quality validator for environment variables, documentation, and API contracts.

Topics

Resources

License

Contributing

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors

Languages