kamecha / traqVimPractice

Unofficial traQ Vim/Neovim plugin.
MIT License
7 stars 0 forks source link

unkownutil周りのライブラリを上げて、型判定周りを整理 #93

Closed kamecha closed 1 month ago

kamecha commented 1 month ago

60

↑これに関連する

Summary by CodeRabbit

coderabbitai[bot] commented 1 month ago

Walkthrough

The updates across various files enhance type safety and validation mechanisms by transitioning from utility functions to assertion-based checks. This shift from ensure functions to assert calls improves error handling and code readability, ensuring that variables conform to expected types before processing. Overall, the changes lead to a more robust and maintainable code structure, minimizing potential runtime errors.

Changes

Files Change Summary
denops/@ddc-sources/*.ts Updated onInit methods in the Source class to use assert for string validation instead of ensureString, enhancing type safety.
denops/@ddu-kinds/*.ts Replaced ensureNumber and ensureArray with assert checks, enhancing validation for limit and ret variables.
denops/traqvim/*.ts Replaced various ensure functions with assert, improving validation for timeline messages and other parameters, enhancing type safety and error handling.
denops/traqvim/deps.ts Transitioned exports from utility functions (ensure...) to assertion-based utilities (assert, is), enhancing type safety in the codebase.
denops/traqvim/type_check.ts Introduced type predicates for MessageStamp, UserAccountState, User, and Message to validate data structures, enhancing type safety.

Sequence Diagram(s)

sequenceDiagram
    participant User
    participant App
    participant Source
    participant Validator

    User->>App: Initiates action
    App->>Source: Call onInit()
    Source->>Validator: Validate path
    Validator-->>Source: Assert path is string
    Source-->>App: Proceed with valid path
    App-->>User: Action completed

🐇 "In a world so neat and bright,
We check our paths, make things right.
With assertions bold and true,
Our code now dances, fresh and new!
Hooray for types, let errors flee,
A happy rabbit, that's me! 🐰✨"


Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share - [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)
Tips ### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `Generate unit testing code for this file.` - `Open a follow-up GitHub issue for this discussion.` - Files and specific lines of code (under the "Files changed" tab): Tag `@coderabbitai` in a new review comment at the desired location with your query. Examples: - `@coderabbitai generate unit testing code for this file.` - `@coderabbitai modularize this function.` - PR comments: Tag `@coderabbitai` in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples: - `@coderabbitai generate interesting stats about this repository and render them as a table.` - `@coderabbitai show all the console.log statements in this repository.` - `@coderabbitai read src/utils.ts and generate unit testing code.` - `@coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.` - `@coderabbitai help me debug CodeRabbit configuration file.` Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. ### CodeRabbit Commands (invoked as PR comments) - `@coderabbitai pause` to pause the reviews on a PR. - `@coderabbitai resume` to resume the paused reviews. - `@coderabbitai review` to trigger an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration File (`.coderabbit.yaml`) - You can programmatically configure CodeRabbit by adding a `.coderabbit.yaml` file to the root of your repository. - Please see the [configuration documentation](https://docs.coderabbit.ai/guides/configure-coderabbit) for more information. - If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: `# yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json` ### Documentation and Community - Visit our [Documentation](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.
kamecha commented 1 month ago

asを使用してる箇所があったら積極的にassertとかに変更しておきたい

一度asしてて、知らないうちにvim固まっちゃった事あるので...

kamecha commented 1 month ago

Predicateだとメタデータの情報が落ちるらしいから、折をみてsatisfiesとかいうの使ってみたい