manual installation guide for Biome: Added winget install option. F…
#3494
Conversation
…ixed Windows install instructions. Added PATH instructions Expanded installation instructions for Biome, including `winget` installation option, organized instructions into platform sections rather than the installation tool, added PATH variable instructions. They're kind of important for anyone using this in scripts.
✅ Deploy Preview for biomejs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
|
hand-edited this in GitHub. Did not test the syntax using linter. Please review. |
Lunaria Status Overview🌕 This pull request will trigger status changes. Learn moreBy default, every PR changing files present in the Lunaria configuration's You can change this by adding one of the keywords present in the Tracked Files
Warnings reference
|
ematipico
left a comment
ematipico
left a comment
There was a problem hiding this comment.
Nice glow up!! I left some suggestions
| If you are using Biome in a CI/CD pipeline, you should install it directly into the project using a Node.js | ||
| package manager (`npm`, `pnpm`, etc) and abandon this manual option. |
There was a problem hiding this comment.
Since this is the page of manual installation, we shouldn't overstep into CI/CD suggestions.
Plus, we already own our own GitHub action and recipes, which doesn't use npm.
To sum up, this suggestion shouldn't be here.
| ## Supported Architectures | ||
|
|
||
| You have to pick the correct binary for your platform for Biome work. The following table should help you do so. | ||
| You have to pick the correct binary for your CPU architecture for Biome work. The following table should help you do so. |
There was a problem hiding this comment.
Why the change? FYI we chose the word platform because there are two variables: CPU and OS
|
|
||
| Using Biome's standalone CLI binary can be a great choice if you aren't already using Node.js or `npm` (or any other package manager). | ||
| Or in other words, Biome shouldn't be the only reason for you to have a `package.json`. | ||
| You can install Biome to your machine to use like any other command line tool. This can be a great choice |
There was a problem hiding this comment.
I liked the previous wording because it highlighted the fact that you don't need Node.js to use Biome, that was the major selling point.
The proposed wording doesn't do that. Plus, you can install CLI tools globally even with npm, so we lost the fact that Biome is a standalone binary
| if you need to run this manually: for instance, if you use a code editor that does not have a Biome plugin, | ||
| or if you intend to use this in shell scripts or another local tool to automate processing of source code | ||
| files, or if you intend to have an AI coding tool execute this tool. |
There was a problem hiding this comment.
I like the proposed use cases, maybe we can make a list out of them
| <Code lang="shell" code={` | ||
| # Windows (x86_64, Powershell) | ||
| set PATH="%PATH%;%USERPROFILE%\Downloads\binaries\" | ||
| `} /> |
There was a problem hiding this comment.
Can we add a note that says that those tags/binaries published on wget aren't managed by the team?
| chmod +x biome | ||
| `} /> | ||
|
|
||
| You can now run Biome with `./biome`. |
There was a problem hiding this comment.
| You can now run Biome with `./biome`. | |
| You can now run Biome with `./biome`. | |
| ```shell | |
| ./biome check | |
| ``` | |
| To run it globally from any directory just by typing `biome`, add it to your `PATH`. | ||
| Here are the recommended ways: | ||
|
|
||
| **Recommended: Move the binary to a directory already in `$PATH`** |
There was a problem hiding this comment.
Should we suggest a way to know which folders are available in PATH?
| **Alternative: Add the current folder to your `PATH`** | ||
| If you prefer not to move the binary, append the current directory to `PATH` in your shell configuration file. |
There was a problem hiding this comment.
It's not very clear what "current folder" actually means, because it could mean anything, even a temporary folder where users download their stuff.
I suggest rewording the suggestion in another way by suggesting to add a new folder to PATH
| :::note | ||
| **Tip**: Moving the binary to `/usr/local/bin` or `~/.local/bin` (as shown in the | ||
| recommended method) is cleaner, more reliable, and works across all terminal | ||
| sessions without relying on `$(pwd)`. | ||
| ::: |
There was a problem hiding this comment.
Starlight already has the :::tip aside: https://starlight.astro.build/guides/authoring-content/#custom-aside-titles
|
|
||
| Now `biome` works everywhere: | ||
|
|
||
| <Code lang="shell" code={`biome --version biome format . biome lint .`} /> |
There was a problem hiding this comment.
| <Code lang="shell" code={`biome --version biome format . biome lint .`} /> | |
| <Code lang="shell" code={`biome check`} /> |
We don't recommend using the . anymore
2 participants
Expanded installation instructions for Biome, including
wingetinstallation option, organized instructions into platform sections rather than the installation tool, added PATH variable instructions. They're kind of important for anyone using this in scripts.Summary
Instructions lack explanation for why you would want to use manual installation and when you wouldn't want to. Lacked instructions for adding the binary to PATH for common usage. Lacked instructions for
wingetinstall option which is new.Fixes #3490