mirror of https://github.com/github/semantic.git synced 2024-12-26 08:25:19 +03:00

History

Ayman Nadeem aacbc6539e Update semantic-parse.cabal		2020-02-07 19:38:24 -05:00
..
app	s/ast/parse	2020-02-06 12:39:24 -05:00
CHANGELOG.md	Add a semantic-parse package.	2020-02-04 14:25:39 -05:00
LICENSE	Add a semantic-parse package.	2020-02-04 14:25:39 -05:00
README.md	Update the references.	2020-02-04 14:28:34 -05:00
semantic-parse.cabal	Update semantic-parse.cabal	2020-02-07 19:38:24 -05:00
Setup.hs	Add a semantic-parse package.	2020-02-04 14:25:39 -05:00

README.md

semantic-parse

This package provides a command line tool that will output ASTs in supported formats.

CLI

To output ASTs, run the semantic-parse command, specifying two mandatory options: 1) the format you'd like to return (ex., Show, JSON, etc.) and 2) the option specifying whether the source code will be passed in directly via command line (using --sourceString) or via providing the file path --sourceFile.

Filepath:

semantic-parse --format [FORMAT] --sourceFile [FILEPATH]

Source string:

semantic-parse --format [FORMAT] --sourceString [SOURCE]

An example command is:

semantic-parse -- --format Show --sourceString "a"

This will generate an AST

Right (Module {ann = (Range {start = 0, end = 1},Span {start = Pos {line = 0, column = 0}, end = Pos {line = 0, column = 1}}), extraChildren = [R1 (ExpressionStatementSimpleStatement (ExpressionStatement {ann = (Range {start = 0, end = 1},Span {start = Pos {line = 0, column = 0}, end = Pos {line = 0, column = 1}}), extraChildren = L1 (PrimaryExpressionExpression (IdentifierPrimaryExpression (Identifier {ann = (Range {start = 0, end = 1},Span {start = Pos {line = 0, column = 0}, end = Pos {line = 0, column = 1}}), bytes = "a"}))) :| []}))]})