Skip to content

Commit c84ac5b

Browse files
committed
Update bsc path finding
1 parent d55526b commit c84ac5b

File tree

1 file changed

+2
-5
lines changed

1 file changed

+2
-5
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -105,14 +105,11 @@ The bad alternatives are:
105105

106106
## Format
107107

108-
To find the location of `bsc` to run:
109-
- Look for the nearest `bsconfig.json`. That's the root of the project. \*
110-
- Search in that directory's `node_modules/bs-platform/{platform}/bsc.exe`.
108+
To find the location of `bsc.exe` to run the formatter:
109+
- Search in the file's directory's `node_modules/bs-platform/{platform}/bsc.exe`.
111110
- Do **not** directly use `node_modules/.bin/bsc` if you can help it. That's a Nodejs wrapper. Slow startup. We don't want our formatting to be momentarily stalled because some Nodejs cache went cold.
112111
- `platform` can be `darwin`, `linux`, `win32` or `freebsd`.
113112

114-
\* Maybe we'll do this differently in the future because asking for a `bsconfig.json` just to format some files is rough.
115-
116113
### Formatting Newline
117114

118115
The formatted result should be taken as-is, without any extra string trimming and newline addition/removal by the editor plugin.

0 commit comments

Comments
 (0)