:+1: generate sub local scope option types

Milly commented 2 months ago

Fixes #267 Fixes some #268

getTabPage() or setTabPage() is not implemented. See https://github.com/vim-denops/deno-denops-std/issues/268#issuecomment-2316587922

Summary by CodeRabbit

New Features
- Enhanced option processing and exporting with a new Context type for better management of option types and constructors.
- Improved error handling in the parsing functions for more informative logging.
- Introduced new interfaces for local options, allowing for more specific option management across different contexts (buffer, tab page, window).
Bug Fixes
- Updated return types in parsing functions to ensure more predictable outputs and prevent runtime errors.
Documentation
- Updated comments to clarify new requirements and expectations for option handling.
Refactor
- Streamlined type checks and option declarations for improved readability and maintainability.

coderabbitai[bot] commented 2 months ago

Walkthrough

The changes involve significant updates to the option handling system, enhancing type definitions and refining the scope of various options. New types such as BufferLocalOption, WindowLocalOption, and others have been introduced, while existing options have been updated to reflect their specific contexts. Improvements in error handling, option processing, and the overall structure of the code have also been implemented to ensure better management and clarity.

Changes

Files	Change Summary
`.scripts/gen-option/format.ts`	Updated `formatOption` to use a new `Context` type, refactored option type determination logic.
`.scripts/gen-option/parse.ts`	Enhanced error handling in `parse`, modified `parseBlock` to always return an `Option` object.
`.scripts/gen-option/types.ts`	Introduced new types and constants for option handling, replaced function declarations with constants.
`option/_generated.ts`	Updated various option types for specificity, changing from `LocalOption` to more specific types.
`option/_utils.ts`	Expanded `OptionImpl` class to implement multiple option interfaces, enhancing flexibility.
`option/nvim/_generated.ts`	Changed option types to reflect buffer and window specificity, improving clarity.
`option/types.ts`	Added new interfaces for local options and refined existing type definitions for better control.
`option/vim/_generated.ts`	Updated option declarations to improve specificity and control over option scopes.

Assessment against linked issues

Objective	Addressed	Explanation
Users may access options in an unintended way (#267)	❌	The issue regarding `getBuffer()` method remains unaddressed.

🐇 Hop, hop, hooray for changes bright,
New options sprout, taking flight!
Buffer and window, all in their place,
Clarity shines, a joyful embrace!
With types so neat, we dance and play,
In the land of code, it's a splendid day! 🌼

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 using 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. ### Other keywords and placeholders - Add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. - Add `@coderabbitai summary` to generate the high-level summary at a specific location in the PR description. - Add `@coderabbitai` anywhere in the PR title to generate the title automatically. ### 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.

Milly commented 2 months ago

Blocked by #269.

error: TS2339 [ERROR]: Property 'getBuffer' does not exist on type 'WindowLocalOption<string>'.
      op.foldmethod.getBuffer(denops, bufnr),
                    ~~~~~~~~~
    at file:///deno-denops-std/buffer/buffer.ts:526:21

Milly commented 2 months ago

@coderabbitai review

codecov[bot] commented 2 months ago

Codecov Report

All modified and coverable lines are covered by tests :white_check_mark:

Project coverage is 84.60%. Comparing base (afa88b7) to head (75e7696). Report is 3 commits behind head on main.

Additional details and impacted files

```diff @@ Coverage Diff @@ ## main #270 +/- ## ======================================= Coverage 84.60% 84.60% ======================================= Files 63 63 Lines 3372 3372 Branches 291 291 ======================================= Hits 2853 2853 Misses 517 517 Partials 2 2 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.

coderabbitai[bot] commented 2 months ago

Actions performed

Review triggered. > Note: CodeRabbit is an incremental review system and does not re-review already reviewed commits. This command is applicable only when automatic reviews are paused.

vim-denops / deno-denops-std