Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

🐛 Re-export BatchError class and fix documentation of buffer.concrete #232

Merged
merged 3 commits into from
Feb 4, 2024

Conversation

lambdalisue
Copy link
Member

@lambdalisue lambdalisue commented Feb 4, 2024

SSIA

Summary by CodeRabbit

  • Refactor
    • Modified export statements for enhanced module organization.
  • Bug Fixes
    • Updated buffer options for improved reliability in content restoration.

The current `concrete` function won't touch options mentioned in the documentation.
It seems `vim` code block annotation cause 500 error on
denoland/docland. I'm not sure if this is the reason why documentation
of denops_std is not generated but try

  [uncaught application error]: Error - Unknown language: `vim` is not registered

  request: {
    url: "http://0.0.0.0:8080/https://raw.githubusercontent.com/vim-denops/deno-denops-std/main/argument/mod.t"... 1 more character,
    method: "GET",
    hasBody: false
  }
  response: { status: 500, type: "html", hasBody: true, writable: true }

      at a (https://esm.sh/v91/fault@2.0.1/denonext/fault.mjs:2:312)
      at Object.u [as highlight] (https://esm.sh/v91/lowlight@2.4.1/denonext/lowlight.mjs:2:2820)
      at syntaxHighlight (file:///Users/alisue/ghq/github.com/denoland/docland/components/common.tsx:148:27)
      at MarkdownBlock (file:///Users/alisue/ghq/github.com/denoland/docland/components/markdown.tsx:101:28)
      at renderFunctionalComponent (https://deno.land/x/nano_jsx@v0.0.33/core.ts:160:18)
      at _render (https://deno.land/x/nano_jsx@v0.0.33/core.ts:134:70)
      at https://deno.land/x/nano_jsx@v0.0.33/core.ts:46:17
      at Array.forEach (<anonymous>)
      at appendChildren (https://deno.land/x/nano_jsx@v0.0.33/core.ts:41:12)
      at h (https://deno.land/x/nano_jsx@v0.0.33/core.ts:286:3)
  [error] Error: Unknown language: `vim` is not registered

      at a (https://esm.sh/v91/fault@2.0.1/denonext/fault.mjs:2:312)
      at Object.u [as highlight] (https://esm.sh/v91/lowlight@2.4.1/denonext/lowlight.mjs:2:2820)
      at syntaxHighlight (file:///Users/alisue/ghq/github.com/denoland/docland/components/common.tsx:148:27)
      at MarkdownBlock (file:///Users/alisue/ghq/github.com/denoland/docland/components/markdown.tsx:101:28)
      at renderFunctionalComponent (https://deno.land/x/nano_jsx@v0.0.33/core.ts:160:18)
      at _render (https://deno.land/x/nano_jsx@v0.0.33/core.ts:134:70)
      at https://deno.land/x/nano_jsx@v0.0.33/core.ts:46:17
      at Array.forEach (<anonymous>)
      at appendChildren (https://deno.land/x/nano_jsx@v0.0.33/core.ts:41:12)
      at h (https://deno.land/x/nano_jsx@v0.0.33/core.ts:286:3)
`BatchError` is a class, not a type. This commit fixes the re-export.
Copy link

coderabbitai bot commented Feb 4, 2024

Walkthrough

The recent modifications streamline the export process of types within modules and refine the functionality of buffer management. By shifting from individual type exports to module-level exports, the changes enhance code maintainability and readability. Additionally, the adjustment in buffer options and behavior during BufReadCmd events simplifies buffer content restoration, focusing on a more efficient handling of buffer states.

Changes

File(s) Change Summary
argument/mod.ts, mod.ts Transitioned from exporting individual types to exporting entire modules, including types. Removed unrelated code comments.
buffer/buffer.ts Removed buftype, swapfile, modifiable options and adjusted synchronous buffer content restoration on BufReadCmd.

🐰✨
Changes afoot, in code, we trust,
Modules and buffers, adjust we must.
From exports broad to buffers lean,
A rabbit's touch, in code, is seen. 🌟📜

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

There are 3 ways to chat with CodeRabbit:

  • Review comments: Directly reply to a review comment made by CodeRabbit. Example:
    • I pushed a fix in commit <commit_id>.
    • Generate unit-tests for this file.
  • 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 tests 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 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 and a 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. 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 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

codecov bot commented Feb 4, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (a7ea418) 82.91% compared to head (9014dca) 82.91%.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #232   +/-   ##
=======================================
  Coverage   82.91%   82.91%           
=======================================
  Files          48       48           
  Lines        2658     2658           
  Branches      232      232           
=======================================
  Hits         2204     2204           
  Misses        454      454           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

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 a7ea418 and 9014dca.
Files selected for processing (3)
  • argument/mod.ts (3 hunks)
  • buffer/buffer.ts (1 hunks)
  • mod.ts (1 hunks)
Files skipped from review due to trivial changes (1)
  • argument/mod.ts
Additional comments: 2
mod.ts (1)
  • 62-67: The export statement correctly uses TypeScript's type keyword for type-only imports, aligning with best practices for type exporting. This change simplifies the import process for users.
buffer/buffer.ts (1)
  • 388-393: > 📝 NOTE

This review was outside the diff hunks, and no overlapping diff hunk was found. Original lines [1-1]

Ensure that the removal of specific options (buftype, swapfile, modifiable) and the synchronous restoration of buffer content on BufReadCmd are correctly implemented and documented, as these changes are crucial for the functionality and usability of buffer.concrete.

@lambdalisue lambdalisue merged commit 26d4c7e into main Feb 4, 2024
16 checks passed
@lambdalisue lambdalisue deleted the fix-docs branch February 4, 2024 06:22
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.

None yet

1 participant