tree-sitter-kdl 1.0.1 → 1.0.2

package/.gitattributes

@@ -1,4 +1,5 @@
-/src/** linguist-vendored
+/src/parser.c linguist-vendored
+/src/*.json linguist-vendored
 /examples/* linguist-vendored
 
 src/grammar.json -diff

package/Cargo.toml

@@ -1,16 +1,18 @@
 [package]
 name = "tree-sitter-kdl"
-description = "kdl grammar for the tree-sitter parsing library"
-version = "1.0.1"
+description = "KDL grammar for tree-sitter"
+version = "1.0.2"
 authors = [
 	"Amaan Qureshi <amaanq12@gmail.com>",
 	"Andrew Hlynskyi <ahlincq@gmail.com>",
 ]
+license = "MIT"
+readme = "bindings/rust/README.md"
 keywords = ["incremental", "parsing", "kdl"]
 categories = ["parsing", "text-editors"]
-repository = "https://github.com/tree-sitter/tree-sitter-kdl"
-edition = "2018"
-license = "MIT"
+repository = "https://github.com/amaanq/tree-sitter-kdl"
+edition = "2021"
+autoexamples = false
 
 build = "bindings/rust/build.rs"
 include = ["bindings/rust/*", "grammar.js", "queries/*", "src/*"]

package/LICENSE

@@ -1,7 +1,21 @@
-Copyright (c) 2023 Amaan Qureshi <amaanq12@gmail.com>
+The MIT License (MIT)
 
-Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+Copyright (c) 2023 Amaan Qureshi <amaanq12@gmail.com>, Andrew Hlynskyi <ahlincq@gmail.com>
 
-The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/Package.swift

@@ -0,0 +1,38 @@
+// swift-tools-version:5.3
+import PackageDescription
+
+let package = Package(
+    name: "TreeSitterKDL",
+    platforms: [.macOS(.v10_13), .iOS(.v11)],
+    products: [
+        .library(name: "TreeSitterKDL", targets: ["TreeSitterKDL"]),
+    ],
+    dependencies: [],
+    targets: [
+        .target(name: "TreeSitterKDL",
+                path: ".",
+                exclude: [
+                    "binding.gyp",
+                    "bindings",
+                    "Cargo.toml",
+                    "test",
+                    "examples",
+                    "grammar.js",
+                    "LICENSE",
+                    "package.json",
+                    "README.md",
+                    "script",
+                    "src/grammar.json",
+                    "src/node-types.json",
+                ],
+                sources: [
+                    "src/parser.c",
+                    "src/scanner.c",
+                ],
+                resources: [
+                    .copy("queries")
+                ],
+                publicHeadersPath: "bindings/swift",
+                cSettings: [.headerSearchPath("src")])
+    ]
+)

package/README.md

@@ -1,6 +1,6 @@
 # tree-sitter-kdl
 
-[![Build Status](https://github.com/amaanq/tree-sitter-kdl/workflows/CI/badge.svg)](https://github.com/amaanq/tree-sitter-kdl/workflows/CI/badge.svg)
+[![Build Status](https://github.com/amaanq/tree-sitter-kdl/actions/workflows/ci.yml/badge.svg)](https://github.com/amaanq/tree-sitter-kdl/actions/workflows/ci.yml)
 [![Discord](https://img.shields.io/discord/1063097320771698699?logo=discord)](https://discord.gg/w7nTvsVJhm)
 
 KDL grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)

package/bindings/node/binding.cc

@@ -1,10 +1,10 @@
+#include "nan.h"
 #include "tree_sitter/parser.h"
 #include <node.h>
-#include "nan.h"
 
 using namespace v8;
 
-extern "C" TSLanguage * tree_sitter_kdl();
+extern "C" TSLanguage *tree_sitter_kdl();
 
 namespace {
 
@@ -16,13 +16,15 @@ void Init(Local<Object> exports, Local<Object> module) {
   tpl->InstanceTemplate()->SetInternalFieldCount(1);
 
   Local<Function> constructor = Nan::GetFunction(tpl).ToLocalChecked();
-  Local<Object> instance = constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
+  Local<Object> instance =
+      constructor->NewInstance(Nan::GetCurrentContext()).ToLocalChecked();
   Nan::SetInternalFieldPointer(instance, 0, tree_sitter_kdl());
 
-  Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("kdl").ToLocalChecked());
+  Nan::Set(instance, Nan::New("name").ToLocalChecked(),
+           Nan::New("kdl").ToLocalChecked());
   Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
 }
 
 NODE_MODULE(tree_sitter_kdl_binding, Init)
 
-}  // namespace
+} // namespace

package/bindings/node/index.js

@@ -1,19 +1,19 @@
 try {
-  module.exports = require("../../build/Release/tree_sitter_kdl_binding");
+  module.exports = require('../../build/Release/tree_sitter_kdl_binding');
 } catch (error1) {
   if (error1.code !== 'MODULE_NOT_FOUND') {
     throw error1;
   }
   try {
-    module.exports = require("../../build/Debug/tree_sitter_kdl_binding");
+    module.exports = require('../../build/Debug/tree_sitter_kdl_binding');
   } catch (error2) {
     if (error2.code !== 'MODULE_NOT_FOUND') {
       throw error2;
     }
-    throw error1
+    throw error1;
   }
 }
 
 try {
-  module.exports.nodeTypeInfo = require("../../src/node-types.json");
+  module.exports.nodeTypeInfo = require('../../src/node-types.json');
 } catch (_) {}

package/bindings/rust/README.md

@@ -0,0 +1,36 @@
+# tree-sitter-kdl
+
+This crate provides a KDL grammar for the [tree-sitter][] parsing library. To
+use this crate, add it to the `[dependencies]` section of your `Cargo.toml`
+file. (Note that you will probably also need to depend on the
+[`tree-sitter`][tree-sitter crate] crate to use the parsed result in any useful
+way.)
+
+```toml
+[dependencies]
+tree-sitter = "~0.20.3"
+tree-sitter-kdl = "1.0.2"
+```
+
+Typically, you will use the [language][language func] function to add this
+grammar to a tree-sitter [Parser][], and then use the parser to parse some code:
+
+```rust
+let code = r#"
+    fn double(x: i32) -> i32 {
+        x * 2
+    }
+"#;
+let mut parser = Parser::new();
+parser.set_language(tree_sitter_kdl::language()).expect("Error loading KDL grammar");
+let parsed = parser.parse(code, None);
+```
+
+If you have any questions, please reach out to us in the [tree-sitter
+discussions] page.
+
+[language func]: https://docs.rs/tree-sitter-kdl/*/tree_sitter_kdl/fn.language.html
+[parser]: https://docs.rs/tree-sitter/*/tree_sitter/struct.Parser.html
+[tree-sitter]: https://tree-sitter.github.io/
+[tree-sitter crate]: https://crates.io/crates/tree-sitter
+[tree-sitter discussions]: https://github.com/tree-sitter/tree-sitter/discussions

package/bindings/rust/build.rs

@@ -10,29 +10,10 @@ fn main() {
     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());
-    */
 }

package/bindings/rust/lib.rs

@@ -1,4 +1,9 @@
-//! This crate provides kdl language support for the [tree-sitter][] parsing library.
+// ------------------------------------------------------------------------------------------------
+// Copyright © 2023, Amaan Qureshi <amaanq12@gmail.com>, Andrew Hlynskyi <ahlincq@gmail.com>
+// See the LICENSE file in this repo for license details.
+// ------------------------------------------------------------------------------------------------
+
+//! This crate provides KDL 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:
@@ -28,18 +33,25 @@ pub fn language() -> Language {
     unsafe { tree_sitter_kdl() }
 }
 
-/// 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");
+/// The source of the Rust tree-sitter grammar description.
+pub const GRAMMAR: &str = include_str!("../../grammar.js");
+
+/// The syntax highlighting query for this language.
+pub const HIGHLIGHTS_QUERY: &str = include_str!("../../queries/highlights.scm");
 
-// Uncomment these to include any queries that this grammar contains
+/// The injection query for this language.
+pub const INJECTIONS_QUERY: &str = include_str!("../../queries/injections.scm");
+
+/// The symbol tagging query for this language.
+pub const LOCALS_QUERY: &str = include_str!("../../queries/locals.scm");
 
-// 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");
 
+/// 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: &str = include_str!("../../src/node-types.json");
+
 #[cfg(test)]
 mod tests {
     #[test]
@@ -47,6 +59,6 @@ mod tests {
         let mut parser = tree_sitter::Parser::new();
         parser
             .set_language(super::language())
-            .expect("Error loading kdl language");
+            .expect("Error loading KDL grammar");
     }
 }

package/bindings/swift/kdl.h

@@ -0,0 +1,16 @@
+#ifndef TREE_SITTER_KDL_H_
+#define TREE_SITTER_KDL_H_
+
+typedef struct TSLanguage TSLanguage;
+
+#ifdef __cplusplus
+extern "C" {
+#endif
+
+extern TSLanguage *tree_sitter_kdl();
+
+#ifdef __cplusplus
+}
+#endif
+
+#endif // TREE_SITTER_KDL_H_

package/grammar.js

@@ -2,9 +2,8 @@
  * @file KDL grammar for tree-sitter
  * @author Amaan Qureshi <amaanq12@gmail.com>
  * @license MIT
