☕ Refine JSR exports

[lambdalisue]

SSIA

Summary by CodeRabbit

• New Features

  • Enhanced module export capabilities with multiple entry points for easier access.

• Bug Fixes

  • Updated import paths for error handling to reflect new file names.

• Refactor

  • Restructured module organization for better clarity and management of exports.

[coderabbitai]

Caution

Review failed

The pull request is closed.

Walkthrough

The changes introduced enhance the modular structure of the @denops/core package. The exports field in deno.jsonc has been transformed into an object, enabling multiple entry points for improved usability. Additionally, references in mod.ts and error_test.ts have been updated to reflect new file naming conventions, streamlining imports while retaining existing functionality.

Changes

Files	Change Summary
deno.jsonc, mod.ts	Updated exports from a string to an object with multiple entry points; modified file references for error handling and type exports.
error_test.ts	Changed import path for BatchError from ./errors.ts to ./error.ts, reflecting the updated module structure.

Sequence Diagram(s)

sequenceDiagram
    participant Consumer
    participant Module
    Consumer->>Module: Import from "./mod.ts"
    Module->>Module: Resolve exports
    Module->>Consumer: Provide access to "./type" and "./error"

Loading

🐇 "In the meadow where changes bloom,
New paths arise, dispelling gloom.
With exports clear and names anew,
Jumping joyfully, we bid adieu!
Hops and skips in code we trust,
A brighter future, it's a must!" 🌼

---

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
• Mastodon
• Reddit
• LinkedIn

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 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 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 for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 59281d5 and 5342df7.

Files selected for processing (3)

• deno.jsonc (1 hunks)
• error_test.ts (1 hunks)
• mod.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• error_test.ts
• mod.ts

Additional comments not posted (4)

deno.jsonc (4)

4-4: LGTM! The change to an object for the exports field is appropriate.

This modification is necessary to support multiple entry points and enhances the module's export capabilities.

---

5-5: LGTM! The default export mapping is correct.

Mapping the default export to ./mod.ts maintains backward compatibility.

---

6-6: LGTM! The additional export for ./type is correct.

This change improves modularity and usability by allowing more granular access to the type module.

---

7-7: LGTM! The additional export for ./error is correct.

This change improves modularity and usability by allowing more granular access to the error module.

[coderabbitai]

Actionable comments posted: 0

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 5342df7 and 4aae5ba.

Files selected for processing (3)

• deno.jsonc (1 hunks)
• error_test.ts (2 hunks)
• mod.ts (1 hunks)

Files skipped from review due to trivial changes (2)

• error_test.ts
• mod.ts

Files skipped from review as they are similar to previous changes (1)

• deno.jsonc

[Milly]

LGTM

[Milly]

Should we change jsr:@denops/core to jsr:@denops/core/type in these examples?

deno-denops-core/README.md

Lines 15 to 21 in 4aae5ba

	```ts
	import type { Entrypoint } from "jsr:@denops/core";
	export const main: Entrypoint = (denops) => {
	// ...
	};
	```

deno-denops-core/mod.ts

Lines 11 to 17 in 4aae5ba

	* ```ts
	* import type { Entrypoint } from "jsr:@denops/core";
	*
	* export const main: Entrypoint = (denops) => {
	* // ...
	* };
	* ```

deno-denops-core/type.ts

Lines 139 to 144 in 4aae5ba

	* ```ts
	* import type { Entrypoint } from "jsr:@denops/core";
	*
	* export const main: Entrypoint = (denops) => {
	* // ...
	* }

deno-denops-core/type.ts

Lines 150 to 161 in 4aae5ba

	* ```ts
	* import type { Entrypoint } from "jsr:@denops/core";
	*
	* export const main: Entrypoint = (denops) => {
	* // ...
	* return {
	* [Symbol.asyncDispose]: async () => {
	* // Dispose resources...
	* }
	* }
	* }
	* ```

[lambdalisue]

I think it's OK to keep the current example code while most of developers should NOT use @denops/core anyway.