### Run Tool Example with `just example`

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Runs a tool's example, such as a linter example. Use this for quick testing of specific tools within the project.

```bash
just example tool     # Run tool example (e.g., just example linter)
```

--------------------------------

### Run `oxc_linter` Example

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Runs the `linter` example for the `oxc_linter` crate on a specified directory. Useful for testing linting rules.

```bash
cargo run -p oxc_linter --example linter -- src/
```

--------------------------------

### Project file structure for oxfmt example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/sort_package_json/1.snap.md

This file tree represents the directory structure for the oxfmt example, including configuration and source files.

```tree
- fixtures/ <CWD>
  - disabled.json
  - package.json
  - sort_scripts.json
```

--------------------------------

### Run Crate Examples for Testing

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Executes examples from specific crates for quick testing and debugging. Replace `<crate_name>` and `<example_name>` with the relevant identifiers.

```bash
cargo run -p <crate_name> --example <example_name> -- [args]
```

--------------------------------

### Define project file structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/stdin/1.snap.md

Example directory layout for testing the formatter.

```text
- fixtures/ <CWD>
  - input.graphql
  - input.rb
  - input.ts
```

--------------------------------

### Run `oxc` Compiler Example

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Runs the `compiler` example for the main `oxc` crate with the `full` feature enabled, processing a JavaScript file. Useful for testing the full compilation pipeline.

```bash
cargo run -p oxc --example compiler --features="full" -- test.js
```

--------------------------------

### Define project file structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config_parse_error/0.snap.md

Example file tree showing configuration files and source files.

```text
- fixtures/ <CWD>
  - .oxfmtrc.json
  - root.js
  - sub/
    - .oxfmtrc.json
```

--------------------------------

### Run `oxc_transformer` Example

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Executes the `transformer` example for the `oxc_transformer` crate on an input JavaScript file. Useful for testing code transformations.

```bash
cargo run -p oxc_transformer --example transformer -- input.js
```

--------------------------------

### Initialize with Workspace Options

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/README.md

Example of client-provided initialization options, including workspace URI and specific Oxc configuration settings.

```json
{
  "initializationOptions": [
    {
      "workspaceUri": "file://workspace-directory",
      "options": {
        "run": "onType",
        "configPath": null,
        "tsConfigPath": null,
        "unusedDisableDirectives": "allow",
        "typeAware": false,
        "disableNestedConfig": false,
        "fixKind": "safe_fix",
        "rulesCustomization": {},
        "fmtConfigPath": null
        }
      }
    }
  ]
}
```

--------------------------------

### Oxfmt Configuration File Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/6.snap.md

This is an example of the `.oxfmtrc.json` file created after migrating from a Prettier configuration. It includes settings for Tailwind CSS sorting, print width, package.json sorting, and ignore patterns.

```json
{
  "sortTailwindcss": {},
  "printWidth": 80,
  "sortPackageJson": false,
  "ignorePatterns": []
}
```

--------------------------------

### Run `oxc_parser` Example

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Runs the `parser` example for the `oxc_parser` crate, processing a JavaScript file. Useful for debugging parsing logic.

```bash
cargo run -p oxc_parser --example parser -- test.js
```

--------------------------------

### Oxformatter Configuration File Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/js_config/0.snap.md

An example of an oxfmt configuration file. This file specifies formatting rules for the tool.

```typescript
export default {
  // ...
};
```

--------------------------------

### Example file tree structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/config_ignore_patterns/1.snap.md

Represents the directory layout for testing formatting configurations.

```text
- fixtures/
  - basic/ <CWD>
    - .oxfmtrc.json
    - fmtrc.jsonc
    - not-formatted/
      - bad.js
      - err.js
  - nested_cwd/
    - .oxfmtrc.json
    - generated/
      - error.html
    - src/
      - test.js
    - sub/
      - generated/
        - error.html
      - src/
        - test.js
```

--------------------------------

### Example File Tree for Migration

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_biome/11.snap.md

Illustrates the directory structure before running the migration command, showing various configuration files and test cases.

```plaintext
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - arrow_parens/
    - biome.json
  - attribute_position/
    - biome.json
  - basic_config/
    - biome.json
  - both_json_jsonc/
    - biome.json
    - biome.jsonc
  - defaults/
    - biome.json
  - force_ignore/
    - biome.json
  - ignore_patterns/
    - biome.json
  - js_overrides/
    - biome.json
  - jsonc_config/
    - biome.jsonc
  - no_config/
    - .gitkeep
  - warn_overrides/ <CWD>
    - biome.json
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_biome/7.snap.md

Illustrates the directory structure and relevant configuration files for testing Oxc formatter migrations.

```plaintext
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - arrow_parens/ <CWD>
    - biome.json
  - attribute_position/
    - biome.json
  - basic_config/
    - biome.json
  - both_json_jsonc/
    - biome.json
    - biome.jsonc
  - defaults/
    - biome.json
  - force_ignore/
    - biome.json
  - ignore_patterns/
    - biome.json
  - js_overrides/
    - biome.json
  - jsonc_config/
    - biome.jsonc
  - no_config/
    - .gitkeep
  - warn_overrides/
    - biome.json
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/exclude_nested/0.snap.md

