Skip to content
This repository has been archived by the owner on Jan 3, 2024. It is now read-only.

👍 Clone from denops.vim/denops/@denops for v6 #13

Merged
merged 1 commit into from
Dec 31, 2023
Merged

👍 Clone from denops.vim/denops/@denops for v6 #13

merged 1 commit into from
Dec 31, 2023

Conversation

lambdalisue
Copy link
Member

@lambdalisue lambdalisue commented Dec 31, 2023

We are planning to separate deno module from denops.vim

Summary by CodeRabbit

  • New Features

    • Introduced an automated workflow for updating dependencies and creating pull requests for changes.
    • Implemented a new emoji-based guide for standardized commit messages.
  • Documentation

    • Updated the README.md to reflect the shift to a new core module and added usage warnings.
    • Added a .gitmessage file to guide contributors on how to use emojis in commit messages.
  • Refactor

    • Refined the GitHub Actions workflows to enhance testing and deployment processes.
    • Updated the core functionality and interface of the application for improved error handling and extensibility.
  • Chores

    • Set up new Deno task configurations for testing, linting, and upgrading dependencies.
  • License Update

    • Modified the copyright notice to accurately reflect the current ownership.

Copy link

coderabbitai bot commented Dec 31, 2023

Warning

Rate Limit Exceeded

@lambdalisue has exceeded the limit for the number of files or commits that can be reviewed per hour. Please wait 14 minutes and 56 seconds before requesting another review.

How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command. Alternatively, push new commits to this PR.

We recommend that you space out your commits to avoid hitting the rate limit.

How do rate limits work?

CodeRabbit enforces hourly rate limits for each developer per organization.
Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout.
Please see our FAQ for further information.

Commits Files that changed from the base of the PR and between 5c84d01 and 76bc47a.

Walkthrough

The project has undergone a significant workflow update, refining automation for testing and dependency updates, and shifting to a more robust code structure. A new commit message guide promotes clarity, the license reflects an ownership change, and the README.md points to a module transition. The codebase itself is enhanced with Deno task configurations and improved module definitions, promoting better error handling and interface design.

Changes

Files Summary of Changes
.github/workflows/test.yml Renamed workflow, added scheduled job, modified job structure, introduced conditional steps for Windows runners, adjusted matrix strategy, added environment variables, and code coverage step.
.github/workflows/update.yml Introduced scheduled and manually triggered workflow for dependency updates, commits, file reading, and pull request creation under specific conditions.
.gitmessage Introduced emoji-guided commit message conventions.
LICENSE Updated copyright notice to "Copyright 2021 vim-denops."
README.md Deprecated a module in favor of denops_core, updated badges, and added usage warning.
deno.jsonc Added Deno task configurations for testing, coverage, and dependency management.
denops.ts, mod.ts Redefined exported entities, interfaces, and introduced new error handling classes.

🐇✨
In the den where code does leap,
Changes vast, the rabbit's feat.
Through the workflow, tests do weave,
A denops tale, on New Year's Eve. 🎉🥕

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

Tips

Chat with CodeRabbit Bot (@coderabbitai)

  • You can directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • You can tag CodeRabbit on specific lines of code or entire files in the PR by tagging @coderabbitai in a comment. Examples:
    • @coderabbitai generate unit tests for this file.
    • @coderabbitai modularize this function.
  • You can tag @coderabbitai in a PR comment and ask questions about the PR and the codebase. Examples:
    • @coderabbitai generate interesting stats about this repository from git and render them as a table.
    • @coderabbitai show all the console.log statements in this repository.
    • @coderabbitai read src/utils.ts and generate unit tests.
    • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid.
    • @coderabbitai read the files in the src/scheduler package and generate README in the markdown format.

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.

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 a review. This is useful when automatic reviews are disabled for the repository.
  • @coderabbitai resolve resolve all the CodeRabbit review comments.
  • @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

  • You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
  • The JSON schema for the configuration file is available here.
  • 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/coderabbit-overrides.v2.json

CodeRabbit Discord Community

