Create a new generated npm workspace for typescript ANTLR generated code #1371
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
FYI: I was away last week. Will be reviewing this today. |
jcscottiii
requested changes
Apr 14, 2025
Comment on lines
+9
to
+10
| "build": "tsc", | ||
| "clean": "rimraf dist" |
There was a problem hiding this comment.
Suggested change
| "build": "tsc", | |
| "clean": "rimraf dist" | |
| "build": "tsc", | |
| "clean": "rm -rf dist" |
We should rely on the system rm command.
Comment on lines
+17
to
+18
| "typescript": "^5.0.0", | ||
| "rimraf": "^5.0.0" |
There was a problem hiding this comment.
Can remove this
Suggested change
| "typescript": "^5.0.0", | |
| "rimraf": "^5.0.0" | |
| "typescript": "^5.0.0" |
There was a problem hiding this comment.
Ideally, we should have a common tsconfig that both the frontend and this package extend
There was a problem hiding this comment.
We should add a new target like: build-antlr-ts
It should call the npm run build command in the lib/gen/antlrv4/ts-antlrv4 directory.
We currently have one shot commands such as make start-local and make debug-local and make precommit and make playwright-test. It will be necessary to add this target as a pre-requisite target for those.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
As described in #716, we're looking for opportunities to do some client side search query validation or autocompletion, so we need to be able to get ANTLR generated code from the typescript side. This PR will unlock #717 and #718
Changes
Makefileso that it generates TypeScript code tolib/gen/antlrv4/ts-antlrv4along with Go code generationpackage.jsonfile to include the new workspace -lib/gen/antlrv4/ts-antlrv4package.jsonandtsconfig.jsonto ts-antlrv4 so that it can later be imported into frontend code as well as get compiled..gitignoreto exclude generated ANTLR filesScreenshot with generated typescript code:
With the changes, we should be able to import the package to frontend with:
package.json (frontend):
any ts file (frontend):