feat: use ylru@2

[fengmk2]

Summary by CodeRabbit

• New Features

  • Added an official MIT License to clarify usage rights.

• Documentation

  • Updated project documentation with fresh badges and new sections highlighting licensing details and contributor information.

• Chores

  • Streamlined internal build processes and configuration settings for improved maintainability.

[coderabbitai]

Walkthrough

This update introduces a new LICENSE file containing the MIT License and updates the documentation in README.md with additional badges and sections. Package configuration in package.json has been revised with dependency updates, modified scripts, and a new module field. Additionally, the import syntax in src/index.ts has been adjusted, and tsconfig.json has been simplified by removing detailed compiler options, retaining only the extends directive.

Changes

File(s)	Summary
LICENSE	Added new LICENSE file containing the MIT License text.
README.md	Added three badges at the top and two new sections ("License" and "Contributors") at the document's end.
package.json	Updated scripts (e.g., test, clean, pretest, ci, postci, preci), upgraded several dependency versions, and added a new "module": "./dist/esm/index.js" field.
src/index.ts	Changed the import statement for the LRU class from a default import to a named import.
tsconfig.json	Removed the compilerOptions section which included strict settings, leaving only the extends directive referencing @eggjs/tsconfig.

Sequence Diagram(s)

Loading

sequenceDiagram
    participant Dev as Developer
    participant NPM as npm Scripts
    participant Clean as Clean Task
    participant Lint as Lint Task
    participant Test as Test Runner (egg-bin test)

    Dev->>NPM: Run test command
    NPM->>Clean: Execute clean script
    Clean-->>NPM: Clean complete
    NPM->>Lint: Execute lint with fix (from pretest)
    Lint-->>NPM: Linting complete
    NPM->>Test: Run egg-bin test
    Test-->>NPM: Return test results
    NPM-->>Dev: Output test results

Poem

I'm a hopping rabbit, bright and keen,
Updating projects with a swift machine.
A license, some badges, and scripts aligned,
With cleaner code and imports redefined.
I nibble on bugs, in a garden so green!

Warning

There were issues while running some tools. Please review the errors and either fix the tool’s configuration or disable the tool if it’s a critical failure.

🔧 ESLint

If the error stems from missing dependencies, add them to the package.json file. For unrecoverable errors (e.g., due to private dependencies), disable the tool in the CodeRabbit configuration.

src/index.ts

Oops! Something went wrong! :(

ESLint: 8.57.1

ESLint couldn't find the plugin "eslint-plugin-eggache".

(The package "eslint-plugin-eggache" was not found when loaded as a Node module from the directory "".)

It's likely that the plugin isn't installed correctly. Try reinstalling by running the following:

npm install eslint-plugin-eggache@latest --save-dev

The plugin "eslint-plugin-eggache" was referenced from the config file in ".eslintrc » eslint-config-egg/typescript » ./index.js".

If you still can't figure out the problem, please stop by https://eslint.org/chat/help to chat with the team.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 3c86268 and 4e1b56a.

📒 Files selected for processing (5)

• LICENSE (1 hunks)
• README.md (2 hunks)
• package.json (2 hunks)
• src/index.ts (1 hunks)
• tsconfig.json (1 hunks)

🔇 Additional comments (11)

LICENSE (1)

1-22: MIT License File Integrity: The new LICENSE file correctly contains the full MIT License text with all required clauses. The formatting and content are accurate and clear.

tsconfig.json (1)

1-4: Simplified TypeScript Configuration: The tsconfig file now relies solely on the "extends": "@eggjs/tsconfig" directive. This simplification aligns with the updated standards introduced by the new tsconfig package version.

src/index.ts (2)

1-3: Updated Import for LRU: Changing the import from a default to a named import (import { LRU } from 'ylru';) is consistent with the new version of the package. Please verify that the package version ^2.0.0 indeed exports LRU as a named export.

---

4-16: Cache Usage and Function Implementation:

• The cache (typeLRUCache) is initialized on first use, which is appropriate for performance optimization.
• The getType function correctly checks for a cached value before calling mimeTypes.contentType(type), and then caches the result.
  Overall, the implementation is clear and effective.

README.md (3)

8-10: Enhanced Badge Information:
The newly added badges for Node.js Version, PRs Welcome, and CodeRabbit Pull Request Reviews enrich the README, improving project visibility and community engagement.

---

38-41: License Section Addition:
Linking to the LICENSE file in the newly added License section is a best practice that clearly communicates the project's licensing terms.

---

42-47: Contributors Section Addition:
The inclusion of a Contributors section (with a badge linking to the contributors graph) is a valuable update for acknowledging community efforts.

package.json (4)

8-17: Script Enhancements and Workflow Improvements:
New scripts such as clean, pretest, preci, ci, and postci have been added, which streamline the build, linting, testing, and prepublish processes. These improvements will help maintain code quality and project hygiene.

---

18-21: Dependency Version Update for ylru:
The update of "ylru": "^2.0.0" is critical to align with the changes in the import syntax in src/index.ts. Please ensure that this update does not introduce any breaking changes in cache behavior.

---

22-34: DevDependencies Upgrade Validation:
Upgrading devDependencies (e.g., @eggjs/tsconfig to "2", @types/node to "^22", and typescript to "5") is significant. It is important to confirm that the new versions work harmoniously within your build and test environments.

---

70-73: Modern Module Entry Points:
The explicit declaration of the "main", "types", and "module" fields ensures clear resolution paths for both CommonJS and ESM consumers. This configuration is aligned with modern package distribution practices.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 generate docstrings to generate docstrings for this 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 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.

[socket-security]

Updated and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/@types/node@20.17.24 ➜ 22.13.10	None	+1	2.4 MB	types
npm/eslint-config-egg@13.1.0 ➜ 14.1.0	Transitive: environment, eval, filesystem, unsafe	+176	18.9 MB	fengmk2
npm/mm@3.4.0 ➜ 4.0.2	None	+3	261 kB	fengmk2
npm/tshy@1.18.0 ➜ 3.0.2	environment, filesystem, shell Transitive: unsafe	+56	4.96 MB	isaacs
npm/ylru@1.4.0 ➜ 2.0.0	None	0	26.3 kB	fengmk2

🚮 Removed packages: npm/@eggjs/tsconfig@1.3.3, npm/egg-bin@6.13.0

View full report↗︎

[Copilot]

Pull Request Overview

This PR upgrades the project to use ylru@2 while adding new badges and documentation updates to the README.

• Updated README badges and license/contributors section
• Changed the import statement for ylru in src/index.ts to match the new package API

Reviewed Changes

Copilot reviewed 5 out of 5 changed files in this pull request and generated no comments.

File	Description
README.md	Added new badges and updated documentation sections
src/index.ts	Updated the import statement for ylru to match v2 API

Comments suppressed due to low confidence (1)

src/index.ts:2

• Verify that switching from a default to a named import matches the new API in ylru@2. Ensure that all usages of LRU are updated accordingly as per the updated package documentation.

import { LRU } from 'ylru';