Skip to content

Commit

Permalink
Add support for go.mod files
Browse files Browse the repository at this point in the history
This commit adds a grammar for go.mod files using the definition found
at https://golang.org/ref/mod#go-mod-file-grammar.
  • Loading branch information
camdencheek committed Apr 14, 2021
1 parent 2a83dfd commit b36ac6c
Show file tree
Hide file tree
Showing 22 changed files with 6,162 additions and 956 deletions.
26 changes: 26 additions & 0 deletions gomod/Cargo.toml
Original file line number Diff line number Diff line change
@@ -0,0 +1,26 @@
[package]
name = "tree-sitter-gomod"
description = "gomod grammar for the tree-sitter parsing library"
version = "0.0.1"
keywords = ["incremental", "parsing", "gomod"]
categories = ["parsing", "text-editors"]
repository = "https://github.com/tree-sitter/tree-sitter-javascript"
edition = "2018"
license = "MIT"

build = "bindings/rust/build.rs"
include = [
"bindings/rust/*",
"grammar.js",
"queries/*",
"src/*",
]

[lib]
path = "bindings/rust/lib.rs"

[dependencies]
tree-sitter = "0.17"

[build-dependencies]
cc = "1.0"
19 changes: 19 additions & 0 deletions gomod/binding.gyp
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
{
"targets": [
{
"target_name": "tree_sitter_gomod_binding",
"include_dirs": [
"<!(node -e \"require('nan')\")",
"src"
],
"sources": [
"bindings/node/binding.cc",
"src/parser.c",
# If your language uses an external scanner, add it here.
],
"cflags_c": [
"-std=c99",
]
}
]
}
28 changes: 28 additions & 0 deletions gomod/bindings/node/binding.cc
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
#include "tree_sitter/parser.h"
#include <node.h>
#include "nan.h"

using namespace v8;

extern "C" TSLanguage * tree_sitter_gomod();

namespace {

NAN_METHOD(New) {}

void Init(Local<Object> exports, Local<Object> module) {
Local<FunctionTemplate> tpl = Nan::New<FunctionTemplate>(New);
tpl->SetClassName(Nan::New("Language").ToLocalChecked());
tpl->InstanceTemplate()->SetInternalFieldCount(1);

Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
Nan::SetInternalFieldPointer(instance, 0, tree_sitter_gomod());

Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("gomod").ToLocalChecked());
Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
}

NODE_MODULE(tree_sitter_gomod_binding, Init)

} // namespace
19 changes: 19 additions & 0 deletions gomod/bindings/node/index.js
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
try {
module.exports = require("../../build/Release/tree_sitter_gomod_binding");
} catch (error1) {
if (error1.code !== 'MODULE_NOT_FOUND') {
throw error1;
}
try {
module.exports = require("../../build/Debug/tree_sitter_gomod_binding");
} catch (error2) {
if (error2.code !== 'MODULE_NOT_FOUND') {
throw error2;
}
throw error1
}
}

try {
module.exports.nodeTypeInfo = require("../../src/node-types.json");
} catch (_) {}
40 changes: 40 additions & 0 deletions gomod/bindings/rust/build.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
fn main() {
let src_dir = std::path::Path::new("src");

let mut c_config = cc::Build::new();
c_config.include(&src_dir);
c_config
.flag_if_supported("-Wno-unused-parameter")
.flag_if_supported("-Wno-unused-but-set-variable")
.flag_if_supported("-Wno-trigraphs");
let parser_path = src_dir.join("parser.c");
c_config.file(&parser_path);

// If your language uses an external scanner written in C,
// then include this block of code:

/*
let scanner_path = src_dir.join("scanner.c");
c_config.file(&scanner_path);
println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
*/

c_config.compile("parser");
println!("cargo:rerun-if-changed={}", parser_path.to_str().unwrap());

// If your language uses an external scanner written in C++,
// then include this block of code:

/*
let mut cpp_config = cc::Build::new();
cpp_config.cpp(true);
cpp_config.include(&src_dir);
cpp_config
.flag_if_supported("-Wno-unused-parameter")
.flag_if_supported("-Wno-unused-but-set-variable");
let scanner_path = src_dir.join("scanner.cc");
cpp_config.file(&scanner_path);
cpp_config.compile("scanner");
println!("cargo:rerun-if-changed={}", scanner_path.to_str().unwrap());
*/
}
52 changes: 52 additions & 0 deletions gomod/bindings/rust/lib.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
//! This crate provides gomod language support for the [tree-sitter][] parsing library.
//!
//! Typically, you will use the [language][language func] function to add this language to a
//! tree-sitter [Parser][], and then use the parser to parse some code:
//!
//! ```
//! let code = "";
//! let mut parser = tree_sitter::Parser::new();
//! parser.set_language(tree_sitter_gomod::language()).expect("Error loading gomod grammar");
//! let tree = parser.parse(code, None).unwrap();
//! ```
//!
//! [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
//! [language func]: fn.language.html
//! [Parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
//! [tree-sitter]: https://tree-sitter.github.io/
use tree_sitter::Language;

