Skip to content

Fix the typing - #3

Merged
github-actions[bot] merged 1 commit into
mainfrom
fix/typing
Nov 2, 2025
Merged

Fix the typing#3
github-actions[bot] merged 1 commit into
mainfrom
fix/typing

Conversation

@poad

@poad poad commented Nov 2, 2025

Copy link
Copy Markdown
Owner

概要

概要を記述。

変更点

追加・変更・削除したファイル (リポジトリルートからの相対パス) 変更内容 事由
package/package.json files および publishConfig プロパティを追加 publish されたものを使用する際に型解決ができないのを改善するため

関連Issue

確認事項

  • (Typescriptの場合) pnpm audit --fix で脆弱性を修正済みか?
  • (Typescriptの場合) pnpm lint-fix でコードスタイルは修正済みか?
  • (Markdownの場合)markdownlint-2 で Markdown の lint は修正済みか?

特記事項

@amazon-q-developer

Copy link
Copy Markdown

Code review in progress. Analyzing for code quality issues and best practices. You can monitor the review status in the checks section at the bottom of this pull request. Detailed findings will be posted upon completion.

Using Amazon Q Developer for GitHub

Amazon Q Developer1 is an AI-powered assistant that integrates directly into your GitHub workflow, enhancing your development process with intelligent features for code development, review, and transformation.

Slash Commands

Command Description
/q <message> Chat with the agent to ask questions or request revisions
/q review Requests an Amazon Q powered code review
/q help Displays usage information

Features

Agentic Chat
Enables interactive conversation with Amazon Q to ask questions about the pull request or request specific revisions. Use /q <message> in comment threads or the review body to engage with the agent directly.

Code Review
Analyzes pull requests for code quality, potential issues, and security concerns. Provides feedback and suggested fixes. Automatically triggered on new or reopened PRs (can be disabled for AWS registered installations), or manually with /q review slash command in a comment.

Customization

You can create project-specific rules for Amazon Q Developer to follow:

  1. Create a .amazonq/rules folder in your project root.
  2. Add Markdown files in this folder to define rules (e.g., cdk-rules.md).
  3. Write detailed prompts in these files, such as coding standards or best practices.
  4. Amazon Q Developer will automatically use these rules when generating code or providing assistance.

Example rule:

All Amazon S3 buckets must have encryption enabled, enforce SSL, and block public access.
All Amazon DynamoDB Streams tables must have encryption enabled.
All Amazon SNS topics must have encryption enabled and enforce SSL.
All Amazon SNS queues must enforce SSL.

Feedback

To provide feedback on Amazon Q Developer, create an issue in the Amazon Q Developer public repository.

For more detailed information, visit the Amazon Q for GitHub documentation.

Footnotes

  1. Amazon Q Developer uses generative AI. You may need to verify generated code before using it in your environment. See the AWS Responsible AI Policy.

@github-actions

github-actions Bot commented Nov 2, 2025

Copy link
Copy Markdown
Contributor

Dependency Review

✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.

Scanned Files

None

@github-actions
github-actions Bot enabled auto-merge (squash) November 2, 2025 06:19

@amazon-q-developer amazon-q-developer Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

レビュー概要

このPRは型解決の問題を改善するための適切な変更です。主な改善点は以下の通りです:

✅ 良い変更点

  • files フィールドの追加により、パッケージ公開時に必要なファイルのみが含まれるようになりました
  • publishConfig の追加により、公開されたパッケージでの型解決が改善されます
  • .gitignore への *.tgzpackage の追加により、ビルド成果物の管理が適切になりました
  • types フィールドのパス修正(./ プレフィックス追加)により、一貫性が向上しました

🔧 改善提案

  • publishConfigtypings の代わりに types を使用することを推奨します(非推奨フィールドのため)
  • files フィールドに package.json を含めることを検討してください
  • ファイル末尾の改行を追加することを推奨します

全体的に、パッケージの公開設定を改善する良いPRです。提案した修正を適用することで、より標準的で保守性の高い設定になります。


Coming soon: You'll be able to request the agent to implement changes and create commits on your pull request's source branch. This may trigger any configured CI/CD workflows automatically.

You can disable any CI/CD workflow that you have configured to run on the source branch of the pull request. For more information, see Disabling and enabling a workflow in the GitHub documentation.

Comment thread package/package.json
Comment on lines +23 to +26
"publishConfig": {
"main": "./dist/index.js",
"typings": "./dist/index.d.ts"
},

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

パッケージの公開設定が適切に改善されています。files フィールドの追加により、公開時に必要なファイルのみが含まれるようになり、publishConfig の追加により型解決の問題が解決されます。ただし、publishConfigtypings フィールドは非推奨のため、types を使用することを推奨します。

Suggested change
"publishConfig": {
"main": "./dist/index.js",
"typings": "./dist/index.d.ts"
},
"publishConfig": {
"main": "./dist/index.js",
"types": "./dist/index.d.ts"
},

Comment thread package/package.json
Comment on lines +14 to +17
"files": [
"dist",
"README.md"
],

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

パッケージ公開時に含まれるファイルを明示的に指定する files フィールドの追加は良い改善です。ただし、TypeScriptプロジェクトでは型定義ファイル(*.d.ts)も含めることを推奨します。また、package.json 自体も含めることが一般的です。

Suggested change
"files": [
"dist",
"README.md"
],
"files": [
"dist",
"README.md",
"package.json"
],

Comment thread package/package.json
"zod": "^3.25.76"
}
}
} No newline at end of file

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

ファイル末尾の改行が削除されています。JSONファイルでは必須ではありませんが、多くのエディタやlintツールが末尾の改行を期待するため、一貫性のために追加することを推奨します。

Suggested change
}
}

Comment thread package/.gitignore
Comment on lines +12 to +13
*.tgz
package

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

.gitignore への *.tgzpackage の追加は適切です。これらはnpmパッケージのビルド成果物やテスト用のパッケージファイルであり、バージョン管理から除外すべきファイルです。パッケージ開発時の一時的なファイルが誤ってコミットされることを防げます。

@github-actions
github-actions Bot merged commit 17966c3 into main Nov 2, 2025
4 checks passed
@github-actions
github-actions Bot deleted the fix/typing branch November 2, 2025 06:21
@github-actions github-actions Bot mentioned this pull request Nov 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant