Skip to content
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.

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

Tools: enable doc extraction from compiler #868

Merged
merged 2 commits into from
Dec 18, 2023

Conversation

aspeddro
Copy link
Contributor

This PR has one workaround to extract docs from the compiler repo and a fix

  1. Introduce an env var FROM_COMPILER to analysis find the correct path to cmt files. In standalone packages, the cmt files are located in lib/bs/, but in the compiler repo they are in lib/ocaml
  2. Add stdio: "inherit". Node was truncating output when I run a separate process in rescript-tools doc path/to/rescript-compiler/lib/ocaml/js.ml child process output truncated nodejs/node#2360

Unverified

This user has not yet uploaded their public signing key.
Copy link
Collaborator

@zth zth left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about doing it as a regular variable to the cli command instead of an env variable?

@aspeddro
Copy link
Contributor Author

This is just to generate the compiler docs. It is an internal and exclusive use for extracting compiler docstrings in the rescript-lang repo via the rescript-tools package

I don't think it would make sense to other users

@zth
Copy link
Collaborator

zth commented Dec 17, 2023

@aspeddro ok, sounds good! Is this ready to go then?

Unverified

This user has not yet uploaded their public signing key.
@aspeddro
Copy link
Contributor Author

yup. CHANGELOG updated

@zth zth merged commit 3817c6c into rescript-lang:master Dec 18, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants