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.

Sign up for GitHub

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

Jump to bottom

docs: update contributing guidelines according to previous changes #3527

Merged
merged 1 commit into from
Jul 26, 2024
Merged

docs: update contributing guidelines according to previous changes #3527

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 10 additions & 9 deletions crates/biome_analyze/CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -256,12 +256,12 @@ declare_lint_rule! {

##### Biome lint rules inspired by other lint rules

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 `Source`, which is an `enum` that contains various variants.
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.

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:

```rust
use biome_analyze::{declare_lint_rule, Source};
use biome_analyze::{declare_lint_rule, RuleSource};

declare_lint_rule! {
/// Documentation
Expand All @@ -270,15 +270,15 @@ declare_lint_rule! {
name: "myRuleName",
language: "js",
recommended: false,
source: Source::Eslint("no-debugger"),
sources: &[RuleSource::Eslint("no-debugger")],
}
}
```

If the rule you're implementing has a different behaviour or option, you can add the `source_kind` metadata and use the `SourceKind::Inspired` type.
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`.

```rust
use biome_analyze::{declare_lint_rule, Source, SourceKind};
use biome_analyze::{declare_lint_rule, RuleSource, RuleSourceKind};

declare_lint_rule! {
/// Documentation
Expand All @@ -287,12 +287,13 @@ declare_lint_rule! {
name: "myRuleName",
language: "js",
recommended: false,
source: Source::Eslint("no-debugger"),
source_kind: SourceKind::Inspired,
sources: &[RuleSource::Eslint("no-debugger")],
source_kind: RuleSourceKind::Inspired,
}
}
```
By default, `source_kind` is always `SourceKind::Same`.

By default, `source_kind` is always `RuleSourceKind::SameLogic`.

#### Category Macro

Expand Down Expand Up @@ -613,7 +614,7 @@ impl Rule for UseYield {

A swift way to test your rule is to go inside the `biome_js_analyze/src/lib.rs` file (this will change based on where you're implementing the rule) and modify the `quick_test` function.

Usually this test is ignored, so remove _comment_ the macro `#[ignore]` macro, change the `let SOURCE` variable to whatever source code you need to test. Then update the rule filter, and add your rule:
Usually this test is ignored, so remove _comment_ the macro `#[ignore]` macro, change the `let SOURCE` variable to whatever source code you need to test. Then update the rule filter, and add your rule:

```rust
let rule_filter = RuleFilter::Rule("nursery", "useAwesomeTrick");
Expand Down