- * @see {@link https://www.pathofexile.com/item-filter/about|official syntax spec}
- * @see {@link https://pathofexile.fandom.com/wiki/Guide:Item_filter#Syntax|wiki guide}
- * @see {@link https://www.filterblade.xyz/|filter generator}
+ * @see {@link https://kdl.dev|official website}
+ * @see {@link https://github.com/kdl-org/kdl/blob/main/SPEC.md|official syntax spec}
  */
 
 // deno-lint-ignore-file no-control-regex

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tree-sitter-kdl",
-  "version": "1.0.1",
+  "version": "1.0.2",
   "description": "KDL grammar for tree-sitter",
   "main": "bindings/node",
   "keywords": [

package/examples/01-basic.kdl

@@ -1 +0,0 @@
-title "Hello, World"

package/examples/02-multiple-values.kdl

@@ -1 +0,0 @@
-bookmarks 12 15 188 1234

package/examples/03-properties.kdl

@@ -1 +0,0 @@
-author "Alex Monad" email="alex@example.com" active=true

package/examples/04-child-nodes.kdl

@@ -1,6 +0,0 @@
-contents {
-  section "First section" {
-    paragraph "This is the first paragraph"
-    paragraph "This is the second paragraph"
-  }
-}

package/examples/05-node-terminators.kdl

@@ -1 +0,0 @@
-node1; node2; node3;

package/examples/06-string-formats.kdl

@@ -1,2 +0,0 @@
-node "this\nhas\tescapes"
-other r"C:\Users\zkat\"

package/examples/07-multiline-string.kdl

@@ -1,3 +0,0 @@
-string "my
-multiline
-value"

package/examples/08-raw-string.kdl

@@ -1 +0,0 @@
-other-raw r#"hello"world"#

package/examples/09-number.kdl

@@ -1 +0,0 @@
-num 1.234e-42

package/examples/10-number-forms.kdl

@@ -1,3 +0,0 @@
-my-hex 0xdeadbeef
-my-octal 0o755
-my-binary 0b10101101

package/examples/11-number-with-underscores.kdl

@@ -1 +0,0 @@
-bignum 1_000_000

package/examples/12-comments.kdl

@@ -1,11 +0,0 @@
-// C style
-
-/*
-C style multiline
-*/
-
-tag /*foo=true*/ bar=false
-
-/*/*
-hello
-*/*/

package/examples/13-slashdash-comments.kdl

@@ -1,11 +0,0 @@
-// This entire node and its children are all commented out.
-/-mynode "foo" key=1 {
-  a
-  b
-  c
-}
-
-mynode /-"commented" "not commented" /-key="value" /-{
-  a
-  b
-}

package/examples/14-type-annotations.kdl

@@ -1,4 +0,0 @@
-numbers (u8)10 (i32)20 myfloat=(f32)1.5 {
-  strings (uuid)"123e4567-e89b-12d3-a456-426614174000" (date)"2021-02-03" filter=(regex)r"$\d+"
-  (author)person name="Alex"
-}

package/examples/15-rich-example.kdl

@@ -1,21 +0,0 @@
-// Nodes can be separated into multiple lines
-title \
-  "Some title"
-
-
-// Files must be utf8 encoded!
-smile "😁"
-
-// Instead of anonymous nodes, nodes and properties can be wrapped
-// in "" for arbitrary node names.
-"!@#$@$%Q#$%~@!40" "1.2.3" "!!!!!"=true
-
-// The following is a legal bare identifier:
-foo123~!@#$%^&*.:'|?+ "weeee"
-
-// And you can also use unicode!
-ノード　お名前="☜(ﾟヮﾟ☜)"
-
-// kdl specifically allows properties and values to be
-// interspersed with each other, much like CLI commands.
-foo bar=true "baz" quux=false 1 2 3

package/script/parse-examples

@@ -1,40 +0,0 @@
-#!/bin/bash
-
-set -e
-
-cd "$(dirname "$0")/.."
-
-function checkout() {
-  repo=$1; url=$2; sha=$3
-
-  if [ ! -d "$repo" ]; then
-    git clone "https://github.com/$url" "$repo"
-  fi
-
-  pushd "$repo"
-  git fetch && git reset --hard "$sha"
-  popd
-}
-
-checkout examples/kdl kdl-org/kdl 6feeccc491808fe0b5425a18aa7ab4a8ac435e55
-checkout examples/kdl-rs kdl-org/kdl-rs 8c028e5ea189470f07c5c848ab778f3d63ba89ab
-checkout examples/kdl-js kdl-org/kdljs bb874a595e6f712950795ecaad62f24fd945f03d
-checkout examples/kdl-php kdl-org/kdl-php 390fdc5ab8e2749feb01a113e8feb028de0861b3
-
-known_failures="$(cat script/known_failures.txt)"
-
-# Remove input directories
-find examples -type d -name input -exec rm -rf {} +
-
-tree-sitter parse -q \
-  'examples/**/*.kdl' \
-  "$(for file in $known_failures; do echo "!${file}"; done)"
-
-example_count=$(find examples -name '*.kdl' | wc -l)
-failure_count=$(wc -w <<< "$known_failures")
-success_count=$(( example_count - failure_count ))
-success_percent=$(bc -l <<< "100*${success_count}/${example_count}")
-
-printf \
-  "Successfully parsed %d of %d example files (%.1f%%)\n" \
-  $success_count "$example_count" "$success_percent"