plceye 0.7.1

PLC code smell detector and static analyzer for L5X and PLCopen files
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54

//! plceye - PLC Code Rule Detector
//!
//! Open source static analyzer for PLC files that detects code rules
//! and potential issues in PLC programs.
//!
//! ## Supported Formats
//!
//! - **L5X** - Rockwell Automation Studio 5000
//! - **PLCopen XML** - IEC 61131-3 standard exchange format
//!
//! ## Supported Rules (Open Source)
//!
//! - **S0001: unused_tags** - Tags defined but never used
//! - **S0002: undefined_tags** - Tags referenced but not defined
//! - **S0003: empty_routines** - Routines with no logic
//! - **S0004: unused_aois** - AOIs defined but never called
//! - **S0005: unused_datatypes** - User-defined types never used
//! - **M0001: cyclomatic_complexity** - ST routines with high complexity
//! - **M0003: deep_nesting** - Control structures nested too deeply
//!
//!
//! ## CLI Usage
//!
//! ```bash
//! # Analyze a file
//! plceye project.L5X
//!
//! # With custom config
//! plceye --config plceye.toml project.L5X
//! ```

pub mod analysis;
mod config;
mod detector;
mod error;
mod loader;
mod report;
mod rules;

// Core types
pub use config::{RuleConfig, GeneralConfig, UnusedTagsConfig, UndefinedTagsConfig, EmptyRoutinesConfig, UnusedAoisConfig, UnusedDataTypesConfig, ComplexityConfig, NestingConfig};
pub use detector::RuleDetector;
pub use error::{Error, Result, L5xParseErrorKind, ConfigErrorKind};
pub use loader::{LoadedProject, FileFormat};
pub use report::{Report, Rule, Severity, RuleKind};

// Analysis types (for extensions)
pub use analysis::{ProjectAnalysis, ParseStats, analyze_controller};
pub use analysis::{PlcopenAnalysis, PlcopenStats, analyze_plcopen_project};

// Re-export parser crates for extensions
pub use l5x;
pub use plcopen;
pub use iec61131;