Metadata-Version: 2.4
Name: tree-sitter-pod
Version: 1.1.0
Summary: Pod grammar for tree-sitter
License: MIT
Project-URL: Homepage, https://github.com/tree-sitter-perl/tree-sitter-pod
Keywords: incremental,parsing,tree-sitter,pod
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Topic :: Software Development :: Compilers
Classifier: Topic :: Text Processing :: Linguistic
Classifier: Typing :: Typed
Requires-Python: >=3.9
Description-Content-Type: text/markdown
License-File: LICENSE
Provides-Extra: core
Requires-Dist: tree-sitter~=0.24; extra == "core"
Dynamic: license-file

# tree-sitter-pod

A tree-sitter parser for Perl's POD syntax

## Getting Started Developing

To get started, install the dependencies for this repo

```bash
npm i
```

That should get you set up with tree-sitter's cli locally.

### Generating the Bindings

In this project, the generated C source code (stored in the `src` directory) is
.gitignored. In order to generate it, run

```bash
npx tree-sitter generate 
```

You'll need to do this after any changes to the grammar.

### Running the tests

Tests are stored in the `/test/corpus` directory, as txt files. A little reference on the
syntax can be found [here](https://tree-sitter.github.io/tree-sitter/creating-parsers#command-test).

You can run the tests with 

```bash
npx tree-sitter test
```

See the help output (`-h`) for that command for some more details on using the test
runner.
