Support Windows via `pwsh` - Powershell needs to be installed manually by azriel91 · Pull Request #77 · Aloso/to-html

azriel91 · 2025-05-17T01:18:52Z

Part of Support other operating systems #3.

If we use the Powershell binary, it defaults to Powershell 1.0, which doesn't have ANSI support; I think it only got introduced in Powershell 5.0.

After installing powershell manually, pwsh is available on the PATH.

I know some windows users will have git-bash installed, but I don't, so as a first cut I just added support for pwsh.

I added tests for windows; and I changed the current working directory restoration to not use pwd, so it would be good to test on a non-windows system with a command that changes the working dir.

Screenshot:

to-html 'cargo build --color=always'

<!-- added this for the screenshot -->
<style>
.terminal {
   background: black;
   color: white;
   border-radius: 4px;
   padding: 10px;
}
</style>

<!-- this was the output -->
<pre class="terminal">
<span class='shell'>&gt; </span><span class='cmd'>cargo</span> <span class='arg'>build</span> <span class='flag'>--color</span><span class='arg'>=always</span>
<b><span style='color:var(--green,#0a0)'>   Compiling</span></b> simple v0.1.0 (C:\Users\azrielh\AppData\Local\Temp\simple)
<b><span style='color:var(--bright-red,#f55)'>error[E0382]</span><span style='color:var(--bright-white,#fff)'>: use of moved value: `hello`</span></b>
  <b><span style='color:var(--bright-cyan,#5ff)'>--&gt; </span></b>src\main.rs:10:11
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>6</span></b>  <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>     let hello = String::from(&quot;hello&quot;);
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>         <b><span style='color:var(--bright-cyan,#5ff)'>-----</span></b> <b><span style='color:var(--bright-cyan,#5ff)'>move occurs because `hello` has type `String`, which does not implement the `Copy` trait</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>...</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>9</span></b>  <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>     print(hello);
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>           <b><span style='color:var(--bright-cyan,#5ff)'>-----</span></b> <b><span style='color:var(--bright-cyan,#5ff)'>value moved here</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>10</span></b> <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>     print(hello);
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>           <b><span style='color:var(--bright-red,#f55)'>^^^^^</span></b> <b><span style='color:var(--bright-red,#f55)'>value used here after move</span></b>
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>
<b><span style='color:var(--bright-green,#5f5)'>note</span></b>: consider changing this parameter type in function `print` to borrow instead if owning the value isn&#39;t necessary
  <b><span style='color:var(--bright-cyan,#5ff)'>--&gt; </span></b>src\main.rs:1:13
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>1</span></b>  <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b> fn print(s: String) {
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>    <b><span style='color:var(--bright-cyan,#5ff)'>-----</span></b>    <b><span style='color:var(--bright-green,#5f5)'>^^^^^^</span></b> <b><span style='color:var(--bright-green,#5f5)'>this parameter takes ownership of the value</span></b>
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>    <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>    <b><span style='color:var(--bright-cyan,#5ff)'>in this function</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>help</span></b>: consider cloning the value if the performance cost is acceptable
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>
<b><span style='color:var(--bright-cyan,#5ff)'>9</span></b>  <b><span style='color:var(--bright-cyan,#5ff)'>| </span></b>    print(hello<span style='color:var(--bright-green,#5f5)'>.clone()</span>);
   <b><span style='color:var(--bright-cyan,#5ff)'>|</span></b>                <span style='color:var(--bright-green,#5f5)'>++++++++</span>

<b><span style='color:var(--bright-white,#fff)'>For more information about this error, try `rustc --explain E0382`.</span></b>
<b><span style='color:var(--red,#a00)'>error</span>:</b> could not compile `simple` (bin &quot;simple&quot;) due to 1 previous error
<span class='shell'>&gt; </span><span class='caret'> </span>
</pre>

CosmicHorrorDev · 2025-05-17T08:26:06Z

Thanks for the PR. I'll try to give it a review tomorrow 👀

Aloso · 2025-05-17T15:49:34Z

+
+    #[cfg(target_os = "windows")]
+    {
+        Ok(out)


This can contain carriage returns (\r) according to the tests, so it should replace them like in line 121.

ah, wasn't sure if we wanted \rs in Windows land.
Shall remove them.

Aloso · 2025-05-17T16:04:50Z

-    if !cmp_paths(std::env::current_dir()?, cwd) {
-        std::env::set_current_dir(cwd)?;
+    if !cmp_paths(std::env::current_dir()?, &cwd_before) {
+        std::env::set_current_dir(cwd_before)?;


That's not what the original code did. When you do

to-html "cd .." "ls"

The 1st command changes directory, and the 2nd command should print the entries in that directory. The problem was that running cd in fake_tty::command does not affect the working directory of the current process, so I wrote this "hack".

Expressed this behavior in a test with this commit (f65923c). It indeed succeeds on main, but fails with this PR

(force pushed to fix mac and linux using slightly different formatting for ls output)

Whelp that's odd. That change appears to fail consistently on only the ubuntu, rustc beta job with output that looks identical to not actually changing the current working directory. I'm not able to reproduce it locally when running the 1.88.0-beta.3 toolchain on Arch :/

https://github.com/CosmicHorrorDev/to-html/actions/runs/15090969623/job/42419546987

ah, looks like I've never changed directories when using to-html!

I've fixed the directory changing code -- getting it to work on Windows is a little hacky (std::env::set_current_dir doesn't like pwd outputs, which are different depending on which bash you're running).

@CosmicHorrorDev I've taken that commit and added it to this branch (and used ls -1 to avoid the \t issue).

Aloso · 2025-05-17T16:23:10Z

Also, I believe this will means that to-html can't be used with git-bash on Windows.

What I'd expect is that to-html "some command" uses bash (on all platforms), and to-html "some command" --shell=pwsh uses PowerShell (note that PowerShell can also be installed on Linux, it is not Windows specific).

azriel91 · 2025-05-18T04:49:41Z

By the way, the default bash finds the WSL bash, and always invokes that; I tried with git-bash, and had to add it to PATH for it to resolve:

The following are WSL bash, then git-bash, run through a git-bash cmd prompt:

Aloso · 2025-05-19T23:13:37Z

Thank you for working on this! I'll have to test it more thoroughly.

… regression.

CosmicHorrorDev · 2025-05-20T05:22:00Z

I'll leave the review up to @Aloso since it seems like he's up for it 🎉

One thing that I would like is if we could add windows in our test.yml CI workflow and (potentially in some other PR) to our release.yml workflow that handles building releases

azriel91 · 2025-05-23T10:26:33Z

Heya @Aloso, would you mind if I added an Error enum with variants for every ? used?

The run_changes_directories test seems to have a race condition on Windows -- when I run cargo test --workspace it passes about 80% of the time, but the failure only shows "" != "<expected stdout>", and the error origin location is lost because it propagates through the ?, and it's really hard to trace the cause just using my brain.

(I haven't checked if there's a way to get the origin location by looking for the error's backtrace)

Aloso · 2025-05-23T12:12:11Z

@azriel91 you can do that. But what I think would help more is to add anyhow, then you can use .context(...)? to get more information.

Aloso · 2025-05-23T18:47:55Z

Documentation needs updating. I'll take care of that when this PR is ready.

azriel91 mentioned this pull request May 17, 2025

Support other operating systems #3

Open

9 tasks

CosmicHorrorDev self-requested a review May 17, 2025 08:25

Aloso reviewed May 17, 2025

View reviewed changes

azriel91 added 6 commits May 20, 2025 16:42

Get windows to work via pwsh, not sure if the cwd changes cause any…

d9c6b98

… regression.

Remove \rs from Windows line endings in fake-tty.

d979361

Support bash and powershell on Windows.

89a7215

Properly switch directories when running multiple commands.

76f0505

Add run_changes_directories test.

15905ac

Add Windows usage notes to README.md.

a5ced54

azriel91 force-pushed the feature/3/windows-powershell branch from 29e6eb5 to a5ced54 Compare May 20, 2025 04:49

CosmicHorrorDev requested review from Aloso and removed request for CosmicHorrorDev May 20, 2025 05:22

Conversation

azriel91 commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

CosmicHorrorDev commented May 17, 2025

Uh oh!

Aloso May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azriel91 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

Aloso May 17, 2025

Choose a reason for hiding this comment

Uh oh!

CosmicHorrorDev May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

CosmicHorrorDev May 18, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Choose a reason for hiding this comment

Uh oh!

azriel91 May 18, 2025

Choose a reason for hiding this comment

Uh oh!

Aloso commented May 17, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

azriel91 commented May 18, 2025

Uh oh!

Aloso commented May 19, 2025

Uh oh!

CosmicHorrorDev commented May 20, 2025

Uh oh!

azriel91 commented May 23, 2025

Uh oh!

Aloso commented May 23, 2025

Uh oh!

Aloso commented May 23, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

azriel91 commented May 17, 2025 •

edited

Loading

Aloso May 17, 2025 •

edited

Loading

CosmicHorrorDev May 18, 2025 •

edited

Loading

CosmicHorrorDev May 18, 2025 •

edited

Loading

Aloso commented May 17, 2025 •

edited

Loading

Aloso commented May 23, 2025 •

edited

Loading