tabry 0.1.1 → 0.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a813a02fd7d1076dfe3f3ee4076fa7d0b4f9fe5c7dae2722f60f7ad0b693fb35
-  data.tar.gz: 0b3631d634da37690deb4e405b856e06f7b12aa8af464a3b4a011d0e68938a57
+  metadata.gz: 853b43dede9ba1a93e3581eefd4dbe883ec0cbef4cf493776183df0d363fed3e
+  data.tar.gz: f8bb31ead64b56da0f0bbabe051219fca8e40ade773b730b4295d990b5fe03b5
 SHA512:
-  metadata.gz: cf85b3d904c1b02b868e205b654328c99ee733c97950c0182a8c5ffc48dcf281443eab28fc870945cad1eb4a34f39af9f2badc1a725506db38d58fd9d417665a
-  data.tar.gz: fdf3ba0343a7ab8b2254a4c9d49996ea18d37854e7fce2c11ccbcf0b456667f636f84d05d6811dde97276f4805372e3669f708a67ca5e4b16201da4ef524f8eb
+  metadata.gz: 463f392cad04097474a34abd6bf78d9bf3dfb88a7af8867f3879bcce514ec07c5d8d9acddcb01e8cb6dbb286545085ccd72fdaeb2686d7e1f738eae2405752b4
+  data.tar.gz: 1f877f562de0e3b3d08421b087cc66d00efc2875807da22b88fec70068aaa55b512840eb12e3414a9813e6932017a7737cb5ad5e91df19024627095536cb1275

data/lib/tabry/shells/bash.rb

@@ -1,17 +1,26 @@
+# frozen_string_literal: true
+
+# Used to generate a tab-completion function for a Tabry CLI using absolute
+# paths to the tabry-bash script in this repo and to the Tabry JSON/YML file.
+# Using uniquely-named tab-completion functions and absolute paths means you can
+# have different Tabry-based CLIs using different versions of Tabry without any
+# conflicts.
+# See sh/bash/README.md and "Adding Tab Completion to your CLI" in main README
+
 module Tabry
   module Shells
     module Bash
       # NOTE! This code uses sh/bash/tabry_bash_core.sh and is described in
       # sh/bash/README.md; see that README for more info
       def self.generate(cmd_name, tabry_file_path)
-        capitalized_cmd_name = cmd_name.upcase.gsub(/[^a-zA-Z0-9_]/, '_')
+        capitalized_cmd_name = cmd_name.upcase.gsub(/[^a-zA-Z0-9_]/, "_")
         tabry_file = Shellwords.escape(File.expand_path(tabry_file_path))
         path_to_tabry = Shellwords.escape(File.expand_path("#{__dir__}/../../../"))
 
         core = File.read("#{__dir__}/../../../sh/bash/tabry_bash_core.sh")
         core.gsub! "_tabry_completions_internal()", "_tabry_#{capitalized_cmd_name}_completions_internal()"
 
-        return <<~END + core
+        <<~END_BASH_CODE_TEMPLATE + core
           # The following Autocomplete is for a Tabry-powered command. It was
           # generated by the command itself. See the documentation located in
           # #{path_to_tabry}/sh/bash/README.md
@@ -19,10 +28,8 @@ module Tabry
             TABRY_IMPORTS_PATH=#{tabry_file} _tabry_#{capitalized_cmd_name}_completions_internal #{path_to_tabry}/bin/tabry-bash
           }
           complete -F _tabry_#{capitalized_cmd_name}_completions #{Shellwords.escape cmd_name}
-        END
+        END_BASH_CODE_TEMPLATE
       end
     end
   end
 end
-
-

data/sh/bash/README.md

@@ -23,11 +23,12 @@ This file and bash function contained within is used in two ways:
   added on, to make tab completion specific for the program. This is generated
   for each command when the user runs "mycommand completion bash", which calls
   `Tabry::Shells::Bash.generate`. A new function for each CLI so different CLIs
-  can use different versions of tabrygq without interfering with each other.
+  can use different versions of tabry without interfering with each other.
   The name `_tabry_completions_internal_` is replaced in
   `lib/tabry/shells/bash.rb` in the `generate` method, so if modifying
   `tabry_bash_core.sh`, you should if make sure the substitution still works
   properly.
+  See also "Adding Tab Completion to your CLI" in the main README.
 * You can also use Tabry to add tab completion to other non-Tabry CLIs. In this
   case, the `_tabry_completions_internal_` function is used as-is; it is
   sourced from `tabry_bash.sh`. See `tabry_bash.sh` for details and

data/tabry.gemspec

@@ -6,14 +6,31 @@ $LOAD_PATH.unshift(lib) unless $LOAD_PATH.include?(lib)
 
 Gem::Specification.new do |s|
   s.name        = "tabry"
-  s.version     = "0.1.1"
+  s.version     = "0.1.2"
   s.summary     = "Tab completion and CLIs extraordinaire"
   s.authors     = ["Evan Battaglia"]
   s.email       = "battaglia.evan@gmail.com"
   s.homepage    = "https://github.com/evanbattaglia/tabry"
   s.license     = "MIT"
 
