dan/oxc
1
0
Fork 0
mirror of https://github.com/danbulant/oxc synced 2026-05-19 04:08:41 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

feat(linter): Format the configuration documentation correctly (#8583)

Browse source 
The categories section in the documentation is not formatted correctly.
This fix aims to correct the formatting.

Before 
<img width="1194" alt="before"
src="https://github.com/user-attachments/assets/d2eb682b-5971-43ee-bdf0-92eb2e9c78a2"
/>

After 
<img width="1266" alt="after"
src="https://github.com/user-attachments/assets/a4b992c2-fe33-4781-ad0b-de822f87c2d6"
/>
This commit is contained in:
Tapan Prakash 2025-01-18 14:32:32 +05:30 committed by GitHub
parent 4a59d29c30
commit 538b24a719
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
4 changed files with 4 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
crates/oxc_linter/src/config/categories.rs
View file

@ -61,7 +61,7 @@ Configure an entire category of rules all at once.
Rules enabled or disabled this way will be overwritten by individual rules in the `rules` field.
# Example
Example
```json
{
"$schema": "./node_modules/oxlint/configuration_schema.json",

2
crates/oxc_linter/src/snapshots/schema_json.snap
View file

@ -305,7 +305,7 @@ snapshot_kind: text
},
"OxlintCategories": {
"title": "Rule Categories",
"description": "Configure an entire category of rules all at once.\n\nRules enabled or disabled this way will be overwritten by individual rules in the `rules` field.\n\n# Example\n```json\n{\n \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n \"categories\": {\n \"correctness\": \"warn\"\n },\n \"rules\": {\n \"eslint/no-unused-vars\": \"error\"\n }\n}\n```",
"description": "Configure an entire category of rules all at once.\n\nRules enabled or disabled this way will be overwritten by individual rules in the `rules` field.\n\nExample\n```json\n{\n \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n \"categories\": {\n \"correctness\": \"warn\"\n },\n \"rules\": {\n \"eslint/no-unused-vars\": \"error\"\n }\n}\n```",
"examples": [
{
"correctness": "warn"

2
npm/oxlint/configuration_schema.json
View file

@ -300,7 +300,7 @@
},
"OxlintCategories": {
"title": "Rule Categories",
"description": "Configure an entire category of rules all at once.\n\nRules enabled or disabled this way will be overwritten by individual rules in the `rules` field.\n\n# Example\n```json\n{\n \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n \"categories\": {\n \"correctness\": \"warn\"\n },\n \"rules\": {\n \"eslint/no-unused-vars\": \"error\"\n }\n}\n```",
"description": "Configure an entire category of rules all at once.\n\nRules enabled or disabled this way will be overwritten by individual rules in the `rules` field.\n\nExample\n```json\n{\n \"$schema\": \"./node_modules/oxlint/configuration_schema.json\",\n \"categories\": {\n \"correctness\": \"warn\"\n },\n \"rules\": {\n \"eslint/no-unused-vars\": \"error\"\n }\n}\n```",
"examples": [
{
"correctness": "warn"

2
tasks/website/src/linter/snapshots/schema_markdown.snap
View file

@ -62,7 +62,7 @@ Configure an entire category of rules all at once.
Rules enabled or disabled this way will be overwritten by individual rules in the `rules` field.
# Example
Example
```json
{
"$schema": "./node_modules/oxlint/configuration_schema.json",