Skip to content

Commit f20c4c7

Browse files
committed
docs: add docs about options
1 parent f2f1780 commit f20c4c7

File tree

4 files changed

+26
-3
lines changed

4 files changed

+26
-3
lines changed

crates/biome_cli/src/execute/migrate/eslint_any_rule_to_biome.rs

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

crates/biome_js_analyze/src/lint/nursery/no_excessive_lines_per_function.rs

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -81,6 +81,7 @@ declare_lint_rule! {
8181
/// ```
8282
///
8383
/// ### skipBlankLines
84+
///
8485
/// When this options is set to `true`, blank lines in the function body are not counted towards the maximum line limit.
8586
/// This means that only lines with actual code or comments will be counted.
8687
///
@@ -105,6 +106,7 @@ declare_lint_rule! {
105106
/// ```
106107
///
107108
/// ### skipIifes
109+
///
108110
/// When this option is set to `true`, Immediately Invoked Function Expressions (IIFEs) are not checked for the maximum line limit.
109111
///
110112
/// Default: `false`
@@ -221,8 +223,11 @@ pub struct State {
221223
#[cfg_attr(feature = "schema", derive(JsonSchema))]
222224
#[serde(rename_all = "camelCase", deny_unknown_fields, default)]
223225
pub struct NoExcessiveLinesPerFunctionOptions {
226+
/// The maximum number of lines allowed in a function body.
224227
pub max_lines: NonZeroU8,
228+
/// When this options is set to `true`, blank lines in the function body are not counted towards the maximum line limit.
225229
pub skip_blank_lines: bool,
230+
/// When this option is set to `true`, Immediately Invoked Function Expressions (IIFEs) are not checked for the maximum line limit.
226231
pub skip_iifes: bool,
227232
}
228233

packages/@biomejs/backend-jsonrpc/src/workspace.ts

Lines changed: 9 additions & 0 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

packages/@biomejs/biome/configuration_schema.json

Lines changed: 11 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)