This repository has been archived by the owner on Jan 26, 2023. It is now read-only.
-
Notifications
You must be signed in to change notification settings - Fork 15
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
CI: Add Github Action, Readme, missing source files
bindings/*, parser.c must be checked in, too, otherwise GH Actions cannot build
- Loading branch information
Showing
13 changed files
with
2,245 additions
and
54 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,21 @@ | ||
|
||
name: build | ||
|
||
on: | ||
push: | ||
pull_request: | ||
branches: | ||
- "**" # Don't trust forks because miners | ||
|
||
jobs: | ||
build: | ||
name: build | ||
runs-on: ubuntu-latest | ||
steps: | ||
- uses: actions/checkout@v2 | ||
- uses: actions/setup-node@v2 | ||
with: | ||
node-version: '14' | ||
- run: npm install | ||
- run: npm test | ||
|
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,4 @@ | ||
node_modules/ | ||
bindings/ | ||
build/ | ||
pug.so | ||
src/parser.c | ||
src/grammar.json |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1 @@ | ||
nodejs 14.15.1 |
Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,6 +1,34 @@ | ||
# tree-sitter-pug | ||
# Tree-sitter-pug | ||
|
||
**WARNING** This parser is incomplete and in it's very early stages. Will most likely break if you attempt to use it on any real code. | ||
This is a tree-sitter parser grammar for the [pug](https://github.com/pugjs/pug) language. | ||
|
||
For now this is intended to be used **for a vue+pug** setup, as the control flow operations aren't recognized by the parser (since they are not used in conjunction with vue). | ||
|
||
## Contributing | ||
|
||
If you'd like to contribute the missing grammar, feel free to fork/PR: | ||
|
||
currently missing: | ||
|
||
- [ ] Control Flow (if, each, else, case, include...) | ||
https://pugjs.org/language/conditionals.html | ||
https://pugjs.org/language/includes.html | ||
- [ ] doctype | ||
https://pugjs.org/language/doctype.html | ||
- [ ] inline Javascript code with "- " | ||
- [ ] output Javascript code with "= " | ||
https://pugjs.org/language/code.html | ||
- [ ] inline Javascript code with "#{...}" | ||
- [ ] Filters | ||
- [ ] Piped Content with a dot on the tag | ||
|
||
|
||
To add tests, check out `./test/corpus/*.txt` | ||
|
||
How to run & test: | ||
|
||
``` | ||
npm install -g tree-sitter-cli | ||
tree-sitter generate && tree-sitter test | ||
``` | ||
|
||
This is a tree-sitter parser for the [pug](https://github.com/pugjs/pug) language. | ||
For now this is intended to be used for a vue+pug setup, as the control flow operations aren't recognized by the parser (since they are not used in conjunction with vue). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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_pug(); | ||
|
||
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_pug()); | ||
|
||
Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("pug").ToLocalChecked()); | ||
Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance); | ||
} | ||
|
||
NODE_MODULE(tree_sitter_pug_binding, Init) | ||
|
||
} // namespace |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,19 @@ | ||
try { | ||
module.exports = require("../../build/Release/tree_sitter_pug_binding"); | ||
} catch (error1) { | ||
if (error1.code !== 'MODULE_NOT_FOUND') { | ||
throw error1; | ||
} | ||
try { | ||
module.exports = require("../../build/Debug/tree_sitter_pug_binding"); | ||
} catch (error2) { | ||
if (error2.code !== 'MODULE_NOT_FOUND') { | ||
throw error2; | ||
} | ||
throw error1 | ||
} | ||
} | ||
|
||
try { | ||
module.exports.nodeTypeInfo = require("../../src/node-types.json"); | ||
} catch (_) {} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
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()); | ||
*/ | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,52 @@ | ||
//! This crate provides pug 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_pug::language()).expect("Error loading pug 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_pug() -> 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_pug() } | ||
} | ||
|
||
/// 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 pug language"); | ||
} | ||
} |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.