https://github.com/carocad/parcera
Grammar-based Clojure(script) parser
https://github.com/carocad/parcera
antlr4 ast clojure grammar parser reader
Last synced: about 1 month ago
JSON representation
Grammar-based Clojure(script) parser
- Host: GitHub
- URL: https://github.com/carocad/parcera
- Owner: carocad
- License: lgpl-3.0
- Created: 2019-09-28T11:42:51.000Z (over 5 years ago)
- Default Branch: master
- Last Pushed: 2021-01-03T19:57:48.000Z (over 4 years ago)
- Last Synced: 2025-04-09T21:17:01.438Z (about 1 month ago)
- Topics: antlr4, ast, clojure, grammar, parser, reader
- Language: Clojure
- Homepage:
- Size: 369 KB
- Stars: 108
- Watchers: 4
- Forks: 6
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE.md
Awesome Lists containing this project
README
# parcera
[](https://travis-ci.com/carocad/parcera)
[](https://clojars.org/carocad/parcera)
[](https://cljdoc.org/d/carocad/parcera/)
Grammar-based Clojure(script) parser.
Parcera can safely read any Clojure file without any code evaluation.
Parcera uses the wonderful [Antlr4](https://github.com/antlr/antlr4/) as its
parsing engine and focuses on the grammar definition instead.
If you are interested in the grammar definition check [Clojure.g4](./src/Clojure.g4).
## setup
- Java
Add `[org.antlr/antlr4-runtime "4.7.1"]` to your dependencies in addition to parcera.
This is to avoid adding an unnecessary dependency for the JavaScript users.
- Javascript
All necessary files are delivered with parcera. However, currently only Browser support
has been tested.
- Babashka
Check out [babashka's pod for parcera](https://github.com/babashka/pod-babashka-parcera). Made by [@borkdude](https://github.com/borkdude)
## usage
```clojure
(ns example.core
(:require [parcera.core :as parcera]))
;;parse clojure code from a string
(parcera/ast (str '(ns parcera.core
(:require [clojure.data :as data]
[clojure.string :as str]))))
;; => returns a data structure with the result from the parser
(:code
(:list
(:symbol "ns")
(:whitespace " ")
(:symbol "parcera.core")
(:whitespace " ")
(:list
(:keyword ":require")
(:whitespace " ")
(:vector (:symbol "clojure.data") (:whitespace " ") (:keyword ":as") (:whitespace " ") (:symbol "data"))
(:whitespace " ")
(:vector (:symbol "clojure.string") (:whitespace " ") (:keyword ":as") (:whitespace " ") (:symbol "str")))))
;; get meta data from the parsed code
(meta (second (parcera/ast (str :hello))))
#:parcera.core{:start {:row 1, :column 0}, :end {:row 1, :column 6}}
;; convert an AST back into a string
(parcera/code [:symbol "ns"])
;; "ns"
```
## contributing
- to get you setup check the [travis](./.travis.yml) file which
already contains a full setup from scratch.
- the project contains a benchmark which should be the decision factor for
performance issues.
- please follow [Clojure's Etiquete](https://www.clojure.org/community/etiquette)
for issues and pull requests