This is the file tree structure used in the example. The `oxfmt --check` command operates on files within this structure.

```text
- fixtures/ <CWD>
  - foo/
    - bar/
      - error.js
      - ok.js
    - ok.js
  - ok.js
```

--------------------------------

### Example file tree structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/vite_config/3.snap.md

Represents the directory layout for testing formatting scenarios.

```text
- fixtures/
  - basic/
    - child/
      - test.ts
    - test.ts
    - vite.config.ts
  - monorepo/
    - .oxfmtrc.json
    - packages/
      - app/ <CWD>
        - test.ts
        - vite.config.ts
```

--------------------------------

### Example File Tree for oxfmt

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/svelte/0.snap.md

Illustrates a typical project file structure relevant to oxfmt operations, including source files and configuration files.

```text
- fixtures/ <CWD>
  - App.svelte
  - Doc.mdx
  - fmt-bool-disable.json
  - fmt-md-only.json
  - fmt-no-svelte.json
  - fmt-overrides-only.json
  - fmt-root-overrides.json
  - fmt-simple.json
  - legacy/
    - Old.svelte
  - README.md
  - script.js
```

--------------------------------

### File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/sort_imports/1.snap.md

Illustrates the directory structure and relevant files for the formatting check example, including configuration and source files.

```text
- fixtures/ <CWD>
  - custom_groups_selector_modifiers.json
  - custom_groups_selector_modifiers.ts
  - custom_groups.json
  - custom_groups.ts
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/vite_plus/7.snap.md

Illustrates a typical file tree structure for oxfmt snapshot tests, including various fixture directories and configuration files.

```text
- fixtures/
  - basic/
    - test.ts
    - vite.config.ts
  - error_load_failure/
    - .oxfmtrc.json
    - child/
      - test.ts
      - vite.config.ts
  - fn_export/
    - test.ts
    - vite.config.ts
  - no_fmt_field/
    - test.ts
    - vite.config.ts
  - priority/ <CWD>
    - oxfmt.config.ts
    - test.ts
    - vite.config.ts
  - skip_finds_parent/
    - .oxfmtrc.json
    - child/
      - test.ts
      - vite.config.ts
```

--------------------------------

### Project File Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/external_formatter_with_config/0.snap.md

Example file tree for the Oxc project, showing configuration and test files.

```bash
- fixtures/ <CWD>
  - .oxfmtrc.json
  - test.vue
```

--------------------------------

### Project File Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config_prettierignore/0.snap.md

Example directory layout for an OXC project.

```text
- fixtures/ <CWD>
  - .oxfmtrc.json
  - .prettierignore
  - root-ignored.js
  - root.js
  - sub/
    - .oxfmtrc.json
    - formatted.js
    - sub-ignored.js
```

--------------------------------

### Oxformatter JSON Configuration File Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/js_config/0.snap.md

An example of an oxfmt configuration file in JSON format. This file specifies formatting rules for the tool.

```json
{
  // ...
}
```

--------------------------------

### Project file structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/error_reports/0.snap.md

Represents the directory layout for the formatting check example.

```text
- fixtures/ <CWD>
  - invalid.js
  - invalid.yaml
```

--------------------------------

### Example file tree structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/8.snap.md

Represents the directory structure containing various Prettier configuration scenarios.

```text
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - basic_config/
    - .prettierrc
  - default_printwidth/
    - .prettierrc
  - no_config/
    - .gitkeep
  - sort_pkg_disabled/ <CWD>
    - .prettierrc
  - sort_pkg_enabled/
    - .prettierrc
  - tailwind_empty/
    - .prettierrc
  - tailwind_options/
    - .prettierrc
  - tailwind_regex/
    - .prettierrc
  - with_ignore/
    - .prettierignore
    - .prettierrc
```

--------------------------------

### Workspace Configuration Example

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/README.md

Example of a client response for workspace configuration requests. This configuration influences how the Oxc language server operates, such as when to run diagnostics.

```json
[
  {
    "run": "onType",
    "configPath": null,
    "tsConfigPath": null,
    "unusedDisableDirectives": "allow",
    "typeAware": false,
    "disableNestedConfig": false,
    "fixKind": "safe_fix",
    "rulesCustomization": {},
    "fmt": {
      "configPath": null
    }
  }
]
```

--------------------------------

### Oxc Exit Code 1 Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/missing_plugin/output.snap.md

This example shows the standard output when Oxc fails to parse its configuration file due to a missing plugin.

```text
Failed to parse oxlint configuration file.

  x Failed to load JS plugin: ./plugin.js
  |   Cannot find module './plugin.js'

```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_biome/10.snap.md

Illustrates the directory structure for testing various configuration scenarios with oxfmt, including different Biome configurations and ignore patterns.

```plaintext
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - arrow_parens/
    - biome.json
  - attribute_position/
    - biome.json
  - basic_config/
    - biome.json
  - both_json_jsonc/
    - biome.json
    - biome.jsonc
  - defaults/
    - biome.json
  - force_ignore/ <CWD>
    - biome.json
  - ignore_patterns/
    - biome.json
  - js_overrides/
    - biome.json
  - jsonc_config/
    - biome.jsonc
  - no_config/
    - .gitkeep
  - warn_overrides/
    - biome.json
```

--------------------------------

### File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/5.snap.md

Example file tree structure relevant to Oxfmt migration tests, showing various Prettier configuration scenarios.

```text
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - basic_config/
    - .prettierrc
  - default_printwidth/
    - .prettierrc
  - no_config/
    - .gitkeep
  - sort_pkg_disabled/
    - .prettierrc
  - sort_pkg_enabled/
    - .prettierrc
  - tailwind_empty/
    - .prettierrc
  - tailwind_options/ <CWD>
    - .prettierrc
  - tailwind_regex/
    - .prettierrc
  - with_ignore/
    - .prettierignore
    - .prettierrc
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/config_file/1.snap.md

Illustrates a typical file tree structure for Oxc project fixtures, including configuration files and nested directories.

```treeview
- fixtures/
  - .oxfmtrc.json
  - .oxfmtrc.jsonc
  - fmt.config.ts
  - fmt.json
  - fmt.jsonc
  - nested/ <CWD>
    - .oxfmtrc.jsonc
    - deep/
      - test.js
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/gitignore/1.snap.md

This file tree illustrates a typical project structure with root and subdirectory .gitignore files, showing which files are intended to be ignored by the formatter.

```text
- fixtures/ <CWD>
  - .gitignore
  - another/
    - another.js
  - ignored-by-root.js
  - root.js
  - subdir/
    - .gitignore
    - ignored-by-subdir.js
    - sub.js
```

--------------------------------

### OXC CFG Plugin Output Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/cfg/output.snap.md

Displays the node visitation order and code path analysis for a while loop.

```text
  x cfg-plugin(cfg): Visited nodes:
  | * onCodePathStart                     Program
  | * onCodePathSegmentStart              Program
  | * onCodePathSegmentEnd                Literal
  | * onCodePathSegmentStart              Literal
  | * onCodePathSegmentEnd                BlockStatement
  | * onCodePathSegmentStart              BlockStatement
  | * onCodePathSegmentLoop               WhileStatement
  | * onCodePathSegmentEnd                WhileStatement
  | * onUnreachableCodePathSegmentStart   WhileStatement
  | * onUnreachableCodePathSegmentEnd     Program
  | * onCodePathEnd                       Program
   ,-[files/index.js:1:1]
 1 | while (true) {}
   : ^^^^^^^^^^^^^^^^
   `----

Found 0 warnings and 1 error.
Finished in Xms on 1 file with 2 rules using X threads.
```

--------------------------------

### Standard output for successful check

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/oxfmtrc_overrides/6.snap.md

Example output when all files are correctly formatted.

```text
Checking formatting...

All matched files use the correct format.
Finished in <time> on 4 files using 1 threads.
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/config_in_subdirectory/0.snap.md

Illustrates a typical file and directory structure for a project using Oxc, including source files, configuration files, and ignored directories.

```tree
- fixtures/ <CWD>
  - outside/
    - file.js
  - subdir/
    - .oxfmtrc.json
    - ignored/
      - broken.js
```

--------------------------------

### File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/stdin_ignore_patterns/0.snap.md

Example file tree structure relevant to oxfmt processing, including configuration and ignore files.

```bash
- fixtures/ <CWD>
  - .oxfmtrc.json
  - .prettierignore
  - input.ts
```

--------------------------------

### Oxformatter Configuration File

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config/0.snap.md

Example of an oxfmt configuration file in JSON format.

```json
{
  ".oxfmtrc.json": "configuration file"
}
```

--------------------------------

### Workspace DidChangeConfiguration Settings

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/README.md

Example of client-provided settings for workspace configuration, detailing Oxc options.

```json
{
  "settings": [
    {
      "workspaceUri": "file://workspace-directory",
      "options": {
        "run": "onType",
        "configPath": null,
        "tsConfigPath": null,
        "unusedDisableDirectives": "allow",
        "typeAware": false,
        "disableNestedConfig": false,
        "fixKind": "safe_fix",
        "rulesCustomization": {},
        "fmtConfigPath": null
      }
    }
  ]
}
```

--------------------------------

### Rust Optimization Structure Example

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_minifier/docs/CLAUDE.md

Illustrates the typical structure for implementing an optimization in Rust, including checks and transformations.

```rust
pub fn optimize_something(expr: &mut Expression, ctx: &mut Ctx) {
    // Check if optimization applies
    if !can_optimize(expr, ctx) {
        return;
    }

    // Apply transformation
    let new_expr = create_optimized_form(ctx);
    ctx.replace_expression(expr, new_expr);
}
```

--------------------------------

### Oxfmt Configuration File

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/2.snap.md

This is an example of the `.oxfmtrc.json` file generated after migrating from a Prettier configuration. It includes settings like `semi`, `singleQuote`, `tabWidth`, `printWidth`, `sortPackageJson`, and `ignorePatterns`.

```json
{
  "semi": false,
  "singleQuote": true,
  "tabWidth": 4,
  "printWidth": 120,
  "sortPackageJson": false,
  "ignorePatterns": []
}

