https://github.com/sify21/gomod-rs

go.mod file parser with locations
https://github.com/sify21/gomod-rs

gomod nom rust-library

Last synced: 2 months ago
JSON representation

go.mod file parser with locations

• Host: GitHub
• URL: https://github.com/sify21/gomod-rs
• Owner: sify21
• License: mit
• Created: 2024-05-22T18:40:55.000Z (over 1 year ago)
• Default Branch: main
• Last Pushed: 2024-05-24T02:57:41.000Z (over 1 year ago)
• Last Synced: 2025-10-29T12:23:33.212Z (3 months ago)
• Topics: gomod, nom, rust-library
• Language: Rust
• Homepage:
• Size: 22.5 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
# gomod-rs

[![LICENSE](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)

[![crates.io Version](https://img.shields.io/crates/v/gomod-rs)](https://crates.io/crates/gomod-rs)

A [go.mod](https://go.dev/ref/mod#go-mod-file) file parser with location information.

Implemented using [nom](https://github.com/rust-bakery/nom) and [nom\_locate](https://github.com/fflorent/nom_locate).

**No string copy/clone during parsing.**

(except for [interpreted strings](https://go.dev/ref/mod#go-mod-file-lexical), which yield `Identifier::Interpreted(String)` type)

## Example Usage

Here is an example printing all requirements defined in a go.mod file, along with their locations and related contents.

```rust

use gomod_rs::{parse_gomod, Context, Directive};

let contents = r#"module example.com/my/thing

go 1.12

require (

    example.com/other/thing v1.0.2

    example.com/new/thing/v2 v2.3.4

)

exclude example.com/old/thing v1.2.3

replace example.com/bad/thing v1.4.5 => example.com/good/thing v1.4.5

retract [v1.9.0, v1.9.5]"#;

let gomod = parse_gomod(&contents)?;

gomod

    .iter()

    .filter_map(|i| match i {

        Context {

            value: Directive::Require { specs },

            ..

        } => Some(specs),

        _ => None,

    })

    .for_each(|require_specs| {

        require_specs.iter().for_each(|spec| {

            println!(

                "Requirement {{name: {}, version: {}}} at line {}, fragment: {}",

                spec.value.0,

                &spec.value.1 as &str,

                spec.range.0.line,

                &contents[spec.range.0.offset..spec.range.1.offset]

            );

        });

    });

```

Above will ouput:

```

Requirement {name: example.com/other/thing, version: v1.0.2} at line 6, fragment: example.com/other/thing v1.0.2

Requirement {name: example.com/new/thing/v2, version: v2.3.4} at line 7, fragment: example.com/new/thing/v2 v2.3.4

```

You can also `cargo run --example parse -- /path/to/go.mod`.