-
Notifications
You must be signed in to change notification settings - Fork 10
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
removes the syntax highlighting dependency on Net #418
base: main
Are you sure you want to change the base?
Conversation
The effect of the new highlighter will be seen in https://docs-dev.raku.org eg operators |
@finanalyst Do any of the commands run in CI need updating/removing? https://github.com/Raku/doc-website/blob/main/.buildkite/pipeline.yaml#L6 |
@dontlaugh I dont understand why build kite is failing.
I'll add the changes now to remove the Net infrastructure, and see what happens |
@dontlaugh Should this branch be called 'docs-dev'? I called it 'dev'. Will the rendered files be containered into docs-dev.raku.org? |
@dontlaugh I tried to cancel an intermediate build but could not work out how to do this. Build-kite documentation indicates there is a setting that automatically cancels intermediate builds if two pushes are close together. |
@dontlaugh @coke The new plugin seems to be working VERY much slower than atom-perl6-highlighter. So I think !!!?? this will need some investigation |
I've noticed that the highlighter is slow as well. It's probably not an issue with your setup, but with Rainbow itself. I do need to look into this at some point, it just didn't make it to the top of my priority list. @finanalyst Is this a blocker for you? If so, I can bump it to the top. |
The build is timing out, that's why it's failing. No container will be built until it's green. Also note that "dev" nor "docs-dev" are automatically deploying right now. That's my bad: I needed to fail prod over to dev a couple of weeks ago. Let's work on getting this tested locally, then getting the build green. I'll upgrade the build environment tonight. Note that this build is not running the latest Rakudo. |
@patrickbkr Thanks for responding here. I was just going to raise an issue on the Rainbow repo. |
@@ -1,7 +1,7 @@ | |||
{ | |||
"name": "Raku-Official-Documentation", | |||
"description": "Tool chain for creating the Raku official documentation site", | |||
"version": "0.1.1", | |||
"version": "0.1.2", |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@finanalyst Will this version optionally work with the current highlighting toolchain?
If it is, we can create a separate build pipeline for the new Rainbow highlighter. This way, we can continue to assist @patrickbkr in testing, while keeping the current site up to date.
In other words, would POD_RENDER_NO_HIGHLIGHTER=0
use the current nodejs toolchain, even if the rest of this code was checked in?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dontlaugh I'm reverting the change that stops installation of Highlighter at present.
The problem is caused by Rainbow being too slow, not by the installation of atom-perl6-highlighter or the nodejs toolchain.
To answer your question directly, the nodejs toolchain (more precisely, npm) is installed in the docker environment AFAIK before zef
is called because zef
does not install non-Raku dependencies.
The BUILD callable for Raku-Pod-Render
, which is invoked by zef, checks to ensure that npm
is installed, and would fail otherwise.
POD_RENDER_NO_HIGHLIGHTER
stops zef from cloning 'atom-perl6-highlighterand using
npm` to install it into the Raku environment.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@dontlaugh more abstractly: Rainbow could be merged into MAIN so long as configs/02-plugins.raku
is not changed.
The atom-perl6-highlighter
is used by the hiliter
plugin, while Rainbow
is used by the rainbow
plugin. They are 1-1 interchangeable as far as Collection
is concerned.
@coke @dontlaugh This new plugin uses @patrickbkr 's very new entirely Raku syntax highlighter (Rainbow).
For the time being I have not differentiated between the variables and delimiters, and kept the colours used by atom-highlighter.
Note that if the new highlighter does not work, then the previous highlighter can be re-enabled by swapping 'highliter' for 'rainbow' in the plugin config file.