fix(doc): reuse solar sema compiler #11980
Conversation
crates/doc/src/parser/item.rs
Outdated
| // Remove extra indent from docs. | ||
| self.code = code | ||
| .lines() | ||
| .map(|line| line.strip_prefix(" ").unwrap_or(line)) | ||
| .collect::<Vec<_>>() | ||
| .join("\n"); |
There was a problem hiding this comment.
i think that we should make this more robust.
what i'd like to see is the following logic:
- get the source code from beginning of line to
self.source.range().start - strip the indentation of this source code (should be an empty string or just indentation) from all lines
function topLevel() public {
// this needs 1 indentation level, none should be removed
}
contract TopLevel {
function innerLevel() public {
// this has 2 ind, 1 needs to be removed
}
}There was a problem hiding this comment.
I changed the logic to remove only if starts with > 4 whitespaces (that is to proper format the free functions as in prev version), since we're going to remove solang anyways not sure if should spend more time on this, wdyt?
There was a problem hiding this comment.
i think it is fine as a temp workaround as we need to drop the solang dep anyways.
once we do that, we can do it properly
grandizzy
requested review from
DaniPopes,
mattsse,
onbjerg,
yash-atreya and
zerosnacks
as code owners
|
let's wait for @DaniPopes to have a look before we merge |
crates/doc/src/builder.rs
Outdated
| let mut files = vec![]; | ||
|
|
||
| // Read and parse source file | ||
| if let Some(ast) = gcx.sources.iter().find(|source| { |
crates/doc/src/parser/item.rs
Outdated
| self.code = code | ||
| .lines() | ||
| .map(|line| { | ||
| if line.chars().take_while(|c| c.is_whitespace()).count() > 4 { |
There was a problem hiding this comment.
I think you can just trim_start always
There was a problem hiding this comment.
this is what he did initially, but that's inaccurate.
see the reasoning here: #11980 (comment)
There was a problem hiding this comment.
indeed, however I just realized the count check should have been >= 4 so it didn't apply format properly, hence I am in favour of trim_start always, this affects only free functions which will be displayed as below but I don't think it's a biggie
* fix(doc): reuse solar sema compiler * fix: include only fn sig in docs * proper format docs, remove extra indent & append ; at enf of fn * changes after review: use get_ast_source, strip prefix always
* fix(doc): reuse solar sema compiler (#11980) * fix(doc): reuse solar sema compiler * fix: include only fn sig in docs * proper format docs, remove extra indent & append ; at enf of fn * changes after review: use get_ast_source, strip prefix always * fix(chisel): disable compiler optimizations (#11990) Add --ir-minimum like in `forge coverage`, and disable optimizations since we rely on source maps to inspect expressions. --------- Co-authored-by: DaniPopes <57450786+DaniPopes@users.noreply.github.com>
3 participants
Motivation
func.loc_prototypeno body) + add;at the end of sig to match prev behaviorSolution
PR Checklist