Add cli command for canonicalize oas document

[toothlessdev]

📎 Related issues

• resolve Add cli command for canonicalize oas document #6

📦 Scope

• @patchlogr/core
• @patchlogr/cli
• @patchlogr/inspector
• @patchlogr/oas
• @patchlogr/types
• docs, examples
• tests
• ci / cd / infra
• other (아래에 명시)

📌 Summary

• cli 툴에 oas 문서 표준화 명령어 추가

⚠️ Impact

• No Breaking Changes
• Breaking Change
• Versioning 영향 있음 (major / minor / patch)
• 내부 리팩토링만 포함

✅ Checklist

• 요구사항 명세 충족
• 테스트 추가 / 수정
• deterministic output 확인

[gemini-code-assist]

Summary of Changes

Hello @toothlessdev, I'm Gemini Code Assist¹! I'm currently reviewing this pull request and will post my feedback shortly. In the meantime, here's a summary to help you and other reviewers quickly get up to speed!

이 풀 리퀘스트는 @patchlogr/cli 도구에 새로운 canonicalize 명령어를 도입하여 사용자가 OpenAPI 사양 문서를 명령줄에서 직접 표준화할 수 있도록 합니다. 이 명령어는 기존의 preprocessOASDocument 기능을 활용하며, 유효성 검사를 건너뛰고 출력을 파일 또는 표준 출력으로 지정하는 옵션을 제공합니다. 또한, 워크스페이스 종속성 선언 업데이트 및 필요한 타이핑 패키지 추가가 포함되어 있습니다. 이 변경 사항은 Breaking Change를 수반합니다.

Highlights

• 새로운 CLI 명령어 추가: @patchlogr/cli에 OpenAPI 문서를 표준화하는 새로운 canonicalize CLI 명령어가 추가되었습니다.
• 출력 옵션 확장: canonicalize 명령어는 처리된 OpenAPI 문서를 표준 출력으로 보내거나 지정된 파일에 저장할 수 있는 기능을 제공합니다.
• 종속성 버전 업데이트: 여러 패키지에서 워크스페이스 종속성 버전이 workspace:*에서 workspace:^로 업데이트되었으며, @patchlogr/cli에 openapi-types가 개발 종속성으로 추가되었습니다.
• Breaking Change 포함: 이 풀 리퀘스트는 Breaking Change를 포함합니다.

🧠 New Feature in Public Preview: You can now enable Memory to help Gemini Code Assist learn from your team's feedback. This makes future code reviews more consistent and personalized to your project's style. Click here to enable Memory in your admin console.

Using Gemini Code Assist

The full guide for Gemini Code Assist can be found on our documentation page, here are some quick tips.

Invoking Gemini

You can request assistance from Gemini at any point by creating a comment using either /gemini <command> or @gemini-code-assist <command>. Below is a summary of the supported commands on the current page.

Feature	Command	Description
Code Review	/gemini review	Performs a code review for the current pull request in its current state.
Pull Request Summary	/gemini summary	Provides a summary of the current pull request in its current state.
Comment	@gemini-code-assist	Responds in comments when explicitly tagged, both in pull request comments and review comments.
Help	/gemini help	Displays a list of available commands.

Customization

To customize Gemini Code Assist for GitHub experience, repository maintainers can create a configuration file and/or provide a custom code review style guide (such as PEP-8 for Python) by creating and adding files to a .gemini/ folder in the base of the repository. Detailed instructions can be found here.

Limitations & Feedback

Gemini Code Assist may make mistakes. Please leave feedback on any instances where its feedback is incorrect or counter productive. You can react with 👍 and 👎 on @gemini-code-assist comments. If you're interested in giving your feedback about your experience with Gemini Code Assist for Github and other Google products, sign up here.

You can also get AI-powered code generation, chat, as well as code reviews directly in the IDE at no cost with the Gemini Code Assist IDE Extension.

Footnotes

1. Review the Privacy Notices, Generative AI Prohibited Use Policy, Terms of Service, and learn how to configure Gemini Code Assist in GitHub here. Gemini can make mistakes, so double check it and use code with caution. ↩

[github-actions]

Test Results

61 tests   61 ✅  0s ⏱️
13 suites   0 💤
 3 files     0 ❌

Results for commit 2857a1d.

♻️ This comment has been updated with latest results.

[gemini-code-assist]

Code Review

이 PR은 patchlogr CLI에 OpenAPI 문서를 표준화하는 canonicalize 명령어를 추가합니다. 전반적으로 좋은 방향의 변경이지만, 몇 가지 중요한 수정이 필요합니다.

주요 피드백:

1. cli.ts에서 파일 경로를 OpenAPI.Document 객체로 파싱하지 않고 runCanonicalize 함수에 전달하여 발생하는 치명적인(critical) 타입 오류가 있습니다.
2. runCanonicalize.ts에서 파일 쓰기 실패 시 오류를 제대로 전파하지 않아 명령어가 성공한 것처럼 보이는 심각한(high) 문제가 있습니다.
3. 오류 로깅 방식이 사용자에게 너무 장황할 수 있어 개선이 필요합니다.

자세한 내용은 각 파일에 대한 개별 코멘트를 참고해주세요.