Skip to content

docs: oxc.fmt.configPath default #295

Description

@thernstig

I am unsure if oxc.fmt.configPath and its default is true or not. The docs say:

| Key                           | Default Value | Possible Values                                                                                               | Description                                                                                                                                                                                                                            |
| ----------------------------- | ------------- | ------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `oxc.fmt.configPath`          | `null`        | `<string>` \| `<null>`                                                                                        | Path to an oxfmt configuration file                                                                                                                                                                                                    |

But what does this mean if I do not set it? Does it not default to finding my config files automatically? I think description should mention if this needs to be set or not.

The confusing part is also that https://oxc.rs/docs/guide/usage/formatter/editors.html has it set:

{
  "oxc.fmt.configPath": ".oxfmtrc.json",
  "editor.defaultFormatter": "oxc.oxc-vscode",
  "editor.formatOnSave": true
}

Is it thus required to be set?

This could use a documentation update.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Priority

    None yet

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions