From 2bbe6b4456b94deec0ccdf00931138ff6698e14c Mon Sep 17 00:00:00 2001 From: Hasit Mistry Date: Wed, 17 Jul 2024 09:38:37 -0700 Subject: [PATCH] Update default settings for CodeRabbit tools --- docs/guides/tools/biome.md | 163 +----------------------------- docs/guides/tools/markdownlint.md | 47 +-------- docs/guides/tools/ruff.md | 102 +------------------ docs/guides/tools/swiftlint.md | 91 +---------------- docs/guides/tools/yamllint.md | 19 +--- 5 files changed, 5 insertions(+), 417 deletions(-) diff --git a/docs/guides/tools/biome.md b/docs/guides/tools/biome.md index 6cd64c31..953debee 100644 --- a/docs/guides/tools/biome.md +++ b/docs/guides/tools/biome.md @@ -29,168 +29,7 @@ Biome supports the following config files: - `biome.jsonc` - `biome.json` -CodeRabbit will use the following settings based on the profile selected if no config file is found: - -### Chill - -```json -{ - "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json", - "organizeImports": { - "enabled": false - }, - "formatter": { - "enabled": false - }, - "linter": { - "enabled": true, - "rules": { - "all": false, - "recommended": true, - "a11y": { - "recommended": false - }, - "correctness": { - "useExhaustiveDependencies": "off", - "noInnerDeclarations": "off" - }, - "style": { - "recommended": false, - "noArguments": "warn", - "noCommaOperator": "warn", - "noUselessElse": "warn", - "useAsConstAssertion": "off", - "useBlockStatements": "off", - "useConsistentArrayType": "off", - "useDefaultParameterLast": "warn", - "useEnumInitializers": "off", - "useExponentiationOperator": "warn", - "useExportType": "off", - "useFragmentSyntax": "off", - "useImportType": "off", - "useLiteralEnumMembers": "warn", - "useShorthandArrayType": "off", - "noUnusedTemplateLiteral": "off" - }, - "complexity": { - "noForEach": "off", - "noExcessiveCognitiveComplexity": { - "level": "off", - "options": { - "maxAllowedComplexity": 25 - } - }, - "useLiteralKeys": "off", - "useArrowFunction": "off", - "useFlatMap": "off" - }, - "suspicious": { - "noArrayIndexKey": "off", - "noExplicitAny": "off", - "noImplicitAnyLet": "off", - "noDoubleEquals": "off" - }, - "nursery": { - "all": false - } - } - }, - "css": { - "linter": { - "enabled": true - }, - "parser": { - "cssModules": true - } - }, - "javascript": { - "parser": { - "unsafeParameterDecoratorsEnabled": true - } - } -} -``` - -### Assertive - -```json -{ - "$schema": "https://biomejs.dev/schemas/1.8.3/schema.json", - "organizeImports": { - "enabled": false - }, - "formatter": { - "enabled": false - }, - "linter": { - "enabled": true, - "rules": { - "all": false, - "recommended": true, - "a11y": { - "recommended": "" - }, - "correctness": { - "useExhaustiveDependencies": "off", - "noInnerDeclarations": "warn" - }, - "style": { - "recommended": true, - "noArguments": "warn", - "noCommaOperator": "warn", - "noUselessElse": "warn", - "useAsConstAssertion": "off", - "useBlockStatements": "off", - "useConsistentArrayType": "off", - "useDefaultParameterLast": "warn", - "useEnumInitializers": "off", - "useExponentiationOperator": "warn", - "useExportType": "off", - "useFragmentSyntax": "off", - "useImportType": "off", - "useLiteralEnumMembers": "warn", - "useShorthandArrayType": "off", - "noUnusedTemplateLiteral": "off" - }, - "complexity": { - "noForEach": "off", - "noExcessiveCognitiveComplexity": { - "level": "warn", - "options": { - "maxAllowedComplexity": 25 - } - }, - "useLiteralKeys": "off", - "useArrowFunction": "", - "useFlatMap": "" - }, - "suspicious": { - "noArrayIndexKey": "", - "noExplicitAny": "", - "noImplicitAnyLet": "", - "noDoubleEquals": "" - }, - "nursery": { - "all": false - } - } - }, - "css": { - "linter": { - "enabled": true - }, - "parser": { - "cssModules": true - } - }, - "javascript": { - "parser": { - "unsafeParameterDecoratorsEnabled": true - } - } -} - -``` +CodeRabbit will use the default settings based on the profile selected if no config file is found. ## Links diff --git a/docs/guides/tools/markdownlint.md b/docs/guides/tools/markdownlint.md index 14f3c0c8..137eb56b 100644 --- a/docs/guides/tools/markdownlint.md +++ b/docs/guides/tools/markdownlint.md @@ -22,52 +22,7 @@ Markdownlint supports the following config files: - `.markdownlint.yaml` - `.markdownlint.yml` -CodeRabbit will use the following settings based on the profile selected if no config file is found: - -### Chill - -```json -{ - "default": true, - "line-length": false, - "no-duplicate-heading": { - "siblings_only": true - }, - "no-trailing-punctuation": { - "punctuation": ".,;:" - }, - "ol-prefix": false, - "list-marker-space": false, - "no-inline-html": false, - "first-line-h1": false, - "no-trailing-spaces": false, - "single-h1": false, - "blank_lines": false, -} -``` - -### Assertive - -```json -{ - "default": true, - "line-length": false, - "no-duplicate-heading": { - "siblings_only": true - }, - "no-trailing-punctuation": { - "punctuation": ".,;:" - }, - "ol-prefix": true, - "list-marker-space": false, - "no-inline-html": true, - "first-line-h1": true, - "no-trailing-spaces": true, - "single-h1": true, - "blank_lines": true, -} - -``` +CodeRabbit will use the default settings based on the profile selected if no config file is found. ## Links diff --git a/docs/guides/tools/ruff.md b/docs/guides/tools/ruff.md index a94bdec8..255ce816 100644 --- a/docs/guides/tools/ruff.md +++ b/docs/guides/tools/ruff.md @@ -20,107 +20,7 @@ Ruff supports the following config files: - `ruff.toml` - `.ruff.toml` -CodeRabbit will use the following settings based on the profile selected if no config file is found: - -### Chill - -```toml -[lint] -select = [ - # pycodestyle subset rules - "E7", - "E9", - # Pyflakes - "F", - # flake8-bugbear - "B", - # flake8-simplify - "SIM", - # isort subset rules - "I002", -] -[lint.per-file-ignores] -"**/__init__.py" = ["E402"] -"**/conftest.py" = ["E402"] -``` - -### Assertive - -```toml -[lint] -select = [ - # pycodestyle subset rules - "E7", - "E9", - # Pyflakes - "F", - # flake8-bugbear - "B", - # flake8-simplify - "SIM", - # isort subset rules - "I002", - # pycodestyle subset rules - "E4", - "E101", - # mccabe - "C90", - # flake8-annotations - "ANN", - # flake8-async - "ASYNC", - # flake8-trio - "TRIO", - # flake8-bandit - "S", - # flake8-blind-except - "BLE", - # flake8-boolean-trap - "FBT", - # flake8-commas - "COM", - # flake8-comprehensions - "C4", - # flake8-datetimez - "DTZ", - # flake8-debugger - "T10", - # flake8-django - "DJ", - # flake8-executable - "EXE", - # flake8-implicit-str-concat - "ISC", - # flake8-logging - "LOG", - # flake8-logging-format - "G", - # flake8-pie - "PIE", - # flake8-pytest-style - "PT", - # flake8-raise - "RSE", - # flake8-return - "RET", - # flake8-unused-arguments - "ARG", - # tryceratops - "TRY", - # flynt - "FLY", - # Ruff-specific rules - "RUF", - # pyupgrade - "UP", -] -[lint.per-file-ignores] -"**/__init__.py" = ["E402"] -"**/conftest.py" = ["E402"] -"**/*_test.py" = ["S101"] -"**/test_*.py" = ["S101"] -"**/{test,tests}/**/*.py" = ["S101"] -``` +CodeRabbit will use the default settings based on the profile selected if no config file is found. ## Links diff --git a/docs/guides/tools/swiftlint.md b/docs/guides/tools/swiftlint.md index 4c7c0ad8..516d99af 100644 --- a/docs/guides/tools/swiftlint.md +++ b/docs/guides/tools/swiftlint.md @@ -20,96 +20,7 @@ Ruff supports the following config files: - `.swiftlint.yaml` - `.swiftlint.yml` -CodeRabbit will use the following settings if no config file is found: - -```yaml -disabled_rules: - - closure_body_length - - cyclomatic_complexity - - enum_case_associated_values_count - - file_length - - function_body_length - - function_parameter_count - - large_tuple - - line_length - - nesting - - type_body_length - - attributes - - closing_brace - - closure_end_indentation - - closure_parameter_position - - closure_spacing - - collection_alignment - - colon - - comma - - comma_inheritance - - computed_accessors_order - - conditional_returns_on_newline - - control_statement - - custom_rules - - direct_return - - empty_enum_arguments - - empty_parameters - - empty_parentheses_with_trailing_closure - - explicit_self - - file_header - - file_types_order - - identifier_name - - implicit_getter - - implicit_return - - inclusive_language - - indentation_width - - leading_whitespace - - let_var_whitespace - - literal_expression_end_indentation - - modifier_order - - multiline_arguments - - multiline_arguments_brackets - - multiline_function_chains - - multiline_literal_brackets - - multiline_parameters - - multiline_parameters_brackets - - multiple_closures_with_trailing_closure - - no_space_in_method_call - - non_overridable_class_declaration - - number_separator - - opening_brace - - operator_usage_whitespace - - operator_whitespace - - optional_enum_case_matching - - period_spacing - - prefer_self_in_static_references - - prefer_self_type_over_type_of_self - - prefixed_toplevel_constant - - protocol_property_accessors_order - - redundant_discardable_let - - redundant_self_in_closure - - return_arrow_whitespace - - self_binding - - shorthand_argument - - shorthand_operator - - single_test_class - - sorted_enum_cases - - sorted_imports - - statement_position - - superfluous_else - - switch_case_alignment - - switch_case_on_newline - - trailing_closure - - trailing_comma - - trailing_newline - - trailing_whitespace - - type_contents_order - - unneeded_parentheses_in_closure_argument - - unused_optional_binding - - vertical_parameter_alignment - - vertical_parameter_alignment_on_call - - vertical_whitespace - - vertical_whitespace_between_cases - - vertical_whitespace_closing_braces - - vertical_whitespace_opening_braces - - void_return -``` +CodeRabbit will use the default settings if no config file is found. ## Links diff --git a/docs/guides/tools/yamllint.md b/docs/guides/tools/yamllint.md index 8b4a9dda..962a2a78 100644 --- a/docs/guides/tools/yamllint.md +++ b/docs/guides/tools/yamllint.md @@ -21,24 +21,7 @@ Yamllint supports the following config files: - `.yamllint.yaml` - `.yamllint.yml` -CodeRabbit will use the following settings based on the profile selected if no config file is found: - -### Chill - -```yaml -extends: relaxed -rules: - line-length: disable -``` - -### Assertive - -```yaml -extends: default -rules: - line-length: disable - document-start: disable -``` +CodeRabbit will use the default settings based on the profile selected if no config file is found. ## Links