# duaraghav8/ethlint architecture

> Architecture diagram of the GitHub repository duaraghav8/ethlint, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2025-05-10). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/duaraghav8/ethlint
- Repository: https://github.com/duaraghav8/ethlint

## Overview

##### Project type and purpose
- This is a Node.js–based CLI tool (linter) called Ethlint (formerly Solium). Its purpose is to parse, analyze, and optionally auto-fix Solidity smart‐contract code for style and security issues.

##### File structure
- Top‐level:
- bin/solium.js – CLI entrypoint
- lib/ – core implementation, organized into modules:
◦ cli-utils – helpers to parse CLI flags, read config ignore files
◦ solium.js – orchestrates the lint run
◦ rule-context.js, rules.js – manage rule execution context and rule definitions
◦ autofix/ – pipeline to collect and merge code fixes
◦ reporters/ – format output (pretty, gcc)
◦ utils/ – AST utilities, config inspection, file system, JS helpers, plugin loader
- config/ – JSON schemas & built-in rulesets (recommended, all)
- docs/ – documentation build files
- test/ – unit + integration tests covering every module/rule
- snap, .travis.yml – packaging & CI

##### Key insights from the README
- The tool reads a project’s .soliumrc.json (config + rules/plugins/extensions) and .soliumignore.
- It offers commands: init, lint, fix.
- It resolves a set of rules (style + security), applies them to an AST of the source files, and reports/fixes violations.

a. Main components
1. CLI Layer
- bin/solium.js
- Parses command‐line options (–init, –fix, –d, –f)
2. Configuration Manager
- lib/cli-utils (default ignore & rc handling)
- lib/utils/config-inspector.js
- config/schemas & rulesets
3. File System & Source Loader
- lib/utils/fs-utils.js
- Reads Solidity source files, applies ignore globs
4. Parser & AST Builder
- (Third‐party parser) invoked by lib/utils/ast-utils.js
5. Rule Engine
- lib/rules.js: loads built-in + plugin rules via rule-loader.js
- lib/rule-context.js: provides context & AST node traversal helpers
- Executes each rule on AST nodes
6. Autofix Pipeline (optional)
- lib/autofix/source-code-fixer.js
- merge-fixer-packets.js / rule-fixer.js
7. Reporters
- lib/reporters/pretty.js and gcc.js
- Format and output lint messages
8. Plugin System
- config/schemas/plugin.js
- lib/utils/plugin-loader (dynamic rule extensions)

b. Interactions & data flow
1. User invokes CLI → CLI Layer
2. CLI reads config & ignore → Configuration Manager
3. File paths feed into File System → Source Loader
4. Each file → Parser → AST
5. AST + active rules → Rule Engine → violation reports + fixer packets
6. If --fix → Autofix Pipeline applies changes back to files
7. Reporters format final output to console or files

c. Architectural patterns & principles
- Modular design: each concern separated (CLI, config, parsing, rules, autofix, reporting)
- Plugin architecture: dynamic rule loading via schemas and rule‐loader
- Pipeline pattern: linting and autofix organized as linear processing steps
- Schema validation: configs and rulesets validated via JSON schemas

d. Key technologies
- Node.js (CommonJS modules)
- ESLint-style plugin/rule conventions
- JSON schema for configurations
- External Solidity parser (e.g., solparse) invoked within ast-utils

## Diagram (Mermaid)

