Rewrite of API Generation#23
Open
arkaragian wants to merge 47 commits into
Open
Conversation
added 30 commits
December 27, 2025 18:08
added 15 commits
January 20, 2026 22:51
justinmk
reviewed
Jan 27, 2026
| [AttributeUsage(AttributeTargets.Method)] | ||
| public class NvimFunctionAttribute : Attribute { | ||
| public string? Name { get; set; } | ||
| } No newline at end of file |
Member
There was a problem hiding this comment.
Set your editor or whatever to ensure all files end with a newline.
Author
There was a problem hiding this comment.
Ok. Is there any specific reason to do so?
justinmk
reviewed
Jan 27, 2026
| } | ||
| List<ArgumentConverter> argumentConverters = []; | ||
| if (evalParameterIndices.Count is not 0) { | ||
| argumentConverters.Add( |
Member
There was a problem hiding this comment.
did you increase the indent to 4 spaces? it will help a lot to keep the 2-space indent. otherwise there is a huge amount of churn and it is harder to review. also, we generally just prefer 2 space indent.
Author
There was a problem hiding this comment.
Ok. I will update all the .editorconfigs
Member
No one is likely to pull down this PR and debug it. If you have a specific question we can try to answer it. Also, the amount of changes here makes it very hard to review. Is there any way to do this in smaller stages |
Author
|
I had this in mind when making soooo many changes. And that's ok. I will guide you through all the points one by one. By also comparing the work of the current The general idea is that the
Then the doxygen xml is converted into C# xml tags. Similarly the api definitions into C# an NvimAPI partial class along with supported definitions. Please see the diagram bellow. flowchart TB
exe["nvim"]
xml
gen[NvimClient.APIGenerator]
gen2[NvimClient.APIGenerator]
mem["In Memory"]
gen -- Calls Nvim Exe --> exe -- Parse and Store--> mem
gen -- Calls Doxygen --> doxygen -- Uses nvim src --> xml -- Parses XML And Stores--> mem
mem --> gen2
gen2 -- Generates --> cssrc["NvimAPI.Generated.cs"]
gen2 -- Generates --> Types[".cs Nvim Types"]
gen2 -- Generates --> Events[".cs Nvim EventArgs Files"]
I will get back with additional information. |
Author
|
So when I generate the api I get the following output: Let's make some comments and start the basic questions: Some functions receive |
Contributor
|
This is currently reimplementing too much of what Roslyn already gives us. The generator now has its own hand-rolled C# syntax model: I’d strongly prefer the generator keep the Neovim-specific parts: That would remove a lot of fragile string-based code and let the compiler APIs own the C# syntax layer. It also allows us to have multiple emitter targets instead of a C# lock-in, as you'll be building an actual AST that's verifiable. |
Contributor
I do not think this claim is supported by the diff. I cannot see where this PR meaningfully removes functional code. In places, it appears to do the opposite: the new generator relies heavily on mapping/transformation code over immutable-ish models. That is fine, but it directly undermines the stated rationale. The broader premise is also wrong. Functional code is not inherently unfamiliar or unmaintainable to C# developers. C# is multi-paradigm. LINQ, records, pattern matching, expression-bodied members, fluent APIs, result-style flows, and pure transformations are all mainstream C#. The added complexity from this bespoke C# emitter is not a maintainability improvement. It is a large increase in project surface area and review burden. I would strongly prefer this not be merged in its current form. If there are specific functional patterns in the existing codebase that are causing problems, they should be raised directly and addressed in small, focused PRs. |
Member
Interesting. Thanks for raising that. Definitely would like to lean on .NET as much as possible to avoid extra code |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
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.
This pull request is a general maintenance of the project revolving around the following directions:
.editorconfigstyle.This is WIP and not yet ready for introduction to the
masterbranch. That is why I have adevelopbranch in place. The scope of the PR is to receive some honest feedback regarding the project.At the moment the generated code does not compile. This is due to incorrect type mappings between lua and C# types. due to my inexperience with neovim source code. Thus feedback is required by anyone who would like to help.