fix: patch js-api openProject()

biomejs · Feb 9, 2025 · c385b27 · c385b27
1 parent 7d5ae45
commit c385b27
Show file tree

Hide file tree

Showing 3 changed files with 11 additions and 2 deletions.
diff --git a/.changeset/large-crabs-tickle.md b/.changeset/large-crabs-tickle.md
@@ -0,0 +1,5 @@
+---
+"@biomejs/js-api": patch
+---
+
+remove the wrong openProject() definition and add jsDoc to it
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
@@ -356,7 +356,7 @@ This repository uses [changesets](https://github.com/changesets/changesets) to a
 If the PR you're about to open is a bugfix/feature visible to users of the Biome toolchain or of the published Biome crates, you are encouraged to provide a **changeset** . To *create* a changeset, use the following command (*don't create it manually*):
 
 ```shell
-just new-changeset
+pnpm changeset
 ```
 > [!NOTE]
 > The script uses `pnpm` under the hoods, so make sure to have ran `pnpm i` from the root of the repository before running this script.

diff --git a/packages/@biomejs/js-api/src/index.ts b/packages/@biomejs/js-api/src/index.ts
@@ -138,7 +138,11 @@ export class Biome {
 		}
 	}
 
-	openProject(): ProjectKey;
+	/**
+	 * Open a possible workspace project folder. Returns the key of said project. Use this key when you want to switch to different projects.
+	 *
+	 * @param {string} [path]
+	 */
 	openProject(path?: string): ProjectKey {
 		return this.workspace.openProject({
 			path: path || "",