```mermaid
flowchart TD
    %% CLI Layer
    subgraph "CLI Layer"
        CLI_BIN["bin/solium.js"]:::core
        CLI_LIB["lib/cli.js"]:::core
    end

    %% Configuration Manager
    subgraph "Configuration Manager"
        CLI_UTILS["lib/cli-utils/"]:::core
        CONFIG_INSP["lib/utils/config-inspector.js"]:::core
        SCHEMAS["config/schemas/"]:::schema
        RULESET_REC["config/rulesets/solium-recommended.js"]:::schema
        RULESET_ALL["config/rulesets/solium-all.js"]:::schema
    end

    %% File System & Source Loader
    FS_UTILS["lib/utils/fs-utils.js"]:::io

    %% Parser & AST Builder
    AST_UTILS["lib/utils/ast-utils.js"]:::core

    %% Rule Engine
    subgraph "Rule Engine"
        RULES_MAIN["lib/rules.js"]:::core
        RULE_CTX["lib/rule-context.js"]:::core
        RULE_LOADER["lib/utils/rule-loader.js"]:::plugin
        BUILTIN_RULES["lib/rules/"]:::core
    end

    %% Autofix Pipeline
    subgraph "Autofix Pipeline"
        SRC_FIXER["lib/autofix/source-code-fixer.js"]:::core
        MERGE_FIXES["lib/autofix/merge-fixer-packets.js"]:::core
        RULE_FIXER["lib/autofix/rule-fixer.js"]:::core
    end

    %% Reporters
    subgraph "Reporters"
        PRETTY["lib/reporters/pretty.js"]:::io
        GCC["lib/reporters/gcc.js"]:::io
    end

    %% Plugin System
    subgraph "Plugin System"
        PLUGIN_SCHEMA["config/schemas/plugin.js"]:::schema
        PLUGIN_LOADER["lib/utils/rule-loader.js"]:::plugin
    end

    %% Connections
    CLI_BIN -->|invokes| CLI_LIB
    CLI_LIB -->|reads config| CLI_UTILS
    CLI_LIB -->|inspects config| CONFIG_INSP
    CLI_UTILS -->|uses schemas| SCHEMAS
    CLI_UTILS -->|loads rulesets| RULESET_REC
    CLI_UTILS -->|loads rulesets| RULESET_ALL
    CONFIG_INSP -->|resolves ignore| FS_UTILS

    FS_UTILS -->|loads source files| AST_UTILS
    AST_UTILS -->|generates AST| RULES_MAIN
    RULES_MAIN -->|executes rules| RULE_CTX
    RULE_CTX -->|traverses AST| BUILTIN_RULES
    RULES_MAIN -->|loads plugins| RULE_LOADER
    PLUGIN_SCHEMA -->|defines plugin schema| PLUGIN_LOADER
    PLUGIN_LOADER -->|injects rules| RULES_MAIN

    RULES_MAIN -->|violations| PRETTY
    RULES_MAIN -->|violations| GCC
    RULES_MAIN -->|--fix enabled| SRC_FIXER
    SRC_FIXER --> MERGE_FIXES
    MERGE_FIXES --> RULE_FIXER
    RULE_FIXER --> PRETTY
    RULE_FIXER --> GCC

    %% Click Events
    click CLI_BIN "https://github.com/duaraghav8/ethlint/blob/master/bin/solium.js"
    click CLI_LIB "https://github.com/duaraghav8/ethlint/blob/master/lib/cli.js"
    click CLI_UTILS "https://github.com/duaraghav8/ethlint/tree/master/lib/cli-utils/"
    click CONFIG_INSP "https://github.com/duaraghav8/ethlint/blob/master/lib/utils/config-inspector.js"
    click SCHEMAS "https://github.com/duaraghav8/ethlint/tree/master/config/schemas/"
    click RULESET_REC "https://github.com/duaraghav8/ethlint/blob/master/config/rulesets/solium-recommended.js"
    click RULESET_ALL "https://github.com/duaraghav8/ethlint/blob/master/config/rulesets/solium-all.js"
    click FS_UTILS "https://github.com/duaraghav8/ethlint/blob/master/lib/utils/fs-utils.js"
    click AST_UTILS "https://github.com/duaraghav8/ethlint/blob/master/lib/utils/ast-utils.js"
    click RULES_MAIN "https://github.com/duaraghav8/ethlint/blob/master/lib/rules.js"
    click RULE_CTX "https://github.com/duaraghav8/ethlint/blob/master/lib/rule-context.js"
    click RULE_LOADER "https://github.com/duaraghav8/ethlint/blob/master/lib/utils/rule-loader.js"
    click BUILTIN_RULES "https://github.com/duaraghav8/ethlint/tree/master/lib/rules/"
    click SRC_FIXER "https://github.com/duaraghav8/ethlint/blob/master/lib/autofix/source-code-fixer.js"
    click MERGE_FIXES "https://github.com/duaraghav8/ethlint/blob/master/lib/autofix/merge-fixer-packets.js"
    click RULE_FIXER "https://github.com/duaraghav8/ethlint/blob/master/lib/autofix/rule-fixer.js"
    click PRETTY "https://github.com/duaraghav8/ethlint/blob/master/lib/reporters/pretty.js"
    click GCC "https://github.com/duaraghav8/ethlint/blob/master/lib/reporters/gcc.js"
    click PLUGIN_SCHEMA "https://github.com/duaraghav8/ethlint/blob/master/config/schemas/plugin.js"

    %% Styles
    classDef core fill:#cce5ff,stroke:#333,stroke-width:1px
    classDef plugin fill:#d4edda,stroke:#333,stroke-width:1px
    classDef io fill:#fff3cd,stroke:#333,stroke-width:1px
    classDef schema fill:#f8d7da,stroke:#333,stroke-width:1px
```
