better typed api, update rowan, remove `SmolStr`

oberblastmeister commented 3 years ago

I have made the typed api better by creating more types and returning our types from functions. For example the lambda function of the Apply type now returns an Expr instead of just any SyntaxNode. This makes the functions much more useful and allows for less explicit casting. There are also new types for select tokens, such as Whitespace and Comment. ParsedType has been renamed to Expr because having every possible parsed type in an enum is not very useful. Only allowing Expr increases the 'tightness' of the type. Most of the stuff is based on rust-analyzer. I imagine these changes would make the experience of @aaronjanse better when implementing the evaluator. I also updated rowan and removed SmolStr which fixes #29 .

Ma27 commented 3 years ago

@aaronjanse would you mind taking a look? :)

lovesegfault commented 3 years ago

This also needs an update since rowan 0.15 is now available.

aaronjanse commented 3 years ago

I'm hesitant to change the API so heavily. Although the semvar of rnix-parser isn't 1.0, the API is still depended upon by many projects.

I'm still in favor of the changes. I just think we should look into what the migration process would be for existing codebases and how much they would benefit from the new design

oberblastmeister commented 3 years ago

I think @nerdypepper could provide some input, as I think he expressed some interest for a better typed api.

oberblastmeister commented 3 years ago

To migrate to then new changes would just require some changing of names and less casting. I think the breaking change is okay, as like you said we aren't at 1.0 yet, and I imagine the API wouldn't change much after this. It is better to get this api in before 1.0 rather than be stuck with a less typed one that is harder to change. It seems like about 5 projects depend on this crate, which doesn't seem like that much. For rnix-lsp and nixpkgs-fmt, I can provide prs to update them.

oppiliappan commented 3 years ago

I would love to see these changes land before 1.0. I am perfectly fine with breaking changes in rnix-parser, it is often hard to keep a stable ABI for these kind of projects.

It would be nice to get input from other rnix-parser users however.

Ma27 commented 3 years ago

I'll re-assign it to 0.11.0. I fully agree, before we have improved the error handling #34/#35 and have taken care of this, we shouldn't consider a 1.0. Also, I'd like to publish 0.10 ~nowish as it's needed to support Nix 2.4 syntax features.

I'll try take a closer look during the next weeks, then we can resume evaluating how/what to merge :)

Sorry that this takes so long, @oberblastmeister please don't forget that I highly appreciate the work you've put in here! :heart: