Show compiler diagnostics in literate output #948
Merged
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
Codecov Report
@@ Coverage Diff @@
## main #948 +/- ##
============================================
+ Coverage 82.89% 83.04% +0.15%
- Complexity 3452 3491 +39
============================================
Files 283 284 +1
Lines 10638 10734 +96
Branches 1295 1300 +5
============================================
+ Hits 8818 8914 +96
+ Misses 1100 1099 -1
- Partials 720 721 +1
... and 1 file with indirect coverage changes Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
imkiva
changed the title
|
In the docs, we should make the hover window less dark (or maybe make it white-ish). |
|
merge? |
wait a sec, lots of tweaks are coming ~ |
- show `Goal` - rewrite `merge` - simplify code
|
Merge? |
|
JavaScript master.... |
|
bors merge |
|
Build succeeded: |
bors bot
added a commit
that referenced
this pull request
Apr 19, 2023
959: Literate library r=ice1000 a=imkiva
# Summary
This PR adds support for pretty printing a library in our literate way. To customize the generation, new fields were added to `aya.json`:
```json
"literate": {
"linkPrefix": "/aya-prover/base/src/test/resources/success/build/pretty/",
"pretty": {
"prettierOptions": {
"map": {
"InlineMetas": true,
"ShowImplicitArgs": false,
"ShowImplicitPats": true,
"ShowLambdaTypes": false
}
},
"renderOptions": {
"colorScheme": "Emacs",
"styleFamily": "Default"
}
}
},
```
- `linkPrefix`: the prefix to the link of "go to definition". This is useful when the generated page is not in the root folder of the HTTP server. The default value is "/" if unspecified.
- `pretty`: same as the `prettierOptions` and `renderOptions` in `~/.aya/repl_config.json`. The default value comes from `repl_config.json` if unspecified.
# How to build a literate library?
Take the library `base/src/test/resources/success/` for example:
```shell
aya --make base/src/test/resources/success --pretty-stage literate --pretty-format html
```
The above command outputs HTML files which are always located in `<library-root>/build/pretty`. Much like how we compile a single literate file.
(Remember the `"linkPrefix": "/aya-prover/base/src/test/resources/success/build/pretty/"` above?)
Note that the command line options `--prettyDir` and `--output` has no effect on libraries.
## For developers
[LibraryTest.testLiterate](https://github.com/aya-prover/aya-dev/blob/6ce530cddf2256901b02edfc5fb460975d393fc9/base/src/test/java/org/aya/test/LibraryTest.java#L46)
# TODO
- [ ] Collect compiler diagnostics for libraries, see #948
- [ ] Build highlights for `import`, `open`
Co-authored-by: imkiva <imkiva@islovely.icu>
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.
This is the best feature I've ever implemented! The JavaScript code used to show the popup is copied from 1lab (thanks!!!!).