tree-sitter-ghactions 0.1.2__tar.gz

tree_sitter_ghactions-0.1.2/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: tree-sitter-ghactions
+Version: 0.1.2
+Summary: Parser for Github Actions expressions
+Author-email: Robert Muir <rmuir@apache.org>
+License: MIT
+Project-URL: Homepage, https://github.com/rmuir/tree-sitter-ghactions
+Keywords: incremental,parsing,tree-sitter,github,actions
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: core
+Requires-Dist: tree-sitter~=0.25; extra == "core"
+
+# tree-sitter-ghactions
+
+Github Actions expressions grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+
+## Features
+
+* Parses Github Action's expressions: `${{ ... }}`
+* Plays well with `bash` injections in YAML documents
+* Passes parsing tests from [actionlint](https://github.com/rhysd/actionlint)
+
+## Neovim Installation (for use in your editor)
+
+1. Install [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter/tree/main)
+
+2. Configure autocmd for a custom parser:
+   
+```lua
+-- custom parsers
+vim.api.nvim_create_autocmd('User', {
+  pattern = 'TSUpdate',
+  callback = function()
+    require('nvim-treesitter.parsers').ghactions = {
+      install_info = {
+        url = 'https://github.com/rmuir/tree-sitter-ghactions',
+        queries = 'queries',
+      },
+    }
+  end,
+})
+```
+
+3. Configure yaml injection in `~/.config/nvim/queries/yaml/injections.scm`:
+```tsq
+; extends
+
+; github actions
+([
+  (string_scalar)
+  (block_scalar)
+  (double_quote_scalar)
+  (single_quote_scalar)
+] @injection.content
+  (#lua-match? @injection.content "[$]{{.*}}")
+  (#set! injection.language "ghactions"))
+```
+
+4. Run `:TSUpdate` from neovim.
+
+NOTE: these instructions are based upon the `main` branch of `nvim-treesitter`.
+
+## Bindings Installation (for development)
+
+Bindings are published to `pypi`, `npm`, and `crates.io` as `tree-sitter-ghactions`.
+Wasm and source code artifacts are published to [GitHub releases](https://github.com/rmuir/tree-sitter-ghactions/releases)
+
+## Screenshot of highlights
+
+![Syntax highlighting screenshot](https://github.com/user-attachments/assets/0c1f34bb-6f02-4175-9495-97e6fa51334a)

tree_sitter_ghactions-0.1.2/README.md

@@ -0,0 +1,58 @@
+# tree-sitter-ghactions
+
+Github Actions expressions grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+
+## Features
+
+* Parses Github Action's expressions: `${{ ... }}`
+* Plays well with `bash` injections in YAML documents
+* Passes parsing tests from [actionlint](https://github.com/rhysd/actionlint)
+
+## Neovim Installation (for use in your editor)
+
+1. Install [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter/tree/main)
+
+2. Configure autocmd for a custom parser:
+   
+```lua
+-- custom parsers
+vim.api.nvim_create_autocmd('User', {
+  pattern = 'TSUpdate',
+  callback = function()
+    require('nvim-treesitter.parsers').ghactions = {
+      install_info = {
+        url = 'https://github.com/rmuir/tree-sitter-ghactions',
+        queries = 'queries',
+      },
+    }
+  end,
+})
+```
+
+3. Configure yaml injection in `~/.config/nvim/queries/yaml/injections.scm`:
+```tsq
+; extends
+
+; github actions
+([
+  (string_scalar)
+  (block_scalar)
+  (double_quote_scalar)
+  (single_quote_scalar)
+] @injection.content
+  (#lua-match? @injection.content "[$]{{.*}}")
+  (#set! injection.language "ghactions"))
+```
+
+4. Run `:TSUpdate` from neovim.
+
+NOTE: these instructions are based upon the `main` branch of `nvim-treesitter`.
+
+## Bindings Installation (for development)
+
+Bindings are published to `pypi`, `npm`, and `crates.io` as `tree-sitter-ghactions`.
+Wasm and source code artifacts are published to [GitHub releases](https://github.com/rmuir/tree-sitter-ghactions/releases)
+
+## Screenshot of highlights
+
+![Syntax highlighting screenshot](https://github.com/user-attachments/assets/0c1f34bb-6f02-4175-9495-97e6fa51334a)

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions/__init__.py

@@ -0,0 +1,53 @@
+"""Parser for Github Actions expressions"""
+
+from importlib.resources import files as _files
+
+from ._binding import language
+
+
+def _get_query(name, file):
+    query = _files(f"{__package__}.queries") / file
+    globals()[name] = query.read_text()
+    return globals()[name]
+
+
+def __getattr__(name):
+    # NOTE: uncomment these to include any queries that this grammar contains:
+
+    if name == "HIGHLIGHTS_QUERY":
+        return _get_query("HIGHLIGHTS_QUERY", "highlights.scm")
+    # if name == "INJECTIONS_QUERY":
+    #     return _get_query("INJECTIONS_QUERY", "injections.scm")
+    # if name == "LOCALS_QUERY":
+    #     return _get_query("LOCALS_QUERY", "locals.scm")
+    # if name == "TAGS_QUERY":
+    #     return _get_query("TAGS_QUERY", "tags.scm")
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+__all__ = [
+    "language",
+    "HIGHLIGHTS_QUERY",
+    # "INJECTIONS_QUERY",
+    # "LOCALS_QUERY",
+    # "TAGS_QUERY",
+]
+
+
+def __dir__():
+    return sorted(
+        __all__
+        + [
+            "__all__",
+            "__builtins__",
+            "__cached__",
+            "__doc__",
+            "__file__",
+            "__loader__",
+            "__name__",
+            "__package__",
+            "__path__",
+            "__spec__",
+        ]
+    )

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions/__init__.pyi

@@ -0,0 +1,10 @@
+from typing import Final
+
+# NOTE: uncomment these to include any queries that this grammar contains:
+
+HIGHLIGHTS_QUERY: Final[str]
+# INJECTIONS_QUERY: Final[str]
+# LOCALS_QUERY: Final[str]
+# TAGS_QUERY: Final[str]
+
+def language() -> object: ...

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions/binding.c

@@ -0,0 +1,32 @@
+#include <Python.h>
+
+typedef struct TSLanguage TSLanguage;
+
+TSLanguage *tree_sitter_ghactions(void);
+
+static PyObject *_binding_language(PyObject *Py_UNUSED(self),
+                                   PyObject *Py_UNUSED(args)) {
+  return PyCapsule_New(tree_sitter_ghactions(), "tree_sitter.Language", NULL);
+}
+
+static struct PyModuleDef_Slot slots[] = {
+#ifdef Py_GIL_DISABLED
+    {Py_mod_gil, Py_MOD_GIL_NOT_USED},
+#endif
+    {0, NULL}};
+
+static PyMethodDef methods[] = {
+    {"language", _binding_language, METH_NOARGS,
+     "Get the tree-sitter language for this grammar."},
+    {NULL, NULL, 0, NULL}};
+
+static struct PyModuleDef module = {
+    .m_base = PyModuleDef_HEAD_INIT,
+    .m_name = "_binding",
+    .m_doc = NULL,
+    .m_size = 0,
+    .m_methods = methods,
+    .m_slots = slots,
+};
+
+PyMODINIT_FUNC PyInit__binding(void) { return PyModuleDef_Init(&module); }

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.4
+Name: tree-sitter-ghactions
+Version: 0.1.2
+Summary: Parser for Github Actions expressions
+Author-email: Robert Muir <rmuir@apache.org>
+License: MIT
+Project-URL: Homepage, https://github.com/rmuir/tree-sitter-ghactions
+Keywords: incremental,parsing,tree-sitter,github,actions
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Compilers
+Classifier: Topic :: Text Processing :: Linguistic
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+Provides-Extra: core
+Requires-Dist: tree-sitter~=0.25; extra == "core"
+
+# tree-sitter-ghactions
+
+Github Actions expressions grammar for [tree-sitter](https://github.com/tree-sitter/tree-sitter)
+
+## Features
+
+* Parses Github Action's expressions: `${{ ... }}`
+* Plays well with `bash` injections in YAML documents
+* Passes parsing tests from [actionlint](https://github.com/rhysd/actionlint)
+
+## Neovim Installation (for use in your editor)
+
+1. Install [nvim-treesitter](https://github.com/nvim-treesitter/nvim-treesitter/tree/main)
+
+2. Configure autocmd for a custom parser:
+   
+```lua
+-- custom parsers
+vim.api.nvim_create_autocmd('User', {
+  pattern = 'TSUpdate',
+  callback = function()
+    require('nvim-treesitter.parsers').ghactions = {
+      install_info = {
+        url = 'https://github.com/rmuir/tree-sitter-ghactions',
+        queries = 'queries',
+      },
+    }
+  end,
+})
+```
+
+3. Configure yaml injection in `~/.config/nvim/queries/yaml/injections.scm`:
+```tsq
+; extends
+
+; github actions
+([
+  (string_scalar)
+  (block_scalar)
+  (double_quote_scalar)
+  (single_quote_scalar)
+] @injection.content
+  (#lua-match? @injection.content "[$]{{.*}}")
+  (#set! injection.language "ghactions"))
+```
+
+4. Run `:TSUpdate` from neovim.
+
+NOTE: these instructions are based upon the `main` branch of `nvim-treesitter`.
+
+## Bindings Installation (for development)
+
+Bindings are published to `pypi`, `npm`, and `crates.io` as `tree-sitter-ghactions`.
+Wasm and source code artifacts are published to [GitHub releases](https://github.com/rmuir/tree-sitter-ghactions/releases)
+
+## Screenshot of highlights
+
+![Syntax highlighting screenshot](https://github.com/user-attachments/assets/0c1f34bb-6f02-4175-9495-97e6fa51334a)

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+setup.py
+bindings/python/tree_sitter_ghactions/__init__.py
+bindings/python/tree_sitter_ghactions/__init__.pyi
+bindings/python/tree_sitter_ghactions/binding.c
+bindings/python/tree_sitter_ghactions/py.typed
+bindings/python/tree_sitter_ghactions.egg-info/PKG-INFO
+bindings/python/tree_sitter_ghactions.egg-info/SOURCES.txt
+bindings/python/tree_sitter_ghactions.egg-info/dependency_links.txt
+bindings/python/tree_sitter_ghactions.egg-info/not-zip-safe
+bindings/python/tree_sitter_ghactions.egg-info/requires.txt
+bindings/python/tree_sitter_ghactions.egg-info/top_level.txt
+src/parser.c

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/not-zip-safe

@@ -0,0 +1 @@
+

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/requires.txt

@@ -0,0 +1,3 @@
+
+[core]
+tree-sitter~=0.25

tree_sitter_ghactions-0.1.2/bindings/python/tree_sitter_ghactions.egg-info/top_level.txt

@@ -0,0 +1,2 @@
+_binding
+tree_sitter_ghactions

tree_sitter_ghactions-0.1.2/pyproject.toml

@@ -0,0 +1,29 @@
+[build-system]
+requires = ["setuptools>=62.4.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tree-sitter-ghactions"
+description = "Parser for Github Actions expressions"
+version = "0.1.2"
+keywords = ["incremental", "parsing", "tree-sitter", "github", "actions"]
+classifiers = [
+  "Intended Audience :: Developers",
+  "Topic :: Software Development :: Compilers",
+  "Topic :: Text Processing :: Linguistic",
+  "Typing :: Typed",
+]
+authors = [{ name = "Robert Muir", email = "rmuir@apache.org" }]
+requires-python = ">=3.10"
+license.text = "MIT"
+readme = "README.md"
+
+[project.urls]
+Homepage = "https://github.com/rmuir/tree-sitter-ghactions"
+
+[project.optional-dependencies]
+core = ["tree-sitter~=0.25"]
+
+[tool.cibuildwheel]
+build = "cp310-*"
+build-frontend = "build"

tree_sitter_ghactions-0.1.2/queries/highlights.scm

@@ -0,0 +1,83 @@
+; note: all highlights are set to priority 101, for compatibility with bash injections in yaml
+([
+  "${{"
+  "}}"
+] @keyword
+  (#set! priority 101))
+
+([
+  "&&"
+  "||"
+  "=="
+  "!="
+  "<"
+  "<="
+  ">"
+  ">="
+  "+"
+  "-"
+  "!"
+] @operator
+  (#set! priority 101))
+
+([
+  "("
+  ")"
+  "["
+  "]"
+] @punctuation.bracket
+  (#set! priority 101))
+
+([
+  ","
+  "."
+] @punctuation.delimiter
+  (#set! priority 101))
+
+("*" @punctuation.special
+  (#set! priority 101))
+
+((number) @number
+  (#set! priority 101))
+
+((identifier) @variable
+  (#set! priority 101))
+
+; https://docs.github.com/en/actions/reference/workflows-and-actions/contexts
+(dereference_expression
+  object: (identifier) @module.builtin
+  (#any-of? @module.builtin
+    "github" "env" "vars" "job" "jobs" "steps" "runner" "secrets" "strategy" "matrix" "needs"
+    "inputs")
+  (#set! priority 101))
+
+((dereference_expression
+  property: (identifier) @property)
+  (#set! priority 101))
+
+((function_call
+  name: (identifier) @function.call)
+  (#set! priority 101))
+
+; https://docs.github.com/en/actions/reference/workflows-and-actions/expressions#functions
+((function_call
+  name: (identifier) @function.builtin
+  (#any-of? @function.builtin
+    "contains" "startsWith" "endsWith" "format" "join" "toJSON" "fromJSON" "hashFiles" "success"
+    "always" "cancelled" "failure"))
+  (#set! priority 101))
+
+([
+  (true)
+  (false)
+] @boolean
+  (#set! priority 101))
+
+((null) @constant.builtin
+  (#set! priority 101))
+
+((string) @string
+  (#set! priority 101))
+
+((escape) @string.escape
+  (#set! priority 101))

tree_sitter_ghactions-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tree_sitter_ghactions-0.1.2/setup.py

@@ -0,0 +1,77 @@
+from os import path
+from platform import system
+from sysconfig import get_config_var
+
+from setuptools import Extension, find_packages, setup
+from setuptools.command.build import build
+from setuptools.command.egg_info import egg_info
+from wheel.bdist_wheel import bdist_wheel
+
+sources = [
+    "bindings/python/tree_sitter_ghactions/binding.c",
+    "src/parser.c",
+]
+if path.exists("src/scanner.c"):
+    sources.append("src/scanner.c")
+
+macros: list[tuple[str, str | None]] = [
+    ("PY_SSIZE_T_CLEAN", None),
+    ("TREE_SITTER_HIDE_SYMBOLS", None),
+]
+if limited_api := not get_config_var("Py_GIL_DISABLED"):
+    macros.append(("Py_LIMITED_API", "0x030A0000"))
+
+if system() != "Windows":
+    cflags = ["-std=c11", "-fvisibility=hidden"]
+else:
+    cflags = ["/std:c11", "/utf-8"]
+
+
+class Build(build):
+    def run(self):
+        if path.isdir("queries"):
+            dest = path.join(self.build_lib, "tree_sitter_ghactions", "queries")
+            self.copy_tree("queries", dest)
+        super().run()
+
+
+class BdistWheel(bdist_wheel):
+    def get_tag(self):
+        python, abi, platform = super().get_tag()
+        if python.startswith("cp"):
+            python, abi = "cp310", "abi3"
+        return python, abi, platform
+
+
+class EggInfo(egg_info):
+    def find_sources(self):
+        super().find_sources()
+        self.filelist.recursive_include("queries", "*.scm")
+        self.filelist.include("src/tree_sitter/*.h")
+
+
+setup(
+    packages=find_packages("bindings/python"),
+    package_dir={"": "bindings/python"},
+    package_data={
+        "tree_sitter_ghactions": ["*.pyi", "py.typed"],
+        "tree_sitter_ghactions.queries": ["*.scm"],
+    },
+    ext_package="tree_sitter_ghactions",
+    ext_modules=[
+        Extension(
+            name="_binding",
+            sources=sources,
+            extra_compile_args=cflags,
+            define_macros=macros,
+            include_dirs=["src"],
+            py_limited_api=limited_api,
+        )
+    ],
+    cmdclass={
+        "build": Build,
+        "bdist_wheel": BdistWheel,
+        "egg_info": EggInfo,
+    },
+    zip_safe=False,
+)