tabry 0.1.1 → 0.1.2

data/treesitter/grammar.js

@@ -0,0 +1,171 @@
+module.exports = grammar({
+  name: 'tabry',
+
+  rules: {
+    source_file: $ => repeat($._toplevel_statement),
+
+    _toplevel_statement: $ => choice(
+      $._common_statement,
+      $.cmd_statement,
+      $.defopts_statement,
+      $.defargs_statement,
+    ),
+
+    // TODO fix restrictions here, e.g. can't have flagarg inside flagarg
+    // make an _opts_block_statement with only opts_*_statement. and make an opts_block
+    _common_statement: $ => choice(
+      $.arg_statement,
+      $.flagarg_statement,
+      $.flag_statement,
+      $.sub_statement,
+      $._comment,
+      $.desc_statement,
+      $.include_statement,
+    ),
+
+    _block_statement: $ => choice(
+      $._common_statement,
+      $.opts_const_statement,
+      $.opts_shell_statement,
+      $.opts_file_statement,
+      $.opts_dir_statement,
+      $.title_statement,
+    ),
+
+    include_statement: $ => seq(
+      'include',
+      $.at_identifier,
+    ),
+
+    // TODO limit types of statements inside defopts and defargs etc.
+    defopts_statement: $ => seq(
+      'defopts',
+      $.at_identifier,
+      $.block,
+    ),
+    defargs_statement: $ => seq(
+      'defargs',
+      $.at_identifier,
+      $.block,
+    ),
+
+    at_identifier: $ => /@[a-zA-Z_][a-zA-Z0-9_-]*/,
+
+    _comment: $ => /#.*/,
+
+    sub_statement: $ => seq(
+      'sub',
+      field('names', $.sub_name_list),
+      optional(field('desc', $.string)),
+      repeat($.at_identifier),
+      optional($.block),
+    ),
+
+    cmd_statement: $ => seq(
+      'cmd',
+      $.string,
+    ),
+
+    desc_statement: $ => seq(
+      'desc',
+      $.string,
+    ),
+
+    title_statement: $ => seq(
+      'title',
+      $.string,
+    ),
+
+    arg_type: $ => choice(
+      'arg',
+      'varargs',
+    ),
+
+    arg_statement: $ => seq(
+      optional($.arg_modifier),
+      // restrictions:
+      // * 'arg' or 'varargs' cannot after 'args'.
+      // * non-optional arg(s) cannot come after optional arg
+      $.arg_type,
+      optional(
+        choice(
+          seq($.arg_name_list, $.string),
+          seq($.arg_name_list)
+        )
+      ),
+      repeat(
+        field("at", $.at_identifier),
+      ),
+      optional($.block),
+    ),
+
+    opts_const_statement: $ => seq(
+      'opts',
+      'const', // TODO this is weird: doesn't require a space between them
+      $._strings,
+    ),
+
+    opts_shell_statement: $ => seq(
+      'opts',
+      'shell',
+      $.string,
+    ),
+
+    opts_file_statement: $ => seq(
+      'opts',
+      'file',
+    ),
+
+    opts_dir_statement: $ => seq(
+      'opts',
+      'dir',
+    ),
+
+    flagarg_statement: $ => seq(
+      optional($.flag_modifier),
+      'flagarg',
+      field('names', $.flag_name_list),
+      optional(field('desc', $.string)),
+      repeat($.at_identifier),
+      optional($.block),
+    ),
+
+    flag_statement: $ => seq(
+      optional($.flag_modifier),
+      'flag',
+      field('names', $.flag_name_list),
+      optional(field('desc', $.string)),
+      repeat($.at_identifier),
+      optional($.block),
+    ),
+
+    flag_modifier: $ => choice(
+      'reqd',
+    ),
+
+    arg_modifier: $ => 'opt',
+
+    block: $ => seq(
+      '{',
+      repeat1($._block_statement),
+      '}',
+    ),
+
+    flag_name_list: $ => $._strings,
+    arg_name_list: $ => $._strings,
+    sub_name_list: $ => $._strings,
+
+    _strings: $ => choice(
+      $.string,
+      $._strings_list,
+    ),
+
+    string: $ => /[A-Za-z_][a-zA-Z0-9_,-]*|"([^"\\]|\\"|\\\\)*"/,
+
+    _strings_list: $ => seq(
+      '(',
+      repeat1($.string),
+      ')',
+    ),
+  }
+});

data/treesitter/jest_fixtures/examples_from_language_reference/argument_titles.yml

@@ -0,0 +1,8 @@
+cmd: null
+main:
+  args:
+    - name: thing_to_search_for
+      title: thing to search for
+    - name: files_to_load
+      title: "file to load"
+      varargs: true

data/treesitter/jest_fixtures/examples_from_language_reference/arguments_and_possible_options__arg_.yml

@@ -0,0 +1,23 @@
+cmd: null
+main:
+  args:
+    - name: vehicle_type1
+    - name: vehicle_type3
+      description: The type of vehicle
+    - name: vehicle_type4
+      description: The type of vehicle
+    - options:
+        - type: const
+          value: a
+    - name: bool1
+      options:
+        - type: const
+          value: T
+        - type: const
+          value: F
+    - name: bool2
+      options:
+        - type: const
+          value: T
+        - type: const
+          value: F

data/treesitter/jest_fixtures/examples_from_language_reference/flags__flag__flagarg__reqd_flagarg_.yml

@@ -0,0 +1,37 @@
+cmd: null
+main:
+  flags:
+    - name: dry-run
+      aliases:
+        - d
+    - name: dry-run2
+      aliases:
+        - r
+      description: Don't act, only show what would be done
+    - name: f
+      aliases:
+        - format
+      arg: true
+      options:
+        - type: const
+          value: json
+        - type: const
+          value: yml
+    - name: env
+      aliases:
+        - e
+      description: The environment (this must be given)
+      arg: true
+      options:
+        - type: const
+          value: prod
+        - type: const
+          value: beta
+        - type: const
+          value: dev
+    - name: interactive
+      aliases:
+        - i
+    - name: force
+      aliases:
+        - f

data/treesitter/jest_fixtures/examples_from_language_reference/getting_started.yml

@@ -0,0 +1,13 @@
+cmd: control-vehicle
+main:
+  args:
+    - options:
+        - type: const
+          value: car
+        - type: const
+          value: bike
+    - options:
+        - type: const
+          value: go
+        - type: const
+          value: stop

data/treesitter/jest_fixtures/examples_from_language_reference/includes.yml

@@ -0,0 +1,57 @@
+cmd: mydeploy
+main:
+  args:
+    - include: project-and-environment
+  flags:
+    - include: project-and-environment
+  subs:
+    - include: project-and-environment
+    - name: status
+      args:
+        - include: project-and-environment
+        - include: verbose
+      flags:
+        - include: project-and-environment
+        - include: verbose
+      subs:
+        - include: project-and-environment
+        - include: verbose
+    - name: list
+      args:
+        - include: verbose
+      flags:
+        - include: verbose
+        - name: env
+          options:
+            - type: include
+              value: environment
+          arg: true
+      subs:
+        - include: verbose
+option_includes:
+  environment:
+    - type: const
+      value: prod
+    - type: const
+      value: beta
+    - type: const
+      value: dev
+arg_includes:
+  verbose:
+    flags:
+      - name: verbose
+        description: Show more info
+  project-and-environment:
+    args:
+      - name: project
+        description: The project
+        options:
+          - type: const
+            value: project1
+          - type: const
+            value: project2
+      - name: environment
+        options:
+          - type: include
+            value: environment
+        description: The environment

data/treesitter/jest_fixtures/examples_from_language_reference/multi_line_descriptions.yml

@@ -0,0 +1,7 @@
+cmd: null
+main:
+  subs:
+    - name: mycmd
+      description: |-
+        My command:
+          * It does stuff

data/treesitter/jest_fixtures/examples_from_language_reference/optional_args_and_varargs__opt_arg__varargs__opt_varargs_.yml

@@ -0,0 +1,16 @@
+cmd: null
+main:
+  args:
+    - name: first-arg-mandatory
+    - name: second-arg-optional
+      optional: true
+    - name: rest-args-optional
+      optional: true
+      varargs: true
+      options:
+        - type: const
+          value: foo
+        - type: const
+          value: bar
+        - type: const
+          value: waz

data/treesitter/jest_fixtures/examples_from_language_reference/options.yml

@@ -0,0 +1,24 @@
+cmd: null
+main:
+  args:
+    - options:
+        - type: const
+          value: hello
+        - type: const
+          value: hello "world"
+        - type: const
+          value: T
+        - type: const
+          value: F
+        - type: const
+          value: "true"
+        - type: const
+          value: "false"
+        - type: const
+          value: "yes"
+        - type: const
+          value: "no"
+        - type: shell
+          value: mycmd list-things
+        - type: file
+        - type: dir

data/treesitter/jest_fixtures/examples_from_language_reference/subcommands__sub__1.yml

@@ -0,0 +1,23 @@
+cmd: null
+main:
+  subs:
+    - name: list
+      description: List the things
+    - name: new
+      aliases:
+        - "n"
+      description: Create a thing
+    - name: delete
+      aliases:
+        - d
+      description: Delete a thing
+      args:
+        - name: thing
+          description: The thing to delete
+          options:
+            - type: shell
+              value: mycmd list
+    - name: do-something
+    - name: do-something-else
+      aliases:
+        - dse

data/treesitter/jest_fixtures/examples_from_language_reference/subcommands__sub__2.yml

@@ -0,0 +1,15 @@
+cmd: foo
+main:
+  args:
+    - name: toplevel-arg
+  flags:
+    - name: dryrun
+  subs:
+    - name: mysub1
+      subs:
+        - name: mysub2
+          flags:
+            - name: someopt
+          args:
+            - name: mysub2-arg
+              optional: true

data/treesitter/package.json

@@ -0,0 +1,21 @@
+{
+  "name": "tree-sitter-tabry",
+  "version": "1.0.0",
+  "description": "",
+  "main": "bindings/node",
+  "scripts": {
+    "test": "tree-sitter test",
+    "gen": "tree-sitter generate"
+  },
+  "author": "",
+  "license": "ISC",
+  "dependencies": {
+    "nan": "^2.15.0",
+    "tree-sitter": "^0.20.0",
+    "yaml": "^2.0.0-8"
+  },
+  "devDependencies": {
+    "jest": "^27.5.1",
+    "tree-sitter-cli": "^0.20.0"
+  }
+}

data/treesitter/parser_compile.sh

@@ -0,0 +1 @@
+npx tree-sitter generate && npx tree-sitter test && npx node-gyp rebuild