Skip to content

Conversation

@samchon
Copy link
Owner

@samchon samchon commented Jan 27, 2026

As prettier-plugin-jsdoc automatically changes @hidden tag to @ignore by its origin rule, typia needs to support the @ignore tag.


This pull request introduces a minor version update and expands the handling of JSDoc tags to allow for more flexible exclusion of properties in schema and application programmers. The main focus is to ensure that properties tagged with @ignore (in addition to @hidden and @internal) are consistently excluded from generated schemas and outputs.

Expanded exclusion of properties by JSDoc tag:

  • Updated src/programmers/internal/json_schema_object.ts to also skip properties tagged with @ignore (in addition to @hidden and @internal) when generating object schemas.
  • Modified src/programmers/json/JsonApplicationProgrammer.ts and src/programmers/llm/LlmApplicationProgrammer.ts to ensure properties with the @ignore tag are excluded alongside @hidden and @internal in their respective filtering logic. [1] [2]

Version update:

  • Bumped the package version in package.json from 11.0.2 to 11.0.3 to reflect these changes.

As `prettier-plugin-jsdoc` automatically changes `@hidden` tag to `@ignore` by its origin rule, `typia` needs to support the `@ignore` tag.
@samchon samchon self-assigned this Jan 27, 2026
@samchon samchon added the enhancement New feature or request label Jan 27, 2026
@pkg-pr-new
Copy link

pkg-pr-new bot commented Jan 27, 2026

Open in StackBlitz

npm i https://pkg.pr.new/typia@1721

commit: ef1fa4b

@samchon samchon marked this pull request as ready for review January 27, 2026 01:40
Copilot AI review requested due to automatic review settings January 27, 2026 01:40
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 pull request adds support for the @ignore JSDoc tag to ensure compatibility with prettier-plugin-jsdoc, which automatically converts @hidden to @ignore. The change allows properties tagged with @ignore, @hidden, or @internal to be consistently excluded from generated schemas and LLM applications.

Changes:

  • Extended JSDoc tag filtering to include @ignore alongside existing @hidden and @internal tags across JSON schema and LLM application programmers
  • Bumped package version from 11.0.2 to 11.0.3 to reflect this enhancement

Reviewed changes

Copilot reviewed 4 out of 4 changed files in this pull request and generated 2 comments.

File Description
package.json Version bumped to 11.0.3 (appropriate patch version increase)
src/programmers/llm/LlmApplicationProgrammer.ts Added @ignore tag check when filtering function parameters for LLM applications
src/programmers/json/JsonApplicationProgrammer.ts Added @ignore tag check when filtering properties for JSON schema applications
src/programmers/internal/json_schema_object.ts Added @ignore tag check when generating object schemas and updated comment

Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com>
@samchon samchon merged commit 4a5dd70 into master Jan 27, 2026
5 of 8 checks passed
@samchon samchon deleted the feat/ignore branch January 27, 2026 02:25
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant