don/08-04-feat_website_auto-generate_rule_docs_pages - Branch - oxc-project/oxc

feat(website): auto-generate rule docs pages

#4640Merged

Comparing

don/08-04-feat_website_auto-generate_rule_docs_pages

(

f629514

) with

main

(

d191823

)

Untouched: 29

Benchmarks

Passed

minifier[react.development.js]

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

+1%

3.7 ms3.7 ms

transformer[RadixUIAdoptionSection.jsx]

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

223.7 µs222.9 µs

linter[cal.com.tsx]

tasks/benchmark/benches/linter.rs::linter::bench_linter

786.7 ms784.5 ms

parser[RadixUIAdoptionSection.jsx]

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

77.3 µs77.1 µs

lexer[RadixUIAdoptionSection.jsx]

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

22.3 µs22.3 µs

semantic[pdf.mjs]

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

20.8 ms20.7 ms

transformer[pdf.mjs]

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

37.8 ms37.8 ms

lexer[antd.js]

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

19.9 ms19.9 ms

transformer[checker.ts]

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

139 ms139 ms

sourcemap[cal.com.tsx]

tasks/benchmark/benches/sourcemap.rs::sourcemap::bench_sourcemap

61.5 ms61.5 ms

minifier[typescript.js]

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

635.6 ms635.6 ms

codegen_sourcemap[checker.ts]

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

72.9 ms72.9 ms

lexer[checker.ts]

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

12 ms12 ms

parser[antd.js]

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

104.3 ms104.3 ms

parser[pdf.mjs]

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

17.1 ms17.1 ms

codegen[checker.ts]

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

20 ms20 ms

isolated-declarations[vue-id.ts]

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

380.3 ms380.3 ms

lexer[pdf.mjs]

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

3.2 ms3.2 ms

minifier[antd.js]

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

352.6 ms352.6 ms

semantic[antd.js]

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

126.9 ms126.9 ms

parser[cal.com.tsx]

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

24.2 ms24.2 ms

transformer[antd.js]

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

245.2 ms245.2 ms

parser[checker.ts]

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

52.4 ms52.4 ms

lexer[cal.com.tsx]

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

4.9 ms4.9 ms

semantic[checker.ts]

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

76.1 ms76.1 ms

transformer[cal.com.tsx]

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

63 ms63 ms

semantic[RadixUIAdoptionSection.jsx]

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

-1%

100 µs100.9 µs

linter[checker.ts]

tasks/benchmark/benches/linter.rs::linter::bench_linter

-1%

1.4 s1.4 s

semantic[cal.com.tsx]

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

-1%

46.4 ms46.9 ms

Commits

Click on a commit to change the comparison range

Base

main

d191823

-0.04%

feat(website): auto-generate rule docs pages (#4640) > AI-generated description because I'm lazy ### TL;DR This PR introduces the ability to generate documentation for linter rules and adds new methods and metadata for rule fix capabilities. To see what this looks like, please check out https://github.com/oxc-project/oxc-project.github.io/pull/165. ## Screenshots Hyperlinks to rule doc pages in auto-generated rules table <img width="809" alt="image" src="https://github.com/user-attachments/assets/e09eb47d-e86a-4ed1-b1f9-5034f33c71a2"> Example of a docs page <img width="1273" alt="image" src="https://github.com/user-attachments/assets/78f7e9e6-f4dd-4cc9-aebc-1cdd64b024ec"> ### What changed? - Added `RuleFixMeta` to indicate rule fix capabilities - Introduced methods `is_none` and `is_pending` in `RuleFixMeta` - Modified `render_markdown_table` in `RuleTableSection` to accept an optional link prefix - Created new modules for rule documentation and HTML rendering - Updated `print_rules` function to generate markdown for rules and detailed documentation pages ### How to test? Run the `linter-rules` task with appropriate arguments to generate the markdown table and documentation pages. Verify the generated files for correctness and that all metadata is correctly displayed. ### Why make this change? To enhance the project documentation and provide clear rule fix capabilities, thereby improving the developer experience and easing the integration process. ---

f629514

1 year ago

by DonIsaac

Home Terms Privacy Docs