```

--------------------------------

### Oxfmt Configuration File

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/5.snap.md

This is an example of an Oxfmt configuration file created after migrating from Prettier. It includes settings for Tailwind CSS sorting and print width.

```json
{
  "sortTailwindcss": {
    "config": "./tailwind.config.js",
    "functions": [
      "clsx",
      "cn"
    ],
    "attributes": [
      "myClass"
    ],
    "preserveWhitespace": true
  },
  "printWidth": 80,
  "sortPackageJson": false,
  "ignorePatterns": []
}
```

--------------------------------

### Test Suite Setup

Source: https://github.com/oxc-project/oxc/blob/main/tasks/rulegen/template.txt

Sets up a test suite for a lint rule using the `Tester` utility. Defines passing and failing test cases.

```rust
@test
fn test() {
    {{#if has_filename}}
    use std::path::PathBuf;

    {{/if}}
    use crate::tester::Tester;

    let pass = vec![
        {{pass_cases}}
    ];

    let fail = vec![
        {{fail_cases}}
    ];

    {{#if fix_cases}}
    let fix = vec![
        {{fix_cases}}
    ];

    Tester::new({{pascal_rule_name}}::NAME, {{pascal_rule_name}}::PLUGIN, pass, fail).expect_fix(fix).test_and_snapshot();
    {{else}}
    Tester::new({{pascal_rule_name}}::NAME, {{pascal_rule_name}}::PLUGIN, pass, fail).test_and_snapshot();
    {{/if}}
}
```

--------------------------------

### Install @oxlint/plugins

Source: https://github.com/oxc-project/oxc/blob/main/npm/oxlint-plugins/README.md

Install the package via npm.

```bash
npm install @oxlint/plugins
```

--------------------------------

### Install oxlint-plugin-eslint

Source: https://github.com/oxc-project/oxc/blob/main/npm/oxlint-plugin-eslint/README.md

Install the package as a development dependency using npm.

```sh
npm install --save-dev oxlint-plugin-eslint
```

--------------------------------

### Example Svelte component

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/stdin_svelte/0.snap.md

This is an example of a Svelte component that would be formatted by oxfmt.

```svelte
<script>
  let count = $state(0);
</script>

<button onclick={() => count++}>{count}</button>
```

--------------------------------

### Suggestion for 'start too large' error

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix-suggestions.snap.md

This indicates a suggestion for an 'start too large' error, referencing `range_start_too_large.js`.

```text
  x suggestions-plugin(suggestions): start too large
   ,-[files/range_start_too_large.js:1:5]
 1 | let x;
   :     ^
   `----
```

```text
  x suggestions-plugin(suggestions): start too large multiple
   ,-[files/range_start_too_large.js:1:5]
 1 | let x;
   :     ^
   `----
```

--------------------------------

### Suggestion for 'start after end' error

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix-suggestions.snap.md

This indicates a suggestion for an 'start after end' error, referencing `range_start_after_end.js`.

```text
  x suggestions-plugin(suggestions): start after end
   ,-[files/range_start_after_end.js:1:5]
 1 | let x;
   :     ^
   `----
```

```text
  x suggestions-plugin(suggestions): start after end multiple
   ,-[files/range_start_after_end.js:1:5]
 1 | let x;
   :     ^
   `----
```

--------------------------------

### Rust Traversal Hook Example

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_minifier/docs/CLAUDE.md

Example of a traversal hook in Rust for handling expression nodes during optimization.

```rust
// In peephole/mod.rs
fn exit_expression(&mut self, expr: &mut Expression<'a>, ctx: &mut TraverseCtx<'a>) {
    let ctx = &mut Ctx::new(ctx);
    match expr {
        Expression::BinaryExpression(_) => {
            Self::optimize_binary(expr, ctx);
        }
        // ... other cases
    }
}
```

--------------------------------

### Suggestion for 'start negative' error

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix-suggestions.snap.md

This snippet shows a suggestion for a 'start negative' error, pointing to `range_start_negative.js`.

```text
  x suggestions-plugin(suggestions): start negative
   ,-[files/range_start_negative.js:1:5]
 1 | let x;
   :     ^
   `----
```

```text
  x suggestions-plugin(suggestions): start negative multiple
   ,-[files/range_start_negative.js:1:5]
 1 | let x;
   :     ^
   `----
```

--------------------------------

### Oxc Standard Output Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/eslintCompat_error_in_before/output.snap.md

Example of standard output from Oxc, showing errors during JS plugin execution. Useful for understanding runtime errors and file-specific issues.

```text
  x Error running JS plugin.
  | File path: <fixture>/files/1.js
  | Error: `before` hook threw
  |     at before (<fixture>/plugin.ts:44:15)

Found 0 warnings and 1 error.
Finished in Xms on 1 file with 3 rules using X threads.
```

--------------------------------

### Project File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/stdin_nested_config/0.snap.md

Illustrates the directory and file structure for the test case, including configuration files at different levels.

```text
- fixtures/ <CWD>
  - .oxfmtrc.json
  - input.js
  - sub/
    - .oxfmtrc.json
```

--------------------------------

### Oxc Linting Output Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/fixable_boolean/fix.snap.md

Example of Oxc linting output showing a fixable boolean plugin error with console.log. This output is typically seen in the standard output stream.

```text
  x fixable-boolean-plugin(no-console-false): Console with fixable: false
   ,-[files/index.js:2:1]
 1 | debugger;
 2 | console.log("test");
   : ^^^^^^^^^^^^^^^^^^^^
   `----

Found 0 warnings and 1 error.
Finished in Xms on 1 file with 2 rules using X threads.
```

--------------------------------

### Oxc Standard Error Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/eslintCompat_error_in_before/output.snap.md

Example of standard error output from Oxc, detailing the filename and a sequence of events. Helpful for tracing execution flow and identifying event-related problems.

```text
filename: <fixture>/files/1.js
events:
[
  "before: tracking",
  "before: throw-in-before",
  "after: tracking"
]
```

--------------------------------

### Oxc Linter Inline Test Example

Source: https://github.com/oxc-project/oxc/blob/main/AGENTS.md

Example of an inline test for an Oxc linter rule using the Tester helper. It demonstrates how to define pass and fail cases for testing and snapshotting.

```rust
#[test]
fn test() {
    Tester::new(RuleName::NAME, RuleName::PLUGIN, pass, fail)
        .test_and_snapshot();
}
```

--------------------------------

### Initialize Submodules

Source: https://github.com/oxc-project/oxc/blob/main/tasks/coverage/README.md

Run this command to clone the necessary test repositories before running coverage tests.

```bash
just submodules
```

--------------------------------

### create-once-plugin(always-run): createOnce: options

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/createOnce/output.snap.md

Logs the options as null for the 'createOnce' function in the 'always-run' plugin.

```text
x create-once-plugin(always-run): createOnce: options: null
   ,-[files/1.js:1:1]
 1 | let x;
   : ^
   `----
```

--------------------------------

### JSDoc @example JSON Key Quoting

Source: https://github.com/oxc-project/oxc/blob/main/tasks/prettier_conformance/jsdoc/upstream-jsdoc-bugs.md

Illustrates how prettier-plugin-jsdoc adds quotes to unquoted JSON keys within @example tags, altering semantics. Use oxfmt to maintain original formatting.

```javascript
// Input:
/**
 * @example { testArr: [1, 2] }
 */
```

```javascript
// prettier-plugin-jsdoc output (adds quotes):
/**
 * @example { "testArr": [1, 2] }
 */
```

```javascript
// oxfmt output (preserves original):
/**
 * @example { testArr: [1, 2] }
 */
```

--------------------------------

### Oxc Stdout Example: Configuration Error

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/import_error/output.snap.md

This stdout example shows a common error message when Oxc fails to parse its configuration file, including details about a failed plugin load and the specific error encountered.

```text
Failed to parse oxlint configuration file.

  x Failed to load JS plugin: ./plugin.ts
  |   Error: whoops!
  |     at <fixture>/plugin.ts:1:7
```

--------------------------------

### Build and Run E2E Tests

Source: https://github.com/oxc-project/oxc/blob/main/tasks/e2e/README.md

Execute the build process for the transformer and minifier packages, then navigate to the e2e directory and run the tests.

```bash
# From repo root
pnpm --filter "./napi/minify" --filter "./napi/transform" run build-test
cd tasks/e2e
pnpm test
```

--------------------------------

### Initialize Plugin Submodules

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/README.md

Initialize the necessary submodules for conformance testing. This command ensures all required plugin repositories are set up.

```sh
pnpm run init-conformance
```

--------------------------------

### Organize tests with subdirectories

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_formatter/tests/README.md

Illustrates how to create subdirectories for organizing related tests and how to create a test file within a subdirectory.

```bash
mkdir -p tests/fixtures/js/classes
 echo "class Foo {}" > tests/fixtures/js/classes/simple.js
```

--------------------------------

### Create a new test file

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_formatter/tests/README.md

Demonstrates how to create a new JavaScript test file and run it. The test is automatically discovered by the build script.

```bash
# Create a new test file
 echo "const foo = bar;" > tests/fixtures/js/my-test.js

 # The test is automatically discovered - just run tests
 cargo test -p oxc_formatter --test mod
```

--------------------------------

### initialize

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_language_server/README.md

Initializes the language server and returns its capabilities. The client can provide workspace options during initialization.

```APIDOC
## initialize

### Description
Initializes the language server and returns the server capabilities. The client can pass workspace options.

### Method
POST

### Endpoint
/initialize

### Parameters
#### Request Body
- **initializationOptions** (array) - Optional - Workspace options for the server.
  - **workspaceUri** (string) - The URI of the workspace directory.
  - **options** (object) - Configuration options for Oxc.
    - **run** (string) - When to run diagnostics (e.g., "onType").
    - **configPath** (string | null) - Path to the configuration file.
    - **tsConfigPath** (string | null) - Path to the TypeScript configuration file.
    - **unusedDisableDirectives** (string) - How to handle unused disable directives (e.g., "allow").
    - **typeAware** (boolean) - Whether to enable type-aware linting.
    - **disableNestedConfig** (boolean) - Whether to disable nested configuration searches.
    - **fixKind** (string) - The type of fix to apply (e.g., "safe_fix").
    - **rulesCustomization** (object) - Customization for rules.
    - **fmt.configPath** (string | null) - Path to the formatter configuration file.

#### Flags (deprecated)
- **key: disable_nested_config** (string) - Disabled nested configuration and searches only for `configPath`.
- **key: fix_kind** (string) - See [FixKind values](#fixkind-values) for possible values.

### Response
#### Success Response (200)
- **serverCapabilities** (object) - The capabilities of the language server.
```

--------------------------------

### Parser Services Plugin Output

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/parser_services/output.snap.md

Example output showing the diagnostic report from the parser-services-plugin.

```text
  x parser-services-plugin(check-parser-services): typeof context.sourceCode.parserServices: object
   ,-[files/index.js:1:1]
 1 | // Simple file to test parserServices access
   : ^
 2 | console.log("testing parserServices");
   `----

Found 0 warnings and 1 error.
Finished in Xms on 1 file with 1 rules using X threads.
```

--------------------------------

### Project file structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/insert_final_newline/0.snap.md

Displays the directory layout for testing formatting configurations.

```text
- fixtures/
  - editorconfig_only/
    - .editorconfig
    - test.css
    - test.toml
    - test.ts
  - oxfmtrc_only/ <CWD>
    - .oxfmtrc.json
    - test.css
    - test.toml
    - test.ts
```

--------------------------------

### Example Svelte component content

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/stdin_svelte/1.snap.md

This is the formatted output of a Svelte component after being processed by oxfmt.

```svelte
<script>let   count=$state(0);</script>
<button onclick={()=>count++}>{count}</button>
```

--------------------------------

### Oxformatter Configuration File (TypeScript)

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config/0.snap.md

Example of an oxfmt configuration file in TypeScript format.

```typescript
{
  "oxfmt.config.ts": "configuration file"
}
```

--------------------------------

### Generated .oxfmtrc.json configuration

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/4.snap.md

Example of the resulting configuration file created by the migration tool.

```json
{
  "semi": true,
  "printWidth": 80,
  "sortPackageJson": false,
  "ignorePatterns": [
    "dist",
    "node_modules",
    "*.min.js"
  ]
}
```

--------------------------------

### Generated .oxfmtrc.json Configuration

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_biome/6.snap.md

Example of the JSON configuration file created by the migration process.

```json
{
  "useTabs": true,
  "tabWidth": 4,
  "printWidth": 120,
  "singleQuote": false,
  "jsxSingleQuote": false,
  "quoteProps": "as-needed",
  "trailingComma": "all",
  "semi": true,
  "arrowParens": "always",
  "bracketSameLine": false,
  "bracketSpacing": true,
  "ignorePatterns": []
}
```

--------------------------------

### File tree structure for oxfmt

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config_no_root/0.snap.md

Illustrates a typical file tree structure for testing oxfmt, including configuration files.

```text
- fixtures/ <CWD>
  - root.js
  - sub/
    - .oxfmtrc.json
    - test.js
```

--------------------------------

### Commented Out Code Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/snapshots/sonarjs.md

This snippet demonstrates a commented-out line of JavaScript code that should be flagged by the linter.

```javascript
// return foo().bar();
```

--------------------------------

### Test File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/vite_plus/1.snap.md

Illustrates the directory and file structure for a test case involving Vite+ configurations and oxfmt.

```text
- fixtures/
  - basic/
    - test.ts
    - vite.config.ts
  - error_load_failure/
    - .oxfmtrc.json
    - child/
      - test.ts
      - vite.config.ts
  - fn_export/
    - test.ts
    - vite.config.ts
  - no_fmt_field/ <CWD>
    - test.ts
    - vite.config.ts
  - priority/
    - oxfmt.config.ts
    - test.ts
    - vite.config.ts
  - skip_finds_parent/
    - .oxfmtrc.json
    - child/
      - test.ts
      - vite.config.ts
```

--------------------------------

### Replace 'i' with 'granular'

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix.snap.md

This snippet demonstrates replacing the character 'i' with 'granular'. It's an example of a string replacement suggestion.

```text
  x suggestions-plugin(suggestions): Replace "i" with "granular"
    ,-[files/index.js:11:5]
 10 | let h = 8;
 11 | let i = 9;
    :     ^
 12 | let j = 10;
    `----
```

--------------------------------

### Initialize oxfmt configuration

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/init_already_exists/0.snap.md

Run this command to generate the initial .oxfmtrc.json configuration file in the current working directory.

```bash
oxfmt --init
```

--------------------------------

### Commented Out Code Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/snapshots/sonarjs.md

This snippet demonstrates a commented-out block of JavaScript code. SonarJS should flag this as an issue.

```javascript
// if (condition) {
//   while (condition) {
//     doSomething();
//   }
// }
```

--------------------------------

### Example File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/node_modules_dirs/2.snap.md

Illustrates a typical file tree structure for a project that might be processed by Oxc tools. It includes nested `node_modules` directories and JavaScript files at different levels.

```text
- fixtures/ <CWD>
  - node_modules/
    - test.js
  - regular_dir/
    - node_modules/
      - test.js
    - test.js
  - root.js
```

--------------------------------

### Initialize and Use Oxc Minifier

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_minifier/README.md

Demonstrates how to initialize the Oxc minifier with default options and use it to minify a program. Ensure you have the necessary imports.

```rust
use oxc_minifier::{Minifier, MinifierOptions};

let options = MinifierOptions::default();
let minifier = Minifier::new(options);
let result = minifier.minify(&mut program);
```

--------------------------------

### Oxc Summary Output

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/js_config_js_plugins/output.snap.md

Example of Oxc summary output indicating the number of warnings, errors, and processing time.

```text
Found 0 warnings and 1 error.
Finished in Xms on 1 file with 1 rules using X threads.
```

--------------------------------

### File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_biome/5.snap.md

Illustrates the directory structure for testing various configuration scenarios with oxfmt.

```plaintext
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - arrow_parens/
    - biome.json
  - attribute_position/
    - biome.json
  - basic_config/
    - biome.json
  - both_json_jsonc/
    - biome.json
    - biome.jsonc
  - defaults/ <CWD>
    - biome.json
  - force_ignore/
    - biome.json
  - ignore_patterns/
    - biome.json
  - js_overrides/
    - biome.json
  - jsonc_config/
    - biome.jsonc
  - no_config/
    - .gitkeep
  - warn_overrides/
    - biome.json
```

--------------------------------

### File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/js_config/3.snap.md

Illustrates a typical file tree structure for testing oxfmt, including configuration files and source files within different fixture directories.

```text
- fixtures/
  - basic/
    - oxfmt.config.ts
    - test.ts
  - error_no_default/
    - oxfmt.config.ts
    - test.ts
  - error_not_object/
    - oxfmt.config.ts
    - test.ts
  - priority/ <CWD>
    - .oxfmtrc.json
    - oxfmt.config.ts
    - test.ts
```

--------------------------------

### File Tree Structure for Test

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/oxfmtrc_overrides_invalid/1.snap.md

Illustrates the directory and file structure relevant to the test case, including the configuration file and the JavaScript file to be checked.

```bash
- fixtures/ <CWD>
  - cross_field_conflict.json
  - invalid_value.json
  - root_invalid.json
  - test.js
```

--------------------------------

### Replace 'k' with 'kaboom'

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix.snap.md

This snippet demonstrates replacing the character 'k' with 'kaboom'. It's an example of a string replacement suggestion.

```text
  x suggestions-plugin(suggestions): Replace "k" with "kaboom"
    ,-[files/index.js:13:5]
 12 | let j = 10;
 13 | let k = 11;
    :     ^
 14 | 
    `----
```

--------------------------------

### Run Conformance Tests

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/AGENTS.md

Execute conformance tests for xxx-in-js and js-in-xxx by running `pnpm conformance`.

```sh
# Run conformance test for xxx-in-js and js-in-xxx
pnpm conformance
```

--------------------------------

### Replace 'j' with 'cowabunga'

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix.snap.md

This snippet shows replacing the character 'j' with 'cowabunga'. It's an example of a string replacement suggestion.

```text
  x suggestions-plugin(suggestions): Replace "j" with "cowabunga"
    ,-[files/index.js:12:5]
 11 | let i = 9;
 12 | let j = 10;
    :     ^
 13 | let k = 11;
    `----
```

--------------------------------

### Replace 'h' with 'dangermouse'

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix.snap.md

This snippet shows replacing the character 'h' with 'dangermouse'. It's an example of a more extensive string replacement.

```text
  x suggestions-plugin(suggestions): Replace "h" with "dangermouse"
    ,-[files/index.js:10:5]
  9 | let g = 7;
 10 | let h = 8;
    :     ^
 11 | let i = 9;
    `----
```

--------------------------------

### Format root.js with oxfmt

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/nested_config_no_root/0.snap.md

Shows the diff for formatting the `root.js` file, demonstrating code style changes.

```diff
````diff
@@ -1,1 +1,5 @@
-function foo() { if (true) { console.log("hello"); } }
+function foo() {
+  if (true) {
+    console.log("hello");
+  }
+}
````
```

--------------------------------

### Oxc CLI Diagnostic Output

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/fixable_boolean/output.snap.md

Example of the standard output generated by the Oxc CLI when linting files with rule violations.

```text
  x fixable-boolean-plugin(no-debugger-true): Debugger with fixable: true
   ,-[files/index.js:1:1]
 1 | debugger;
   : ^^^^^^^^^
 2 | console.log("test");
   `----

  x fixable-boolean-plugin(no-console-false): Console with fixable: false
   ,-[files/index.js:2:1]
 1 | debugger;
 2 | console.log("test");
   : ^^^^^^^^^^^^^^^^^^^
   `----

Found 0 warnings and 2 errors.
Finished in Xms on 1 file with 2 rules using X threads.
```

--------------------------------

### Manually Verify CLI Behavior

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/AGENTS.md

After building with `pnpm build-test`, you can verify CLI behavior. Use `--help` to see available commands. Pipe input via stdin for equivalent functionality to `prettier --config=<cfg> <file>`. Use `OXC_LOG=debug` for detailed logging.

```sh
pnpm build-test

# Show help
node ./dist/cli.js --help
# Stdin (`npx prettier --config=<cfg> <file>` equivalent)
cat <file> | node ./dist/cli.js --config=<cfg> --stdin-filepath=<file>
# With log
OXC_LOG=debug node ./dist/cli.js --threads=1 <file>
```

--------------------------------

### Replace 'g' with 'rage'

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/suggestions/fix.snap.md

This snippet demonstrates replacing the character 'g' with 'rage'. It's a straightforward example of a string replacement suggestion.

```text
  x suggestions-plugin(suggestions): Replace "g" with "rage"
   ,-[files/bom.js:2:1]
 1 | a = c;
 2 | g = b
   : ^
   `----
```

```text
  x suggestions-plugin(suggestions): Replace "g" with "rage"
   ,-[files/bom_and_unicode.js:3:1]
 2 | // 😀🤪😆😎🤮
 3 | g = b
   : ^
   `----
```

```text
  x suggestions-plugin(suggestions): Replace "g" with "rage"
    ,-[files/index.js:9:5]
  8 | let f = 6;
  9 | let g = 7;
    :     ^
 10 | let h = 8;
    `----
```

--------------------------------

### Project file tree structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/migrate_prettier/4.snap.md

Displays the directory layout containing various Prettier configuration fixtures.

```text
- fixtures/
  - already_exists/
    - .oxfmtrc.json
  - basic_config/
    - .prettierrc
  - default_printwidth/
    - .prettierrc
  - no_config/
    - .gitkeep
  - sort_pkg_disabled/
    - .prettierrc
  - sort_pkg_enabled/
    - .prettierrc
  - tailwind_empty/
    - .prettierrc
  - tailwind_options/
    - .prettierrc
  - tailwind_regex/
    - .prettierrc
  - with_ignore/ <CWD>
    - .prettierignore
    - .prettierrc
```

--------------------------------

### Oxc Basic Custom Plugin Output

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/test/fixtures/js_config_js_plugins/output.snap.md

Example of Oxc output for a basic custom plugin detecting an unexpected debugger statement.

```text
  x basic-custom-plugin(no-debugger): Unexpected Debugger Statement
   ,-[files/test.js:1:1]
 1 | debugger;
   : ^^^^^^^^
   `----
```

--------------------------------

### Configure formatting options with options.json

Source: https://github.com/oxc-project/oxc/blob/main/crates/oxc_formatter/tests/README.md

Shows how to define custom formatting options using a JSON file. Each object in the array represents a distinct set of options.

```json
[
  {
    "semi": true,
    "singleQuote": false,
    "arrowParens": "always"
  },
  {
    "semi": false,
    "singleQuote": true,
    "arrowParens": "avoid",
    "printWidth": 120
  }
]
```

--------------------------------

### JavaScript Code with Commented-Out Code

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/snapshots/sonarjs.md

This snippet demonstrates a JavaScript code example where a line of code is commented out. This is flagged by the 'commentedCode' rule.

```js
let x = /* let x = 42; */ 0;
```

--------------------------------

### Project File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/gitignore_parent/0.snap.md

Illustrates the directory structure relevant to the oxfmt check, including a .gitignore file and an apps directory with source and distribution files.

```text
- fixtures/
  - .gitignore
  - apps/ <CWD>
    - dist/
      - unformatted.js
    - keep.js
```

--------------------------------

### Invalid Commented Code Example

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/snapshots/sonarjs.md

This snippet demonstrates a JavaScript code block with commented-out code, which is flagged as invalid by the 'commentedCode' rule.

```javascript
/* foo();
bar(); */
const a = 1;
```

--------------------------------

### Project File Tree Structure

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxfmt/test/cli/glob_patterns/7.snap.md

Illustrates the directory and file structure relevant to the oxfmt test, including source files and configuration.

```text
- fixtures/ <CWD>
  - .gitignore
  - lib/
    - util.js
  - src/
    - {d}.js
    - a.js
    - b.js
    - c.ts
```

--------------------------------

### Build Oxlint in Conformance Mode

Source: https://github.com/oxc-project/oxc/blob/main/apps/oxlint/conformance/README.md

Build Oxlint with conformance testing enabled. This involves installing dependencies and running a build script.

```sh
cd apps/oxlint
pnpm install
pnpm run build-conformance
```