Skip to content

docs(core): fix useSet Interface component parsing error #361

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kimyouknow merged 2 commits into from
Apr 21, 2026
Merged

docs(core): fix useSet Interface component parsing error #361

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
065d9d0
docs(core): fix useSet Interface component parsing error
guesung Apr 1, 2026
bfdc0a6
Merge branch 'main' into docs/fix-useset-interface-parsing
kimyouknow Apr 21, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
82 changes: 41 additions & 41 deletions packages/core/src/hooks/useSet/ko/useSet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,47 +21,47 @@ function useSet<T>(
### 반환 값

<Interface
name=""
type="[Set, SetActions]"
description="Set 상태와 이를 조작하는 액션을 포함한 튜플이에요."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, \"add\" | \"clear\" | \"delete\">',
required: false,
description: '변경 메서드가 숨겨진 현재 Set 상태예요.',
},
{
name: '[1].add',
type: '(value: T) => void',
required: false,
description: 'Set에 값을 추가해요.',
},
{
name: '[1].remove',
type: '(value: T) => void',
required: false,
description: 'Set에서 값을 제거해요.',
},
{
name: '[1].toggle',
type: '(value: T) => void',
required: false,
description: '값이 없으면 추가하고, 있으면 제거해요.',
},
{
name: '[1].setAll',
type: '(values: Set<T> | T[]) => void',
required: false,
description: 'Set의 모든 값을 교체해요.',
},
{
name: '[1].reset',
type: '() => void',
required: false,
description: 'Set을 초기 상태로 리셋해요.',
},
]"
name=""
type="[Set, SetActions]"
description="Set 상태와 이를 조작하는 액션을 포함한 튜플이에요."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, add | clear | delete>',
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

반환 값의 nested 타입에서 Omit 키가 따옴표 없이 표시되고 있어요 (add | clear | delete). 위 시그니처의 타입(Omit<Set<T>, 'add' | 'clear' | 'delete'>)과 불일치하고 TypeScript 표기법으로도 부정확합니다. Vue 파서 이슈를 피하면서 정확도를 유지하려면, 현재 single-quote 문자열 안에서 키만 double quote로 표기하는 방식(예: "add" | "clear" | "delete" 형태를 백슬래시 없이)으로 맞춰 주세요.

Suggested change
type: 'Omit<Set<T>, add | clear | delete>',
type: 'Omit<Set<T>, "add" | "clear" | "delete">',

Copilot uses AI. Check for mistakes.
Comment on lines +25 to +30
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

반환 값 <Interface>의 type이 [Set, SetActions]로 되어 있는데, 위 시그니처의 실제 반환 타입([Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>])과 달라요. 이 섹션이 반환 타입을 대표해서 보여주는 만큼, 실제 타입(또는 구현에서 쓰는 UseSetReturn<T> 별칭)과 일치시키는 게 좋습니다.

Suggested change
type="[Set, SetActions]"
description="Set 상태와 이를 조작하는 액션을 포함한 튜플이에요."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, add | clear | delete>',
type="[Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>]"
description="Set 상태와 이를 조작하는 액션을 포함한 튜플이에요."
:nested="[
{
name: '[0]',
type: \"Omit<Set<T>, 'add' | 'clear' | 'delete'>\",

Copilot uses AI. Check for mistakes.
required: false,
description: '변경 메서드가 숨겨진 현재 Set 상태예요.',
},
{
name: '[1].add',
type: '(value: T) => void',
required: false,
description: 'Set에 값을 추가해요.',
},
{
name: '[1].remove',
type: '(value: T) => void',
required: false,
description: 'Set에서 값을 제거해요.',
},
{
name: '[1].toggle',
type: '(value: T) => void',
required: false,
description: '값이 없으면 추가하고, 있으면 제거해요.',
},
{
name: '[1].setAll',
type: '(values: Set<T> | T[]) => void',
required: false,
description: 'Set의 모든 값을 교체해요.',
},
{
name: '[1].reset',
type: '() => void',
required: false,
description: 'Set을 초기 상태로 리셋해요.',
},
]"
/>

## 예시
Expand Down
82 changes: 41 additions & 41 deletions packages/core/src/hooks/useSet/useSet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,47 +21,47 @@ function useSet<T>(
### Return Value

<Interface
name=""
type="[Set, SetActions]"
description="A tuple containing the Set state and actions to manipulate it."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, \"add\" | \"clear\" | \"delete\">',
required: false,
description: 'The current Set state with mutation methods hidden.',
},
{
name: '[1].add',
type: '(value: T) => void',
required: false,
description: 'Adds a value to the set.',
},
{
name: '[1].remove',
type: '(value: T) => void',
required: false,
description: 'Removes a value from the set.',
},
{
name: '[1].toggle',
type: '(value: T) => void',
required: false,
description: 'Adds the value if absent, removes it if present.',
},
{
name: '[1].setAll',
type: '(values: Set<T> | T[]) => void',
required: false,
description: 'Replaces all values in the set.',
},
{
name: '[1].reset',
type: '() => void',
required: false,
description: 'Resets the set to its initial state.',
},
]"
name=""
type="[Set, SetActions]"
description="A tuple containing the Set state and actions to manipulate it."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, add | clear | delete>',
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

In the nested return type, the omitted keys are missing quotes (add | clear | delete). This no longer matches the hook signature above (Omit<Set<T>, 'add' | 'clear' | 'delete'>) and is not valid TypeScript syntax when presented to users. Consider using double-quoted keys inside the existing single-quoted string (e.g., "add" | "clear" | "delete" without backslashes) so the docs remain accurate while still avoiding the Vue template parsing issue.

Suggested change
type: 'Omit<Set<T>, add | clear | delete>',
type: 'Omit<Set<T>, "add" | "clear" | "delete">',

Copilot uses AI. Check for mistakes.
Comment on lines +25 to +30
Copy link

Copilot AI Apr 1, 2026

Choose a reason for hiding this comment

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

The return value type shown in the <Interface> component ([Set, SetActions]) doesn’t match the actual signature just above ([Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>]). Since this block is the primary “Return Value” type display, consider aligning it with the real return type (or using the same UseSetReturn<T> alias used in the implementation).

Suggested change
type="[Set, SetActions]"
description="A tuple containing the Set state and actions to manipulate it."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, add | clear | delete>',
type="[Omit<Set<T>, 'add' | 'clear' | 'delete'>, SetActions<T>]"
description="A tuple containing the Set state and actions to manipulate it."
:nested="[
{
name: '[0]',
type: 'Omit<Set<T>, \'add\' | \'clear\' | \'delete\'>',

Copilot uses AI. Check for mistakes.
required: false,
description: 'The current Set state with mutation methods hidden.',
},
{
name: '[1].add',
type: '(value: T) => void',
required: false,
description: 'Adds a value to the set.',
},
{
name: '[1].remove',
type: '(value: T) => void',
required: false,
description: 'Removes a value from the set.',
},
{
name: '[1].toggle',
type: '(value: T) => void',
required: false,
description: 'Adds the value if absent, removes it if present.',
},
{
name: '[1].setAll',
type: '(values: Set<T> | T[]) => void',
required: false,
description: 'Replaces all values in the set.',
},
{
name: '[1].reset',
type: '() => void',
required: false,
description: 'Resets the set to its initial state.',
},
]"
/>

## Example
Expand Down
Loading