Join our Discord Community to get help, request features, and share feedback.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 1

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5c84d01 and b1551d2.
Files selected for processing (8)
  • .github/workflows/test.yml (1 hunks)
  • .github/workflows/update.yml (1 hunks)
  • .gitmessage (1 hunks)
  • LICENSE (2 hunks)
  • README.md (1 hunks)
  • deno.jsonc (1 hunks)
  • denops.ts (1 hunks)
  • mod.ts (1 hunks)
Files skipped from review due to trivial changes (2)
  • .gitmessage
  • LICENSE
Additional comments: 7
deno.jsonc (2)
  • 2-2: The "lock": false configuration is typically used to ensure that dependencies are locked to specific versions for reproducibility. Please verify if setting it to false aligns with the project's dependency management strategy.

  • 4-8: The task configurations for testing, coverage analysis, and dependency upgrades are well-defined and align with the project's goals of enhanced maintainability and modular development.

mod.ts (1)
  • 1-19: The module description and the newly added exports of BatchError and various types from ./denops.ts are clear and well-documented, aligning with the project's goal of discouraging direct usage of the module and guiding users towards denops_std.
README.md (1)
  • 1-17: The updates to the module name, badges, links, and the clear guidance provided against direct use of the module are appropriate and align with the project's restructuring goals.
.github/workflows/update.yml (1)
  • 1-49: The update.yml workflow is well-structured with a clear schedule, steps for updating dependencies, and automated pull request creation. This setup will facilitate regular maintenance and dependency management.
.github/workflows/test.yml (1)
  • 1-102: The test.yml workflow has been appropriately renamed and includes a comprehensive set of scheduled jobs, a matrix strategy for different operating systems and Deno versions, and new steps for linting, formatting, type checking, and code coverage. These changes enhance the project's testing procedures and align with best practices.
denops.ts (1)
  • 1-125: The changes to the Dispatcher interface, the new Context type definition, the introduction of the Meta interface and BatchError class, and the expansion of the Denops interface with new properties and methods are all well-defined and documented. These changes enhance the module's functionality and error handling capabilities.

Copy link

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

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

Review Status

Actionable comments generated: 0

Configuration used: CodeRabbit UI

Commits Files that changed from the base of the PR and between 5c84d01 and 6f98fc1.
Files selected for processing (8)
  • .github/workflows/test.yml (1 hunks)
  • .github/workflows/update.yml (1 hunks)
  • .gitmessage (1 hunks)
  • LICENSE (2 hunks)
  • README.md (1 hunks)
  • deno.jsonc (1 hunks)
  • denops.ts (1 hunks)
  • mod.ts (1 hunks)
Files skipped from review as they are similar to previous changes (6)
  • .github/workflows/test.yml
  • .github/workflows/update.yml
  • LICENSE
  • README.md
  • deno.jsonc
  • mod.ts
Additional comments: 6
.gitmessage (1)
  • 1-25: The addition of a .gitmessage template is a good practice for standardizing commit messages across the project. It helps contributors to follow a consistent format, which can be beneficial for readability and understanding the project's history.
denops.ts (5)
  • 4-5: The updated Dispatcher interface with an index signature allows for a more flexible and dynamic method dispatching, which can accommodate various API calls without needing to define each one explicitly.

  • 11-11: Changing the Context type to a Record improves type safety and makes the intention clearer that it's a collection of key-value pairs.

  • 16-26: The new Meta interface provides a structured way to handle environment metadata, which is essential for plugins to adapt their behavior based on the host and mode.

  • 32-41: The introduction of the BatchError class is a good practice for error handling, as it encapsulates batch operation errors and retains the results of successful operations up to the point of failure.

  • 46-124: The expansion of the Denops interface with new properties and methods like redraw, batch, and dispatch enhances the interface's capabilities, providing more options for plugin developers to interact with the Vim/Neovim environment.

@lambdalisue lambdalisue merged commit 1d3a8e5 into main Dec 31, 2023
2 checks passed
@lambdalisue lambdalisue deleted the v6 branch December 31, 2023 10:36
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant