Skip to content

Providing non-deprecated code sample in README.md #538

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
niklasschloegel wants to merge 4 commits into
base: master
Choose a base branch
from
Open

Providing non-deprecated code sample in README.md #538

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
3384469
providing non-deprecated code sample in README.md
niklasschloegel Oct 3, 2022
16a1a16
test
niklasschloegel Oct 3, 2022
99a2dff
improving README.md
niklasschloegel Nov 30, 2022
927a4b7
deleting accidentially created file
niklasschloegel Nov 30, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 3 additions & 2 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,10 +72,11 @@ TypeScript 2.0.
5. Use your grammar in TypeScript

```typescript
import { ANTLRInputStream, CommonTokenStream } from 'antlr4ts';
import { CodePointCharStream, CodePointBuffer, CommonTokenStream } from 'antlr4ts';

// Create the lexer and parser
let inputStream = new ANTLRInputStream("text");
let buffer = Buffer.from("text");
let inputStream = CodePointCharStream.fromBuffer(new CodePointBuffer(buffer, buffer.length));
Copy link

@AJamesPhillips AJamesPhillips Oct 10, 2022 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I also found the deprecated code confusing so thanks for this PR.
My IDE's recommended replacement was

const inputStream = CharStreams.fromString("text")

Copy link
Author

@niklasschloegel niklasschloegel Nov 30, 2022

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah you're right, that one is even better.

let lexer = new MyGrammarLexer(inputStream);
let tokenStream = new CommonTokenStream(lexer);
let parser = new MyGrammarParser(tokenStream);
Expand Down