extern "C" {
fn tree_sitter_gomod() -> Language;
}

/// Get the tree-sitter [Language][] for this grammar.
///
/// [Language]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Language.html
pub fn language() -> Language {
unsafe { tree_sitter_gomod() }
}

/// The content of the [`node-types.json`][] file for this grammar.
///
/// [`node-types.json`]: https://tree-sitter.github.io/tree-sitter/using-parsers#static-node-types
pub const NODE_TYPES: &'static str = include_str!("../../src/node-types.json");

// Uncomment these to include any queries that this grammar contains

// pub const HIGHLIGHTS_QUERY: &'static str = include_str!("../../queries/highlights.scm");
// pub const INJECTIONS_QUERY: &'static str = include_str!("../../queries/injections.scm");
// pub const LOCALS_QUERY: &'static str = include_str!("../../queries/locals.scm");
// pub const TAGS_QUERY: &'static str = include_str!("../../queries/tags.scm");

#[cfg(test)]
mod tests {
#[test]
fn test_can_load_grammar() {
let mut parser = tree_sitter::Parser::new();
parser
.set_language(super::language())
.expect("Error loading gomod language");
}
}
36 changes: 36 additions & 0 deletions gomod/corpus/exclude.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
==================
Exclude directive
==================

exclude golang.org/x/net v1.2.3

---

(source_file
(exclude_directive
(exclude_spec
(module_path)
(version))))

==================
Exclude directive parens
==================


exclude (
golang.org/x/crypto v1.4.5
golang.org/x/text v1.6.7
)


---

(source_file
(exclude_directive
(exclude_spec
(module_path)
(version))
(exclude_spec
(module_path)
(version))))

11 changes: 11 additions & 0 deletions gomod/corpus/go.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
==================
Go directive comment
==================

go 1.14

---

(source_file
(go_directive
(go_version)))
41 changes: 41 additions & 0 deletions gomod/corpus/module.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
==================
Module directive no parens
==================

module golang.org/x/net

---

(source_file
(module_directive
(module_path)))

==================
Module directive parens
==================

module (
golang.org/x/net
)

---

(source_file
(module_directive
(module_path)))


==================
Module directive comment
==================

module (
golang.org/x/net // inline
)

---

(source_file
(module_directive
(module_path)
(comment)))
48 changes: 48 additions & 0 deletions gomod/corpus/replace.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
==================
Replace directive
==================

replace golang.org/x/net v1.2.3 => example.com/fork/net v1.4.5

---

(source_file
(replace_directive
(replace_spec
(module_path)
(version)
(module_path)
(version))))

==================
Exclude directive parens
==================


replace (
golang.org/x/net v1.2.3 => example.com/fork/net v1.4.5
golang.org/x/net => example.com/fork/net v1.4.5
golang.org/x/net v1.2.3 => ./fork/net
golang.org/x/net => ./fork/net
)

---

(source_file
(replace_directive
(replace_spec
(module_path)
(version)
(module_path)
(version))
(replace_spec
(module_path)
(module_path)
(version))
(replace_spec
(module_path)
(version)
(file_path))
(replace_spec
(module_path)
(file_path))))
49 changes: 49 additions & 0 deletions gomod/corpus/require.txt
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
==================
Require directive
==================

require cloud.google.com/go v0.76.0

---

(source_file
(require_directive
(require_spec
(module_path)
(version))))

==================
Require directive parens
==================

require (
cloud.google.com/go v0.76.0
)

---

(source_file
(require_directive
(require_spec
(module_path)
(version))))

==================
Require directive parens multiple
==================

require (
cloud.google.com/go v0.76.0
cloud.google.com/go v0.76.0
)

---

(source_file
(require_directive
(require_spec
(module_path)
(version))
(require_spec
(module_path)
(version))))
Loading

0 comments on commit b36ac6c

Please sign in to comment.