-  s.files         = Dir.glob("{lib,bin,sh,spec}/**/*") + %w[tabry.gemspec]
+  treesitter_files = %w[
+    binding.gyp
+    bindings/**/*
+    Cargo.toml
+    corpus/**/*
+    grammar.js
+    jest_fixtures/**/*
+    package.json
+    parser_compile.sh
+    README.md
+    src/**/*
+    tabry-compile.js
+    tabry-compile.test.js
+  ]
+
+  s.files         = Dir.glob("{lib,bin,sh,spec}/**/*") + %w[tabry.gemspec] +
+                    treesitter_files.map { |path| Dir.glob("treesitter/#{path}") }
+
   # TODO: more cargo cult possibly:
   s.executables   = s.files.grep(%r{^bin/}) { |f| File.basename(f) }
   s.require_paths = ["lib"]

data/treesitter/Cargo.toml

@@ -0,0 +1,26 @@
+[package]
+name = "tree-sitter-tabry"
+description = "tabry grammar for the tree-sitter parsing library"
+version = "0.0.1"
+keywords = ["incremental", "parsing", "tabry"]
+categories = ["parsing", "text-editors"]
+repository = "https://github.com/tree-sitter/tree-sitter-tabry"
+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.20.0"
+
+[build-dependencies]
+cc = "1.0"

data/treesitter/README.md

@@ -0,0 +1,4 @@
+This directory contains the compiler which compiles `*.tabry` files -- Tabry's
+mini-language for describing tab-completion/CLIs, into the JSON format used by
+the tabry gem. See the [main Tabry README](../README.md) for more info on
+compiling and using configs.

data/treesitter/binding.gyp

@@ -0,0 +1,19 @@
+{
+  "targets": [
+    {
+      "target_name": "tree_sitter_tabry_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",
+      ]
+    }
+  ]
+}

data/treesitter/bindings/node/binding.cc

@@ -0,0 +1,28 @@
+#include "tree_sitter/parser.h"
+#include <node.h>
+#include "nan.h"
+
+using namespace v8;
+
+extern "C" TSLanguage * tree_sitter_tabry();
+
+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_tabry());
+
+  Nan::Set(instance, Nan::New("name").ToLocalChecked(), Nan::New("tabry").ToLocalChecked());
+  Nan::Set(module, Nan::New("exports").ToLocalChecked(), instance);
+}
+
+NODE_MODULE(tree_sitter_tabry_binding, Init)
+
+}  // namespace

data/treesitter/bindings/node/index.js

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

data/treesitter/bindings/rust/build.rs

@@ -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());
+    */
+}

data/treesitter/bindings/rust/lib.rs

@@ -0,0 +1,52 @@
+//! This crate provides tabry 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_tabry::language()).expect("Error loading tabry 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_tabry() -> 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_tabry() }
+}
+
+/// 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 tabry language");
+    }
+}

data/treesitter/corpus/arg.txt

@@ -0,0 +1,96 @@
+==============
+Arg with two opts
+==============
+
+arg {
+  opts const "hello \"world\""
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (block
+      (opts_const_statement (string))
+      (opts_const_statement (string)))))
+
+==============
+Named args
+==============
+
+arg foo
+arg foo @whatever
+arg foo @whatever {
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string)))
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier))
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier)
+    (block
+      (opts_const_statement (string)))))
+
+============
+Name and description
+============
+
+arg foo "my description"
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string))
+    (string)))
+
+============
+Names and description
+============
+
+arg (foo bar) "my description"
+
+---
+
+(source_file
+  (arg_statement
+    (arg_type)
+    (arg_name_list (string) (string))
+    (string)))
+
+============
+Optional arg
+============
+
+opt arg
+opt arg foo @whatever {
+  opts const abc
+}
+
+---
+
+(source_file
+  (arg_statement
+    (arg_modifier)
+    (arg_type))
+  (arg_statement
+    (arg_modifier)
+    (arg_type)
+    (arg_name_list (string))
+    (at_identifier)
+    (block
+      (opts_const_statement (string)))))
+

data/treesitter/corpus/at.txt

@@ -0,0 +1,79 @@
+==========
+At include
+==========
+
+sub ok {
+  arg {
+    include @foo
+    opts const abc
+  }
+}
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list (string))
+    (block
+      (arg_statement
+        (arg_type)
+        (block
+          (include_statement
+            (at_identifier))
+          (opts_const_statement
+            (string)))))))
+
+=============
+At definition
+=============
+
+defopts @bar {
+  opts const def
+}
+
+defargs @foo {
+  arg
+}
+
+---
+
+(source_file
+  (defopts_statement
+    (at_identifier)
+    (block
+      (opts_const_statement (string))))
+  (defargs_statement
+    (at_identifier)
+    (block
+      (arg_statement
+        (arg_type)))))
+
+=================
+Inline at include
+=================
+
+sub whatever @foo {
+  flagarg foo @wombat
+  arg @bar {
+    opts const abc
+  }
+}
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list (string))
+    (at_identifier)
+    (block
+      (flagarg_statement
+        (flag_name_list (string))
+        (at_identifier))
+      (arg_statement
+        (arg_type)
+        (at_identifier)
+        (block
+          (opts_const_statement
+            (string)))))))
+
+

data/treesitter/corpus/comment.txt

@@ -0,0 +1,13 @@
+========
+Comments
+========
+
+# hello
+sub foo # ok
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list
+      (string))))

data/treesitter/corpus/desc.txt

@@ -0,0 +1,25 @@
+==========
+Desc
+==========
+
+sub ok {
+  desc foo
+  arg {
+    desc "bar"
+  }
+}
+
+---
+
+(source_file
+  (sub_statement
+    (sub_name_list
+      (string))
+    (block
+      (desc_statement
+        (string))
+      (arg_statement
+        (arg_type)
+        (block
+          (desc_statement
+            (string)))))))