kach/nearley

nearleyc in a browser

Open

#267 opened on Aug 17, 2017

View on GitHub
 (3 comments) (2 reactions) (0 assignees)JavaScript (3,456 stars) (254 forks)batch import
enhancementhelp wanted

Description

As discussed elsewhere, we should have an API for invoking nearleyc from a script and/or in the browser. Then we can drop docs/using-in-frontend.md entirely.

Ideally, we would do this without rearranging the files in the repo, or breaking backwards compat in other ways.

Contributor guide

Tech stack
javascript
Domain
toolingfrontend
Issue type
feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
3
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-2 days
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
stale
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
mostly clear
Prerequisites
Basic JavaScriptFamiliarity with nearley's CLI
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
35
Research direction
Investigate how nearleyc currently works as a CLI tool and identify Node.js dependencies that prevent browser usage. Explore bundling the compiler with a module bundler like webpack or Vite, possibly substituting Node specific APIs with browser compatible alternatives. Check issue #267 comments and the linked discussion for prior suggestions. The goal is to expose the compiler API in the browser while maintaining backward compatibility and the existing file structure.