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

feat: release vs code extension v3 #974

Draft
wants to merge 12 commits into
base: main
Choose a base branch
from
Draft

feat: release vs code extension v3 #974

wants to merge 12 commits into from

Conversation

nhedger
Copy link
Member

@nhedger nhedger commented Aug 21, 2024

Summary

This PR updates the VS Code reference for the v3 release.

@nhedger nhedger changed the title feat: update VS Code extension document for V3 feat: update VS Code extension documentation for V3 Aug 21, 2024
Copy link

netlify bot commented Aug 21, 2024

Deploy Preview for biomejs ready!

Name Link
🔨 Latest commit 1cd9152
🔍 Latest deploy log https://app.netlify.com/sites/biomejs/deploys/66f3f7fcb370e8000835bb75
😎 Deploy Preview https://deploy-preview-974--biomejs.netlify.app
📱 Preview on mobile
Toggle QR Code...

QR Code

Use your smartphone camera to open QR code link.

To edit notification comments on pull requests, go to your Netlify site configuration.

@nhedger nhedger changed the title feat: update VS Code extension documentation for V3 feat: update VS Code documentation for V3 Aug 21, 2024
@nhedger nhedger force-pushed the vscode-extension-v3 branch from 20aacf8 to 4d9f049 Compare August 30, 2024 10:47
@nhedger nhedger force-pushed the vscode-extension-v3 branch from ec736d5 to 46b8c5b Compare September 14, 2024 05:33
@nhedger nhedger self-assigned this Sep 14, 2024
@nhedger nhedger changed the title feat: update VS Code documentation for V3 feat: release vs code extension v3 Sep 14, 2024
Copy link
Member

@ematipico ematipico left a comment

Choose a reason for hiding this comment

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

Overall, it looks good! Generally, I think that each option should have a tiny example that shows how to write it, so people can quickly copy it.

Comment on lines 49 to 53
To define projects in a **workspace**, add a `settings.biome.projects` property to the `.code-workspace` file. This setting accepts an
array of project definitions, each of which has the following properties:

- `name`: The **name of the workspace folder** that the project is associated with
- `path` : The **path to the project directory**, _relative to the root of the workspace folder_.
Copy link
Member

Choose a reason for hiding this comment

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

At this point, it would be nice to show a JSONC example that people can visually see and maybe copy. The example will be helpful to clarify way more the path. Also, it isn't clear if both properties are optional or mandatory

nhedger and others added 5 commits September 25, 2024 13:38
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
Co-authored-by: Emanuele Stoppa <my.burning@gmail.com>
@sandstrom
Copy link

sandstrom commented Feb 26, 2025

What's the status for this one?

It says in the related PR that this is shipped, so is it only the docs that are missing?

I've tried adding this to .vscode/settings.json but it doesn't work, and the UI says it's not a recognized setting.

  "biome.projects": [
    {
      "path": "client/",
    }
  ]

(based on these fixtures: https://github.com/biomejs/biome-vscode/blob/097735e24085b2cd036ba1bb86f059915c561976/test/fixtures/single-root-workspace-monorepo/.vscode/settings.json)

@nhedger
Copy link
Member Author

nhedger commented Feb 26, 2025

Only applies to the pre release extension

@sandstrom
Copy link

@nhedger Alright, many thanks! 🙏🏻

I tried out the pre-release extension and still couldn't get this to work. I got it to pickup the projects, but I couldn't configure the binary (probably the same as mentioned in this comment at the bottom biomejs/biome#4666 (comment)).

Anyway, used a symlink from repo root for now as a workaround.

Will try again after the next extension release!

@ematipico ematipico linked an issue Mar 9, 2025 that may be closed by this pull request
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Update the VSCode docs
3 participants