API Reference

Contributing to rnsec and understanding its architecture.

Architecture Patterns

Plugin-based Scanners

Each security category is a separate scanner module for extensibility

Rule Engine

Central engine applies rules to files based on file type

AST-based Analysis

Uses Abstract Syntax Tree for accurate code analysis

Progressive Scanning

Shows real-time progress during scan execution

Lazy Parsing

Only parses files that match rule file types

Development Setup

bash

# Clone the repository
git clone https://github.com/yourusername/rnsec.git
cd rnsec

# Install dependencies
npm install

# Build the project
npm run build

# Link for local testing
npm link

# Test on a project
cd /path/to/test-project
rnsec scan

Best Practices

For Developers

• Run before every commit
• Fix HIGH severity first
• Review false positives
• Update regularly
• Share reports with team

For Teams

• CI/CD integration
• Regular audits
• Security training
• Track progress
• Custom rules

Contributing

rnsec is open source and welcomes contributions! Here's how you can help:

Submit new security rules for React Native vulnerabilities
Report false positives or suggest improvements
Improve documentation and examples
Star the repository and share with the community

Open Source

rnsec is MIT licensed and free to use in commercial projects.

View on GitHub →

Configuration

Home Documentation GitHub