Skip to content

Comments

feat(linter): add auto-fix for vue/no-required-prop-with-default#17747

Merged
camc314 merged 6 commits intooxc-project:mainfrom
amondnet:feat/vue-no-required-prop-with-default-fix
Jan 7, 2026
Merged

feat(linter): add auto-fix for vue/no-required-prop-with-default#17747
camc314 merged 6 commits intooxc-project:mainfrom
amondnet:feat/vue-no-required-prop-with-default-fix

Conversation

@amondnet
Copy link
Contributor

@amondnet amondnet commented Jan 7, 2026

Summary

Add auto-fix capability to the vue/no-required-prop-with-default rule which detects props that have both required: true and a default value.

Fix Strategies

TypeScript props (withDefaults, defineProps):

  • Insert ? after the property key to make it optional
  • Example: name: stringname?: string

Options API props (defineComponent, export default):

  • Replace required: true with required: false
  • Example: required: truerequired: false

Example

<!-- Before -->
<script setup lang="ts">
interface Props {
  name: string  // required but has default
}
const props = withDefaults(defineProps<Props>(), {
  name: "World"
});
</script>

<!-- After (with fix applied) -->
<script setup lang="ts">
interface Props {
  name?: string  // now optional
}
const props = withDefaults(defineProps<Props>(), {
  name: "World"
});
</script>

Test Plan

  • All existing no_required_prop_with_default tests pass
  • Added fix test cases for:
    • TypeScript interface props
    • TypeScript type literal props
    • Options API props with required: true
    • defineComponent props
    • Destructured defineProps
  • Clippy passes without warnings (in our code)
  • Code formatted with cargo fmt

Related


This PR was generated with AI assistance. The implementation has been thoroughly reviewed and tested.

Add auto-fix capability to the rule that detects props with both
`required: true` and a default value.

Fix strategies:
- TypeScript props (withDefaults, defineProps<T>): Insert `?` after
  the property key to make it optional
- Options API props: Replace `required: true` with `required: false`
Copilot AI review requested due to automatic review settings January 7, 2026 11:01
@amondnet amondnet requested a review from camc314 as a code owner January 7, 2026 11:01
@github-actions github-actions bot added A-linter Area - Linter C-enhancement Category - New feature or request labels Jan 7, 2026
Copy link
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Pull request overview

This PR adds auto-fix capability to the vue/no-required-prop-with-default linter rule, which detects Vue props that incorrectly specify both required: true and a default value.

Key Changes:

  • Implements two distinct fix strategies: inserting ? for TypeScript interface/type props, and replacing required: true with required: false for Options API props
  • Changes rule status from pending to fix to enable auto-fix functionality
  • Adds comprehensive fix test cases covering TypeScript interfaces, type literals, method signatures, Options API, and destructured props

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@codspeed-hq
Copy link

codspeed-hq bot commented Jan 7, 2026

Merging this PR will not alter performance

Summary

✅ 4 untouched benchmarks
⏩ 41 skipped benchmarks1


Comparing amondnet:feat/vue-no-required-prop-with-default-fix (5232205) with main (6ae21f9)

Open in CodSpeed

Footnotes

  1. 41 benchmarks were skipped, so the baseline results were used instead. If they were deleted from the codebase, click here and archive them to remove them from the performance reports.

amondnet and others added 5 commits January 7, 2026 21:00
…ed-prop-with-default

Port 2 unicode escape test cases from eslint-plugin-vue:
- Property 'a' in interface matched with '\u0061' in defaults
- Property '\u0061' in interface matched with 'a' in defaults

These test cases verify correct unicode escape sequence normalization.
- Add has_comments_between check before applying auto-fix per oxc guidelines
- Port missing fix test cases from eslint-plugin-vue:
  - Imported type reference (name: nameType → name?: nameType)
  - Bare property without type annotation (name → name?)
  - Escaped quotes in property names ('na\"me2')
  - Options API with quoted property key ('name':)
Copy link
Contributor

@camc314 camc314 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you!

@camc314 camc314 merged commit c7f0848 into oxc-project:main Jan 7, 2026
19 checks passed
Dunqing pushed a commit that referenced this pull request Jan 12, 2026
# Oxlint
### 🚀 Features

