Skip to content

Commit ceed34a

Browse files
uncenterematipicosiketyan
authored
docs: fix various typos (#6001)
Co-authored-by: ematipico <[email protected]> Co-authored-by: siketyan <[email protected]>
1 parent ccbb1af commit ceed34a

File tree

6 files changed

+30
-30
lines changed

6 files changed

+30
-30
lines changed

CONTRIBUTING.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,7 @@ We can use help in a bunch of areas and any help is greatly appreciated!
3939

4040
## Asking questions, making proposals
4141

42-
If you have any questions, proposals, or feedbacks, open a [GitHub discussion](https://github.com/biomejs/biome/discussions).
42+
If you have any questions, proposals, or feedback, open a [GitHub discussion](https://github.com/biomejs/biome/discussions).
4343
Make sure your comment adds value: [don't post a comment just to get attention](https://jacobtomlinson.dev/posts/2022/dont-be-that-open-source-user-dont-be-me/).
4444

4545
Our [Discord server](https://biomejs.dev/chat) is open for help and more ad-hoc discussion.
@@ -88,7 +88,7 @@ You can install `just` using cargo:
8888
cargo install just
8989
```
9090

91-
But we **highly recommend** to [install it using an OS package manager](https://github.com/casey/just#packages), so you won't need to prefix every command with `cargo`.
91+
But we **highly recommend** to [install it using an OS package manager](https://github.com/casey/just#packages), so you won't need to prefix every command with `cargo`.
9292

9393
Once installed, run the following command to install the required tools:
9494

@@ -264,7 +264,7 @@ When you finished your work, and you are ready to **commit and open a PR**, ther
264264
things you would need to run and check:
265265
- `just f` (alias for `just format`), formats Rust and TOML files.
266266
- `just l` (alias for `just lint`), run the linter for the whole project.
267-
- Code generation. The code generation of the repository is spread in the different parts of the code base. Sometimes is needed and sometime it isn't:
267+
- Code generation. The code generation of the repository is spread in the different parts of the codebase. Sometimes is needed and sometime it isn't:
268268
- run `just gen-analyzer` when you're working on the **linter**;
269269
- run `just gen-bindings` in case you worked around the **workspace**.
270270

@@ -327,7 +327,7 @@ For more information on how to help with translation, please see the [translatio
327327
## Commit messages
328328

329329
Internally, the Biome team adheres as closely as possible to the [conventional commit specification](https://www.conventionalcommits.org/en/v1.0.0-beta.2/).
330-
The following this convention encourages commit best-practices and facilitates commit-powered features like change log generation.
330+
The following this convention encourages commit best-practices and facilitates commit-powered features like changelog generation.
331331

332332
The following commit prefixes are supported:
333333

@@ -405,7 +405,7 @@ We are very strict about `major` changes in the `@biomejs/biome` package. To bet
405405
The description of the changeset should follow the these guidelines:
406406

407407
- Use the past tense when describing what you did, e.g. "Added new feature", "Fixed edge case".
408-
- Use the present tense when describing Biome behaviour, e.g. "Biome now supports ...".
408+
- Use the present tense when describing Biome behavior, e.g. "Biome now supports ...".
409409
- If you fixed a bug, please add the link to the issue, e.g. "Fixed [#4444](https://github.com/biomejs/biome/issues/4444)".
410410
- If you reference a rule, please add the link to the rule on the website, e.g. "Added the rule [`useAwesomeThing`](https://biomejs.dev/linter/rules/use-awesome-thing/)" (even if the website isn't updated yet, the URL is pretty predictable...).
411411
- Similarly, if you reference an assist, please add the link to the assist on the website, e.g. "Added the assist [`awesomeAction`](https://biomejs.dev/assist/actions/awesome-action/)".

GOVERNANCE.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ We have a reasonably liberal approach to code review and merging. We value quick
199199
- If there are comments or suggestions after a PR is merged after the fact, allow yourself time to address them in a follow-up PR. If you don't respond in a reasonable timeframe, then create an issue to track.
200200
- Ensure that the PR summary is detailed, listing steps you took to verify the rationale and relevant issues and people involved in any prior discussion.
201201
- Ensure that PRs contain adequate tests and code comments for a future contributor to derive intent and modify your code safely.
202-
- You are welcome to the repos for your WIP branches. If you don't use your own fork, prepend the name of the branch with your github handle, e.g. `<handle>/experiment-code` Branches that have more than four months of inactivity will be pruned.
202+
- You are welcome to the repos for your WIP branches. If you don't use your own fork, prepend the name of the branch with your GitHub handle, e.g. `<handle>/experiment-code` Branches that have more than four months of inactivity will be pruned.
203203
- If you add a new feature, ensure it has been discussed or approved on GitHub or Discord.
204204
- If necessary, identify potential owners for PR review and approval.
205205
- All code must go through Pull Requests (PR) and pass status checks before being merged. If a PR is merged that breaks `main` due to the branch not being up-to-date, then it should either be reverted or a quick fix merged as a separate PR.

crates/biome_analyze/CONTRIBUTING.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ The analyzer allows implementors to create **four different** types of rules:
4040
- [Using Rule Options](#using-rule-options)
4141
- [Full Documentation Example](#full-documentation-example)
4242
- [Code generation](#code-generation)
43-
- [Commiting your work](#commiting-your-work)
43+
- [Committing your work](#commiting-your-work)
4444
- [Sidenote: Deprecating a rule](#sidenote-deprecating-a-rule)
4545

4646
## Creating a Rule
@@ -131,7 +131,7 @@ Here is a non-exhaustive list of common names:
131131

132132
These rules report errors which are the result of mistyping and led to runtime errors or ignored code.
133133
This naming convention is used for CSS rules.
134-
For example, `noUnknownUnit` reports CSS units that are not standarized.
134+
For example, `noUnknownUnit` reports CSS units that are not standardized.
135135

136136
- `noMisleading<Concept>`
137137

@@ -155,8 +155,8 @@ Here is a non-exhaustive list of common names:
155155

156156
- `useConsistent<Concept>`
157157

158-
These rules ensure consistency across the entire code base.
159-
For example, `useConsistentArrayType` ensures that developers use either `Arra<T>` or `T[]`.
158+
These rules ensure consistency across the entire codebase.
159+
For example, `useConsistentArrayType` ensures that developers use either `Array<T>` or `T[]`.
160160

161161
- `useShorthand<Concept>`
162162

@@ -210,7 +210,7 @@ Let's say we want to create a new **lint** rule called `useMyRuleName`, follow t
210210
The script `just new-js-lintrule` script will generate a bunch of files for the _JavaScript_ language inside the `biome_js_analyze` crate.
211211
Among the other files, you'll find a file called `use_my_rule_name.rs` inside the `biome_js_analyze/lib/src/lint/nursery` folder. You'll implement your rule in this file.
212212

213-
2. Let's have a look at the generated code in `use_my_rule_name.rs`:
213+
2. Let's have a look at the generated code in `use_my_rule_name.rs`:
214214

215215
```rust
216216
...
@@ -388,7 +388,7 @@ declare_lint_rule! {
388388

389389
If a **lint** rule is inspired by an existing rule from other ecosystems (ESLint, ESLint plugins, clippy, etc.), you can add a new metadata to the macro called `source`. Its value is `&'static [RuleSource]`, which is a reference to a slice of `RuleSource` elements, each representing a different source.
390390

391-
If you're implementing a lint rule that matches the behaviour of the ESLint rule `no-debugger`, you'll use the variant `::ESLint` and pass the name of the rule:
391+
If you're implementing a lint rule that matches the behavior of the ESLint rule `no-debugger`, you'll use the variant `::ESLint` and pass the name of the rule:
392392

393393
```rust
394394
use biome_analyze::{declare_lint_rule, RuleSource};
@@ -405,7 +405,7 @@ declare_lint_rule! {
405405
}
406406
```
407407

408-
If the rule you're implementing has a different behaviour or option, you can add the `source_kind` metadata and use the `RuleSourceKind::Inspired` type. If there are multiple sources, we assume that each source has the same `source_kind`.
408+
If the rule you're implementing has a different behavior or option, you can add the `source_kind` metadata and use the `RuleSourceKind::Inspired` type. If there are multiple sources, we assume that each source has the same `source_kind`.
409409

410410
```rust
411411
use biome_analyze::{declare_lint_rule, RuleSource, RuleSourceKind};
@@ -621,7 +621,7 @@ and do not need to be handled by the rule itself.
621621
> We instead provide a ***`serde`-inspired*** implementation in `biome_deserialize` and `biome_deserialize_macros` that [differs in some aspects](../biome_deserialize/README.md), like being fault-tolerant.
622622
623623
The compiler should warn you that `MyRuleOptions` does not implement some required types.
624-
We currently require implementing _serde_'s traits `Deserialize`/`Serialize`.
624+
We currently require implementing _serde_'s `Deserialize`/`Serialize` traits.
625625

626626
Also, we use other `serde` macros to adjust the JSON configuration:
627627
- `rename_all = "camelCase"`: it renames all fields in camel-case, so they are in line with the naming style of the `biome.json`.
@@ -708,7 +708,7 @@ The semantic model provides information about the references of a binding (decla
708708

709709
##### How to use the query `Semantic<>` in a lint rule
710710

711-
We have a for loop that creates an index i, and we need to identify where this index is used inside the body of the loop
711+
We have a for loop that creates an index `i`, and we need to identify where this index is used inside the body of the loop
712712

713713
```js
714714
for (let i = 0; i < array.length; i++) {
@@ -951,7 +951,7 @@ There are some common mistakes that can lead to bugs or false positives in lint
951951

952952
##### Not checking if a variable is global
953953

954-
Some rules aim to ban certain functions or variables (eg. `noConsoleLog` bans `console.log`). A common mistake make this check without considering if the variable is global or not. This can lead to false positives if the variable is declared in a local scope.
954+
Some rules aim to ban certain functions or variables (e.g. `noConsoleLog` bans `console.log`). A common mistake make this check without considering if the variable is global or not. This can lead to false positives if the variable is declared in a local scope.
955955

956956
```js
957957
console.log(); // <-- This should be reported because `console` is a global variable
@@ -1030,7 +1030,7 @@ Run the command:
10301030
just test-lintrule myRuleName
10311031
```
10321032

1033-
and if you've done everything correctly, you should see some snapshots emitted with diagnostics and code actions.
1033+
And if you've done everything correctly, you should see some snapshots emitted with diagnostics and code actions.
10341034

10351035
Check our main [contribution document](https://github.com/biomejs/biome/blob/main/CONTRIBUTING.md#testing) to know how to deal with the snapshot tests.
10361036

@@ -1285,7 +1285,7 @@ For simplicity, use `just` to run all the commands with:
12851285
just gen-analyzer
12861286
```
12871287

1288-
### Commiting your work
1288+
### Committing your work
12891289

12901290
Once the rule is implemented, tested and documented, you are ready to open a pull request!
12911291

crates/biome_js_type_info/CONTRIBUTING.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ own challenges.
5757
## Type Data Structures
5858

5959
In Biome, the most basic data structure for type information is a giant `enum`,
60-
called `TypeData`, defined in [type_info.rs](src/type_info.rs).
60+
called `TypeData`, defined in [`type_info.rs`](src/type_info.rs).
6161

6262
This enum has many different variants in order to cover all the different kinds
6363
of types that TypeScript supports. But a few are specifically
@@ -157,7 +157,7 @@ Local inference doesn't do any type resolution yet, it only creates type
157157
references. So in most cases we won't know a concrete type yet, but it still
158158
provides a useful starting point for later inference.
159159

160-
Local inference is implemented in [local_inference.rs](src/local_inference.rs).
160+
Local inference is implemented in [`local_inference.rs`](src/local_inference.rs).
161161

162162
### Module-Level ("Thin") Inference
163163

@@ -202,7 +202,7 @@ But ultimately, if not even a global declaration was found, then we're at a loss
202202
and fall back to `TypeReference::Unknown`.
203203

204204
Thin inference is implemented in
205-
[js_module_info/collector.rs](../biome_module_graph/src/js_module_info/collector.rs).
205+
[`js_module_info/collector.rs`](../biome_module_graph/src/js_module_info/collector.rs).
206206

207207
## Full Inference
208208

@@ -216,21 +216,21 @@ we've seen before: Such a cache would get stale the moment a module is replaced,
216216
and we don't want to have complex cache invalidation schemes.
217217

218218
Full inference is implemented in
219-
[scoped_resolver.rs](../biome_module_graph/src/js_module_info/scoped_resolver.rs).
219+
[`scoped_resolver.rs`](../biome_module_graph/src/js_module_info/scoped_resolver.rs).
220220

221221
## Type Resolvers
222222

223223
The thing about having all these type references all over the place is that you
224224
need to perform explicit type resolution to follow these references. That's why
225225
we have _type resolvers_. There's a `TypeResolver` trait, defined in
226-
[resolver.rs](src/resolver.rs). As of today, we have 6 implementations of it:
226+
[`resolver.rs`](src/resolver.rs). As of today, we have 6 implementations of it:
227227

228228
* **`HardcodedSymbolResolver`**. This one is purely for test purposes.
229229
* **`GlobalsResolver`**. This is the one that is responsible for resolving
230230
globals such as `Promise` and `Array`. The way we do this is still rather
231231
primitive with hardcoded, predefined symbols. At some point we probably should
232232
be able to use TypeScript's own global `.d.ts` files, such as
233-
[es2023.array.d.ts](https://github.com/microsoft/TypeScript/blob/main/src/lib/es2023.array.d.ts),
233+
[`es2023.array.d.ts`](https://github.com/microsoft/TypeScript/blob/main/src/lib/es2023.array.d.ts),
234234
directly.
235235
* **`JsModuleInfoCollector`**. This one is responsible for collecting
236236
information about a module, and for performing our module-level inference.
@@ -285,7 +285,7 @@ both `left` and `right` resolve to `TypeData::Number`, the entire expression can
285285
be _flattened_ to `TypeData::Number`, because that's the result of adding two
286286
numbers. And in most other cases it will become `TypeData::String` instead.
287287

288-
Flattening is implemented in [flattening.rs](src/flattening.rs).
288+
Flattening is implemented in [`flattening.rs`](src/flattening.rs).
289289

290290
## `ResolvedTypeData`
291291

crates/biome_parser/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -208,7 +208,7 @@ if !p.at(T![if]) {
208208
}
209209
```
210210

211-
Why return `ParsedSyntax::Absent`? The function must return `ParsedSyntax::Absent` if the rule can't predict by the next token(s) if they form the expected node or not. Doing so allows the calling rule to decide if this is an error and perform an error recovery if necessary. The second reason is to ensure that the rule doesn't return a node where all children are missing.
211+
Why return `ParsedSyntax::Absent`? The function must return `ParsedSyntax::Absent` if the rule can't predict by the next token(s) if they form the expected node or not. Doing so allows the calling rule to decide if this is an error and perform an error recovery if necessary. The second reason is to ensure that the rule doesn't return a node where all children are missing.
212212

213213
Your rule implementation may want to consider more than just the first child to determine if it can parse at least some of the expected children.
214214
For example, the if statement rule could test if the parser is located at an `else` clause and then create an `if` statement where all children are missing except the `else` clause:
@@ -358,7 +358,7 @@ In these cases the `ParseSeparatedList` and `ParseNodeList` will recover the par
358358
The conditional syntax allows you to express that some syntax may not be valid in all source files. Some use cases are:
359359

360360
* syntax that is only supported in strict or sloppy mode: for example, `with` statements is not valid when a JavaScript file uses `"use strict"` or is a module;
361-
* syntax that is only supported in certain file types: Typescript, JSX, modules;
361+
* syntax that is only supported in certain file types: TypeScript, JSX, modules;
362362
* syntax that is only available in specific language versions: experimental features, different versions of the language e.g. (ECMA versions for JavaScript);
363363

364364
The idea is that the parser always parses the syntax regardless of whatever it is supported in this specific file or context.

crates/biome_service/CONTRIBUTING.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,16 @@ Note that there are two implementations of the `Workspace` trait:
1717

1818
## Watcher
1919

20-
The state inside our workspace is kept in sync with the file system using the
20+
The state inside our workspace is kept in sync with the filesystem using the
2121
[`WorkspaceWatcher`](src/workspace_watcher.rs). The watcher is only active in
2222
daemon mode and not used by the CLI.
2323

2424
### Debugging
2525

2626
Debugging the watcher can be tricky, because you need to run the daemon,
27-
interact with the file system, and observe the daemon's state somehow.
27+
interact with the filesystem, and observe the daemon's state somehow.
2828

29-
Debugging is possible with the VS Code extension or Zed extension, but for an easier experience,
29+
Debugging is possible with the VS Code extension or Zed extension, but for an easier experience,
3030
you can use these CLI commands:
3131

3232
1. Start the daemon using `cargo run --bin=biome -- start`. Note there won't be

0 commit comments

Comments
 (0)