Release 1.33.0 (#704)

Author: Boshen

src/docs/guide/usage/formatter/generated-cli.md

@@ -6,32 +6,43 @@ search: false
 
 **`oxfmt`** \[**`-c`**=_`PATH`_\] \[_`PATH`_\]...
 
-## Output Options
+## Mode Options:
 
-- **`--check`** —
-  Check mode - check if files are formatted, also show statistics
-- **`--list-different`** —
-  List mode - list files that would be changed
+- **`    --init`** —
+  Initialize `.oxfmtrc.json` with default values
+- **`    --migrate`**=_`SOURCE`_ —
+  Migrate configuration to `.oxfmtrc.json` from specified source Available sources: prettier
+- **`    --lsp`** —
+  Start language server protocol (LSP) server
+- **`    --stdin-filepath`**=_`PATH`_ —
+  Specify the file name to use to infer which parser to use
+
+## Output Options:
 
-## Basic Options
+- **`    --write`** —
+  Format and write files in place (default)
+- **`    --check`** —
+  Check if files are formatted, also show statistics
+- **`    --list-different`** —
+  List files that would be changed
+
+## Config Options
 
 - **`-c`**, **`--config`**=_`PATH`_ —
   Path to the configuration file
 
 ## Ignore Options
 
-- **`--ignore-path`**=_`PATH`_ —
+- **`    --ignore-path`**=_`PATH`_ —
   Path to ignore file(s). Can be specified multiple times. If not specified, .gitignore and .prettierignore in the current directory are used.
-- **`--with-node-modules`** —
+- **`    --with-node-modules`** —
   Format code in node_modules directory (skipped by default)
 
-## Misc Options
+## Runtime Options
 
-- **`--lsp`** —
-  Start language server protocol (LSP) server
-- **`--no-error-on-unmatched-pattern`** —
+- **`    --no-error-on-unmatched-pattern`** —
   Do not exit with error when pattern is unmatched
-- **`--threads`**=_`INT`_ —
+- **`    --threads`**=_`INT`_ —
   Number of threads to use. Set to 1 for using only 1 CPU core.
 
 ## Available positional items:

src/docs/guide/usage/formatter/generated-config.md

@@ -2,40 +2,42 @@
 search: false
 ---
 
-# Configuration options for the formatter.
+# Configuration options for the Oxfmt.
 
 Most options are the same as Prettier's options.
 See also <https://prettier.io/docs/options>
+But some options are our own extensions.
 
 ## arrowParens
 
 type: `string | null`
 
-Include parentheses around a sole arrow function parameter. (Default: "always")
+Include parentheses around a sole arrow function parameter. (Default: `"always"`)
 
 ## bracketSameLine
 
 type: `boolean | null`
 
-Put the > of a multi-line JSX element at the end of the last line instead of being alone on the next line. (Default: false)
+Put the `>` of a multi-line JSX element at the end of the last line
+instead of being alone on the next line. (Default: `false`)
 
 ## bracketSpacing
 
 type: `boolean | null`
 
-Print spaces between brackets in object literals. (Default: true)
+Print spaces between brackets in object literals. (Default: `true`)
 
 ## embeddedLanguageFormatting
 
 type: `string | null`
 
-Control whether formats quoted code embedded in the file. (Default: "auto")
+Control whether formats quoted code embedded in the file. (Default: `"auto"`)
 
 ## endOfLine
 
 type: `string | null`
 
-Which end of line characters to apply. (Default: "lf")
+Which end of line characters to apply. (Default: `"lf"`)
 
 ## experimentalSortImports
 
@@ -93,6 +95,12 @@ type: `boolean`
 
 default: `false`
 
+## experimentalSortPackageJson
+
+type: `boolean | null`
+
+Experimental: Sort `package.json` keys. (Default: `true`)
+
 ## ignorePatterns
 
 type: `string[]`
@@ -103,59 +111,59 @@ Ignore files matching these glob patterns. Current working directory is used as
 
 type: `boolean | null`
 
-Use single quotes instead of double quotes in JSX. (Default: false)
+Use single quotes instead of double quotes in JSX. (Default: `false`)
 
 ## objectWrap
 
 type: `string | null`
 
-How to wrap object literals when they could fit on one line or span multiple lines. (Default: "preserve")
-NOTE: In addition to Prettier's "preserve" and "collapse", we also support "always".
+How to wrap object literals when they could fit on one line or span multiple lines. (Default: `"preserve"`)
+NOTE: In addition to Prettier's `"preserve"` and `"collapse"`, we also support `"always"`.
 
 ## printWidth
 
 type: `integer | null`
 
-The line length that the printer will wrap on. (Default: 100)
+The line length that the printer will wrap on. (Default: `100`)
 
 ## quoteProps
 
 type: `string | null`
 
-Change when properties in objects are quoted. (Default: "as-needed")
+Change when properties in objects are quoted. (Default: `"as-needed"`)
 
 ## semi
 
 type: `boolean | null`
 
-Print semicolons at the ends of statements. (Default: true)
+Print semicolons at the ends of statements. (Default: `true`)
 
 ## singleAttributePerLine
 
 type: `boolean | null`
 
-Put each attribute on a new line in JSX. (Default: false)
+Put each attribute on a new line in JSX. (Default: `false`)
 
 ## singleQuote
 
 type: `boolean | null`
 
-Use single quotes instead of double quotes. (Default: false)
+Use single quotes instead of double quotes. (Default: `false`)
 
 ## tabWidth
 
 type: `integer | null`
 
-Number of spaces per indentation level. (Default: 2)
+Number of spaces per indentation level. (Default: `2`)
 
 ## trailingComma
 
 type: `string | null`
 
-Print trailing commas wherever possible. (Default: "all")
+Print trailing commas wherever possible. (Default: `"all"`)
 
 ## useTabs
 
 type: `boolean | null`
 
-Use tabs for indentation or spaces. (Default: false)
+Use tabs for indentation or spaces. (Default: `false`)

src/docs/guide/usage/linter/generated-cli.md

@@ -17,9 +17,9 @@ search: false
 
   If not provided, Oxlint will look for `.oxlintrc.json` in the current working directory.
 
-- **`--tsconfig`**=_`<./tsconfig.json>`_ &mdash;
+- **`    --tsconfig`**=_`<./tsconfig.json>`_ &mdash;
   TypeScript `tsconfig.json` path for reading path alias and project references for import plugin. If not provided, will look for `tsconfig.json` in the current working directory.
-- **`--init`** &mdash;
+- **`    --init`** &mdash;
   Initialize oxlint configuration with default values
 
 ## Allowing / Denying Multiple Lints
@@ -49,66 +49,66 @@ Arguments:
 
 ## Enable/Disable Plugins
 
-- **`--disable-unicorn-plugin`** &mdash;
+- **`    --disable-unicorn-plugin`** &mdash;
   Disable unicorn plugin, which is turned on by default
-- **`--disable-oxc-plugin`** &mdash;
+- **`    --disable-oxc-plugin`** &mdash;
   Disable oxc unique rules, which is turned on by default
-- **`--disable-typescript-plugin`** &mdash;
+- **`    --disable-typescript-plugin`** &mdash;
   Disable TypeScript plugin, which is turned on by default
-- **`--import-plugin`** &mdash;
+- **`    --import-plugin`** &mdash;
   Enable import plugin and detect ESM problems. It is recommended to use alongside the `--tsconfig` option.
-- **`--react-plugin`** &mdash;
+- **`    --react-plugin`** &mdash;
   Enable react plugin, which is turned off by default
-- **`--jsdoc-plugin`** &mdash;
+- **`    --jsdoc-plugin`** &mdash;
   Enable jsdoc plugin and detect JSDoc problems
-- **`--jest-plugin`** &mdash;
+- **`    --jest-plugin`** &mdash;
   Enable the Jest plugin and detect test problems
-- **`--vitest-plugin`** &mdash;
+- **`    --vitest-plugin`** &mdash;
   Enable the Vitest plugin and detect test problems
-- **`--jsx-a11y-plugin`** &mdash;
+- **`    --jsx-a11y-plugin`** &mdash;
   Enable the JSX-a11y plugin and detect accessibility problems
-- **`--nextjs-plugin`** &mdash;
+- **`    --nextjs-plugin`** &mdash;
   Enable the Next.js plugin and detect Next.js problems
-- **`--react-perf-plugin`** &mdash;
+- **`    --react-perf-plugin`** &mdash;
   Enable the React performance plugin and detect rendering performance problems
-- **`--promise-plugin`** &mdash;
+- **`    --promise-plugin`** &mdash;
   Enable the promise plugin and detect promise usage problems
-- **`--node-plugin`** &mdash;
+- **`    --node-plugin`** &mdash;
   Enable the node plugin and detect node usage problems
-- **`--vue-plugin`** &mdash;
+- **`    --vue-plugin`** &mdash;
   Enable the vue plugin and detect vue usage problems
 
 ## Fix Problems
 
-- **`--fix`** &mdash;
+- **`    --fix`** &mdash;
   Fix as many issues as possible. Only unfixed issues are reported in the output.
-- **`--fix-suggestions`** &mdash;
+- **`    --fix-suggestions`** &mdash;
   Apply auto-fixable suggestions. May change program behavior.
-- **`--fix-dangerously`** &mdash;
+- **`    --fix-dangerously`** &mdash;
   Apply dangerous fixes and suggestions
 
 ## Ignore Files
 
-- **`--ignore-path`**=_`PATH`_ &mdash;
+- **`    --ignore-path`**=_`PATH`_ &mdash;
   Specify the file to use as your `.eslintignore`
-- **`--ignore-pattern`**=_`PAT`_ &mdash;
+- **`    --ignore-pattern`**=_`PAT`_ &mdash;
   Specify patterns of files to ignore (in addition to those in `.eslintignore`)
 
   The supported syntax is the same as for `.eslintignore` and `.gitignore` files. You should quote your patterns in order to avoid shell interpretation of glob patterns.
 
-- **`--no-ignore`** &mdash;
+- **`    --no-ignore`** &mdash;
   Disable excluding files from `.eslintignore` files, **`--ignore-path`** flags and **`--ignore-pattern`** flags
 
 > [!NOTE]
 > `.gitignore` is only respected inside a Git repository.
 
 ## Handle Warnings
 
-- **`--quiet`** &mdash;
+- **`    --quiet`** &mdash;
   Disable reporting on warnings, only errors are reported
-- **`--deny-warnings`** &mdash;
+- **`    --deny-warnings`** &mdash;
   Ensure warnings produce a non-zero exit code
-- **`--max-warnings`**=_`INT`_ &mdash;
+- **`    --max-warnings`**=_`INT`_ &mdash;
   Specify a warning threshold, which can be used to force exit with an error status if there are too many warning-level rule violations in your project
 
 ## Output
@@ -118,18 +118,18 @@ Arguments:
 
 ## Miscellaneous
 
-- **`--silent`** &mdash;
+- **`    --silent`** &mdash;
   Do not display any diagnostics
-- **`--threads`**=_`INT`_ &mdash;
+- **`    --threads`**=_`INT`_ &mdash;
   Number of threads to use. Set to 1 for using only 1 CPU core.
-- **`--print-config`** &mdash;
+- **`    --print-config`** &mdash;
   This option outputs the configuration to be used. When present, no linting is performed and only config-related options are valid.
 
 ## Inline Configuration Comments
 
-- **`--report-unused-disable-directives`** &mdash;
+- **`    --report-unused-disable-directives`** &mdash;
   Report directive comments like `// oxlint-disable-line`, when no errors would have been reported on that line anyway
-- **`--report-unused-disable-directives-severity`**=_`SEVERITY`_ &mdash;
+- **`    --report-unused-disable-directives-severity`**=_`SEVERITY`_ &mdash;
   Same as `--report-unused-disable-directives`, but allows you to specify the severity level of the reported errors. Only one of these two options can be used at a time.
 
 ## Available positional items:
@@ -139,15 +139,15 @@ Arguments:
 
 ## Available options:
 
-- **`--rules`** &mdash;
+- **`    --rules`** &mdash;
   List all the rules that are currently registered
-- **`--lsp`** &mdash;
+- **`    --lsp`** &mdash;
   Start the language server
-- **`--disable-nested-config`** &mdash;
+- **`    --disable-nested-config`** &mdash;
   Disable the automatic loading of nested configuration files
-- **`--type-aware`** &mdash;
+- **`    --type-aware`** &mdash;
   Enable rules that require type information
-- **`--type-check`** &mdash;
+- **`    --type-check`** &mdash;
   Enable experimental type checking (includes TypeScript compiler diagnostics)
 - **`-h`**, **`--help`** &mdash;
   Prints help information