README.md

GremlinGx

CS 7280 Spring 2022 Project

Interprets query operations to generate an example graph that completely and minimally demonstrates query behavior.

Code author

Jackson Neal

Installation

External Components:

• Download ANTLR tool antlr-4.9.3-complete.jar, place in ./resources directory at project root.

Dependencies:

# Install dependencies
npm install

Execution

1. Use ANTLR to generate parser for grammar ./src/grammar/GremlinGx.g4.

npm run generate

2. Build with Webpack

npm run build

Development

Run Webpack serve in dev mode with hot reload

npm run dev

Testing

# Run Jest test suite
npm test

# With coverage
npm run test-coverage

Lint & Format

# ESLint check
npm run lint-check

# ESLint fix
npm run lint

# Prettier check
npm run format-check

# Prettier format
npm run format