Skip to content

Refresh the TypeScript parser developer guide - #133

Open
Aschenbath wants to merge 1 commit into
solidity-parser:masterfrom
Aschenbath:docs/refresh-developer-guide-88
Open

Aschenbath wants to merge 1 commit into
solidity-parser:masterfrom
Aschenbath:docs/refresh-developer-guide-88

Conversation

@Aschenbath

Copy link
Copy Markdown

Refresh the developer guide for the current TypeScript parser. It now points to the actual public entry point and AST builder, documents dependency/submodule setup, separates wrapper builds from ANTLR regeneration, and explains the Node.js and browser test prerequisites.

Replace the outdated visitor implementation excerpts with descriptions of the current context accessors and AST fields. Update the quick-start REPL example and replace the obsolete build.sh/TestRig invocation with antlr4-parse.

Fixes #88.

Validation on Windows / Node 24:

  • Initialized the pinned grammar submodule and ran all 181 Node.js tests successfully.
  • Node.js bundle, browser bundle, and TypeScript declaration builds pass.
  • Prettier check for DEVELOPING.md passes.
  • Verified every relative link, documented npm script, grammar excerpt, executable REPL example, and described pragma/named/positional-call behavior.
  • Checked antlr4-parse usage against the antlr4-tools documentation. ANTLR regeneration, the Java GUI, and the browser test suite were not run; Puppeteer's Chrome download is not installed in this environment.

Documentation only; no parser behavior changes. Developed and validated with OpenAI Codex assistance.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Update DEVELOPING.md

1 participant