- 9699a1b linter/prefer-global-this: Add suggestion (#17873) (Mikhail
Baev)
- 51c2815 linter/no-invalid-regexp: Add labels and help text to flag
diagnostics (#17865) (camchenry)
- 344d77d linter/no-ex-assign: Improve diagnostic with more detail
(#17864) (camchenry)
- 7d280e0 linter: Add fixer for
`unicorn/no-useless-error-capture-stack-trace` rule (#17839) (Mikhail
Baev)
- af1d0e3 linter/prefer-optional-chain: Add rule (#17831) (camc314)
- e3c4108 vscode: Add more supported languages to extension (#17812)
(Alexander Lichter)
- 4a46678 vscode: Activate extension on more languages (#17717) (Sysix)
- b1298fc vscode: Sync formatter with supported files (#17615)
(Alexander Lichter)
- c7f0848 linte/rno-required-prop-with-default: Implement suggestion
(#17747) (Minsu Lee)
- 0e8127e linter/vue: Implement no-lifecycle-after-await (#17701)
(yefan)
- 3567304 linter/vitest: Implement `consistent-each-for` (#17601) (Said
Atrahouch)
- 883e156 linter: Add fixer for `unicorn/no-useless-collection-argument`
rule (#17594) (Mikhail Baev)
- 4eb335c linter/vitest: Implemented prefer-called-once (#17674) (Said
Atrahouch)
- 2bd2d5a linter/vitest: Implement hoisted-apis-on-top (#17658) (Said
Atrahouch)
- cfb2bcc linter/vue: Implement no-arrow-functions-in-watch (#17672)
(yefan)
- a68208a linter/eslint-plugin-vitest: Implements
`prefer-describe-function-title` (#17677) (Said Atrahouch)
- efa029f linter/vitest: Implement no-unneeded-async-expect-function
(#17494) (Minsu Lee)

### 🐛 Bug Fixes

- 49cf66e lsp: Fix workspace worker selection for nested and
similar-named workspaces (#17853) (Copilot)
- 84f4f3c linter: Add doc url for tsgolint diagnostics (#17879) (Sysix)
- 76c903f linter/consistent-indexed-object-style: Skip fixing default
exported interface (#17874) (Copilot)
- 7e87d16 linter/tabindex-no-positive: Improve diagnostic phrasing
(#17849) (connorshea)
- 28f9fba vscode: Fix nested search for binaries (#17832) (Sysix)
- 8ca2cd2 linter: Move jsx-a11y/no-static-element-interactions rule to
nursery. (#17818) (connorshea)
- dc9fdd6 linter/consistent-indexed-object-style: Re-port test cases and
fix some bugs (#17802) (camc314)
- 7bbd880 linter: Update prefer-destructuring rule metadata (#17642)
(Hamir Mahal)
- 3c45185 linter/consistent-indexed-object-style: False positive with
circular reference (#17789) (heygsc)
- bd186b4 vscode: Search for `oxlint` and `oxfmt` in every workspace
directory (#17760) (Sysix)
- 3e0dff7 linter/no-hooks: Add punctuation to diagnostic message
(#17751) (camc314)
- 6ae21f9 linter/prefer-called-once: Avoid panic on trailing comma
(#17735) (Said Atrahouch)
- 32c3901 oxlint: Do not panic on invalid `no-unused-vars` configuration
(#17719) (Sysix)
- 59a6228 parser: Detect TS1363 error for type-only imports with mixed
default and named/namespace bindings (#17712) (Copilot)

### ⚡ Performance

- f87a1e2 linter: Check for giving reserved plugin name before calling
`load_plugin` on napi side (#17841) (Sysix)

### 📚 Documentation

- a2b3a24 linter/no-caller: Improve docs and diagnostic for rule.
(#17890) (connorshea)
- aa48247 linter/no-unsafe-finally: Improve rule docs. (#17891)
(connorshea)
- 1b0bdee linter: Tweak docs for no-useless-constructor and
hoisted-apis-on-top (#17888) (connorshea)
- 8f24fa9 vscode: Remove mention of a built-in server (#17836) (Sysix)
- e81a306 linter: Update the tsconfig flag mention for the import
plugin. (#17778) (connorshea)
# Oxfmt
### 🚀 Features

- 539b350 formatter/sort_imports: Update `NODE_BUILTINS` modules
(#17771) (nilptr)
- 2e03ebf oxfmt/lsp: Use `SourceFormatter` to support non-JS files and
napi features (#17655) (leaysgur)
- 623f7eb oxfmt/sort_package_json: Use `options.sort_scripts` (#17740)
(leaysgur)
- 86c0168 oxfmt/sort_package_json: Handle `oxfmtrc.sort_scripts` option
(#17738) (leaysgur)
- 256636a oxfmt/lsp: Add `.editorconfig` to `get_watcher_patterns`
(#17694) (leaysgur)
- 3f3db39 oxfmt/lsp: Use `ConfigResolver` to align with CLI (#17654)
(leaysgur)

### 🐛 Bug Fixes

- fdd1e1e formatter: Don't wrap parenthesis for type assertion when it's
an declaration of export default (#17878) (Dunqing)
- f0813ad formatter: Incorrect type annotation check for short argument
(#17877) (Dunqing)
- 9e89389 formatter/tailwindcss: Nested class string doesn't respect
`singleQuote: true` (#17838) (Dunqing)
- e2f534c formatter/sort_imports: Handle alignable comment with JsLabels
(#17791) (leaysgur)
- f0cedd4 formatter/tailwindcss: Class name is broken after sorting when
its contains single quotes with `singleQuote: true` (#17790) (Dunqing)
- 1864142 oxfmt/tailwindcss: Bundle `prettier/plugins/*` (#17782)
(leaysgur)
- 3a9d43b oxfmt: Ignore explicit positional path which is ignored by
directory (#17732) (leaysgur)
- 0563217 formatter: Classes will be stripped out when both
`experimentalTailwindcss` and `experimentalSortImports` are enabled
(#17726) (Dunqing)

### ⚡ Performance

- d1bc514 formatter: Optimize RegExpLiteral formatting to avoid heap
allocations (#17797) (Dunqing)

### 📚 Documentation

- 62b7a01 formatter: Clarify `experimentalTailwindcss` configuration
comments (#17898) (Dunqing)

Co-authored-by: Boshen <1430279+Boshen@users.noreply.github.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

A-linter Area - Linter C-enhancement Category - New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants