oxfmt-config-fields-docs - Branch - oxc-project/oxc

docs(oxfmt): Improve docs for `.oxfmtrc.jsonc` config fields and add markdownDescription fields to JSON Schema

#16587

Comparing

oxfmt-config-fields-docs

(

6242c41

) with

main

(

fef77af

)

Untouched: 38

Skipped: 7

No successful run was found on main ( 1149b6a) during the generation of this report, so fef77af was used instead as the comparison base. There might be some changes unrelated to this pull request in this report.

Benchmarks

Skipped (7)

Passed

transformer[cal.com.tsx]

tasks/benchmark/benches/transformer.rs::transformer::bench_transformer

+2%

26.6 ms*26.1 ms

mangler[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/minifier.rs::minifier::bench_mangler

13.3 µs*13.2 µs

formatter[next.ts]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

2.8 ms*2.7 ms

semantic[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/semantic.rs::semantic::bench_semantic

72 µs*71.8 µs

formatter[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

462.5 µs*461.9 µs

minifier[react.development.js]

tasks/benchmark/benches/minifier.rs::minifier::bench_minifier

2.5 ms*2.5 ms

codegen[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/codegen.rs::codegen::bench_codegen

122.3 µs*122.2 µs

minifier[cal.com.tsx]

tasks/benchmark/benches/minifier.rs::minifier::bench_minifier

36 ms*36 ms

codegen[react.development.js]

tasks/benchmark/benches/codegen.rs::codegen::bench_codegen

1.9 ms*1.9 ms

semantic[react.development.js]

tasks/benchmark/benches/semantic.rs::semantic::bench_semantic

1.6 ms*1.6 ms

codegen[binder.ts]

tasks/benchmark/benches/codegen.rs::codegen::bench_codegen

4.3 ms*4.3 ms

lexer[react.development.js]

tasks/benchmark/benches/lexer.rs::lexer::bench_lexer

356.1 µs*355.9 µs

transformer[react.development.js]

tasks/benchmark/benches/transformer.rs::transformer::bench_transformer

716.4 µs*716.1 µs

semantic[binder.ts]

tasks/benchmark/benches/semantic.rs::semantic::bench_semantic

4 ms*4 ms

formatter[Search.tsx]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

1.9 ms*1.9 ms

parser[react.development.js]

tasks/benchmark/benches/parser.rs::parser::bench_parser

1.3 ms*1.3 ms

lexer[binder.ts]

tasks/benchmark/benches/lexer.rs::lexer::bench_lexer

882.1 µs*882 µs

estree[checker.ts]

tasks/benchmark/benches/parser.rs::parser::bench_estree

104.5 ms*104.5 ms

parser[cal.com.tsx]

tasks/benchmark/benches/parser.rs::parser::bench_parser

26 ms*26 ms

parser[binder.ts]

tasks/benchmark/benches/parser.rs::parser::bench_parser

3.2 ms*3.2 ms

formatter[core.js]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

2.2 ms*2.2 ms

lexer[cal.com.tsx]

tasks/benchmark/benches/lexer.rs::lexer::bench_lexer

5.4 ms*5.4 ms

minifier[binder.ts]

tasks/benchmark/benches/minifier.rs::minifier::bench_minifier

4 ms*4 ms

formatter[index.tsx]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

4.5 ms*4.5 ms

mangler[cal.com.tsx]

tasks/benchmark/benches/minifier.rs::minifier::bench_mangler

2.9 ms*2.9 ms

formatter[types.ts]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

14.7 ms*14.7 ms

isolated-declarations[vue-id.ts]

tasks/benchmark/benches/transformer.rs::transformer::bench_isolated_declarations

58 ms*58.1 ms

mangler[binder.ts]

tasks/benchmark/benches/minifier.rs::minifier::bench_mangler

762 µs*762.7 µs

semantic[cal.com.tsx]

tasks/benchmark/benches/semantic.rs::semantic::bench_semantic

26.3 ms*26.3 ms

formatter[errors.ts]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

764.8 µs*765.8 µs

formatter[handle-comments.js]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

3.5 ms*3.5 ms

lexer[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/lexer.rs::lexer::bench_lexer

21.2 µs*21.2 µs

transformer[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/transformer.rs::transformer::bench_transformer

135.7 µs*135.9 µs

codegen[cal.com.tsx]

tasks/benchmark/benches/codegen.rs::codegen::bench_codegen

33.9 ms*34 ms

transformer[binder.ts]

tasks/benchmark/benches/transformer.rs::transformer::bench_transformer

1.7 ms*1.7 ms

mangler[react.development.js]

tasks/benchmark/benches/minifier.rs::minifier::bench_mangler

267.2 µs*267.8 µs

formatter[App.tsx]

tasks/benchmark/benches/formatter.rs::formatter::bench_formatter

48.6 ms*48.7 ms

parser[RadixUIAdoptionSection.jsx]

tasks/benchmark/benches/parser.rs::parser::bench_parser

81 µs*81.3 µs

Commits

Click on a commit to change the comparison range

Base

main

fef77af

-0.07%

Update snaps and schema.

f6595c8

9 hours ago

by connorshea

+0.11%

docs(oxfmt): Add markdownDescription fields and unify the schema generation process. With this change, the descriptions for each field in the JSON schema are rendered with proper markdown formatting in VS Code and other editors based on VS Code. This now matches the implementation for the Oxlintrc schema generation.

6242c41

9 hours ago

by connorshea

Home Terms Privacy Docs