Skip to content

Experimental command to format code blocks embedded in docstrings #7598

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 25 commits into from
Jul 9, 2025
Merged

Experimental command to format code blocks embedded in docstrings #7598

Show file tree
Hide file tree
Changes from 1 commit
Commits
Show all changes
25 commits
Select commit Hold shift + click to select a range
f7d0a06
add experimental command to format code blocks embedded in docstrings
zth Jul 4, 2025
c1b9e3e
normalize whitespace better
zth Jul 4, 2025
76ffef7
fix offset lines calculation
zth Jul 4, 2025
3beb726
fix tests
zth Jul 4, 2025
a18e342
format Stdlib_Result.resi with the new docstrings formatter
zth Jul 4, 2025
803aae5
just output the filename without the full path for now
zth Jul 4, 2025
f32fa15
fix
zth Jul 4, 2025
b9bb6d9
disable color in docstring format tests since it breaks in different …
zth Jul 4, 2025
02eb87b
better approach than a new env variable
zth Jul 4, 2025
af1fb33
more tweaks to not make more changes to docstrings than needed
zth Jul 4, 2025
a63d3e5
do not edit anything if we didnt have any code blocks
zth Jul 4, 2025
90b1133
use cmarkit for transforming codeblocks
zth Jul 5, 2025
9c635e1
add to opam file
zth Jul 5, 2025
4054a52
add to dune-project
zth Jul 5, 2025
11da9c9
make markdown code block formatter work on markdown files as well
zth Jul 5, 2025
d0a7b3e
restructure args
zth Jul 5, 2025
e95cbbe
refactor
zth Jul 5, 2025
254ae5c
add transform for assertEqual -> == in code blocks
zth Jul 5, 2025
8be709d
change printer to make width optional
zth Jul 9, 2025
89a90dd
explicit cmarkit
zth Jul 9, 2025
0462aa7
add note about --transform-assert-equal
zth Jul 9, 2025
be8657f
support more rescript lang tags
zth Jul 9, 2025
977c559
support resi code blocks as well
zth Jul 9, 2025
c48d4f9
add missing help text
zth Jul 9, 2025
5a540c7
changelog
zth Jul 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
just output the filename without the full path for now
  • Loading branch information
@zth
zth committed Jul 9, 2025
commit 803aae5ab73e4ecc0e81cc17d788b24dd8d7438e
2 changes: 1 addition & 1 deletion tests/tools_tests/src/expected/FormatDocstringsTestError.res.expected
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@

Syntax error in code block in docstring
/Users/zth/OSS/rescript-compiler/tests/tools_tests/src/docstrings-format/FormatDocstringsTestError.res:5:10-6:3
FormatDocstringsTestError.res:5:10-6:3

3 │
4 │
Expand Down
2 changes: 1 addition & 1 deletion tools/src/tools.ml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -823,7 +823,7 @@ module FormatDocstrings = struct
let {Res_driver.parsetree = structure; comments; source; filename} =
parser ~filename:path
in

let filename = Filename.basename filename in
let mapper = makeMapper ~displayFilename:filename in
let astMapped = mapper.structure mapper structure in
( Res_printer.print_implementation
Expand Down