Add EBNF grammar as doc comments for TerminalKind and NonterminalKind #1169
Conversation
This file contains 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
… .d.ts files using the `jco types` command. This command is better for our use case than `jco transpile` because it generates the declarations directly from the source .wit files, whereas `jco transpile` uses the WASM binaries to generate them. This means that `jco types` has access to the documentation that's written in the wit interfaces, and `jco transpile` does not. Since we're generating the interfaces in a separate step, I'm disabling typescript in the original `jco transpile` step. This is just a precaution to avoid confusion or possible conflicting declaration files interferring with each other.
…is correctly propagating through the build process.
…rpose of this is so that both processes use the same `CodegenFileSystem` instance. If they used separate instances, then the files generated in one function would get deleted by the next.
…the variant ID as well as the EBNF form of the kind to use as documentation. Getting the EBNF form involves creating an instance of `SpecModel` and serializing the ID using that.
…guage` field to be a `&Language` instead of an `Rc<Language>` because of some weird issue getting `KindBuilder` to instantiate properly given that `KindsModel::from_language` received a `&Rc<Language>` param. However, I realized afterwards that I could just use `to_owned` when creating the SpecModel instead of changing SpecModel everywhere.
|
… for the clippy lints `doc_markdown` and `doc_link_with_quotes`. These are "pedantic" lints that we run into issues with now that we're outputting the EBNF docs for these kinds, but the errors aren't relevant to us.
OmarTawfik
reviewed
Dec 3, 2024
crates/codegen/runtime/cargo/crate/src/runtime/cst/terminal_kind.rs.jinja2
Outdated
Show resolved
Hide resolved
OmarTawfik
reviewed
Dec 3, 2024
crates/codegen/runtime/cargo/wasm/src/runtime/interface/cst.wit.jinja2
Outdated
Show resolved
Hide resolved
OmarTawfik
reviewed
Dec 3, 2024
OmarTawfik
reviewed
Dec 3, 2024
OmarTawfik
reviewed
Dec 3, 2024
2 tasks
OmarTawfik
reviewed
Dec 6, 2024
OmarTawfik
reviewed
Dec 6, 2024
OmarTawfik
reviewed
Dec 6, 2024
crates/testlang/outputs/npm/package/wasm/generated/interfaces/nomic-foundation-slang-cst.d.ts
Show resolved
Hide resolved
OmarTawfik
reviewed
Dec 6, 2024
OmarTawfik
requested changes
Dec 6, 2024
OmarTawfik
approved these changes
Dec 12, 2024
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
github-merge-queue
bot
removed this pull request from the merge queue due to failed status checks
|
looks like this needs rebasing before merge. |
github-merge-queue bot
pushed a commit
that referenced
this pull request
Dec 12, 2024
Updates our JCO submodule to include the changes in NomicFoundation/jco#5. Includes one other change to fully integrate these changes, which is to change `NodeVariant` to `NodeType` in `codegen/../cst/index.mts` so that the expected imports align with the new generated exports. * [x] Depends on #1169 * [x] Depends on NomicFoundation/jco#5 Closes #1166 Closes #1171
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.
When generating documentation for
TerminalKindandNonterminalKind, generate the EBNF grammar for the current variant and include that in the final output. This affects the Wit output and Rust output (using templatescst.wit.jinja2and(terminal|nonterminal)_kind.rs.jinja2).Closes #1165