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

feat: add shiki #319

Merged
merged 1 commit into from
Nov 7, 2024
Merged

feat: add shiki #319

merged 1 commit into from
Nov 7, 2024

Conversation

lbb00
Copy link
Contributor

@lbb00 lbb00 commented Nov 7, 2024

Add shiki

Shikiji is shikijs/shiki#557 to Shiki! This repository is now archived. Please continue at shikijs/shiki.

Summary by CodeRabbit

  • New Features
    • Introduced a new dependency for enhanced syntax highlighting and code formatting capabilities.

Copy link

coderabbitai bot commented Nov 7, 2024

Walkthrough

The pull request introduces a new dependency, shiki, to the package.json file. This dependency is specified with a version of "*", allowing for any version to be utilized. The change is focused solely on enhancing the project's capabilities related to syntax highlighting or code formatting, with no modifications made to existing dependencies or project configurations.

Changes

File Change Summary
package.json Added dependency: `"shiki": { "version": "*"}"

Possibly related PRs

Poem

In the garden of code, a new friend does bloom,
shiki arrives, dispelling the gloom.
With colors that dance, and syntax so bright,
Our scripts now will sparkle, a beautiful sight!
Hopping along, let’s celebrate this cheer,
For every new package brings joy, never fear! 🐇✨


📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL

📥 Commits

Reviewing files that changed from the base of the PR and between 0129930 and c57dcc8.

📒 Files selected for processing (1)
  • package.json (1 hunks)
🔇 Additional comments (1)
package.json (1)

15330-15332: ⚠️ Potential issue

Consider pinning the shiki version instead of using "*"

Using "*" for the version allows any version to be installed which could lead to:

  1. Breaking changes from major version updates
  2. Security vulnerabilities from untested versions
  3. Inconsistent behavior across different installations

Recommend explicitly pinning to a specific version:

    "shiki": {
-      "version": "*"
+      "version": "1.1.7"
    },

Let's verify the package authenticity and maintenance:

✅ Verification successful

Consider pinning shiki to version 1.22.2

The package is actively maintained with:

  • Latest stable version 1.22.2 released a week ago
  • Over 10k GitHub stars
  • Regular updates (last updated Nov 7, 2024)
  • Trusted maintainers including Anthony Fu and the Shiki team
  • MIT licensed with clean dependency tree
    "shiki": {
-      "version": "*"
+      "version": "1.22.2"
    },
🏁 Scripts executed

The following scripts were executed for the analysis:

Script:

#!/bin/bash
# Description: Verify shiki package details and activity
# Test: Check npm package info and GitHub activity
npm view shiki

# Verify GitHub activity on new maintained repo
gh api \
  -H "Accept: application/vnd.github+json" \
  repos/shikijs/shiki | jq '{stars:.stargazers_count,updated:.updated_at,issues:.open_issues_count}'

Length of output: 1258


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>, 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 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.

Copy link

sweep-ai bot commented Nov 7, 2024

Hey @lbb00, here is an example of how you can ask me to improve this pull request:

@Sweep Add unit tests for the Shiki integration to verify:
1. Code highlighting works correctly for different programming languages
2. Syntax highlighting can be applied to code blocks
3. Error handling when invalid language or code is provided

📖 For more information on how to use Sweep, please read our documentation.

@fengmk2 fengmk2 merged commit 9eb0bb4 into cnpm:master Nov 7, 2024
4 checks passed
fengmk2 pushed a commit that referenced this pull request Nov 7, 2024
[skip ci]

## [1.143.0](v1.142.0...v1.143.0) (2024-11-07)

### Features

* add shiki ([#319](#319)) ([9eb0bb4](9eb0bb4))
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.

2 participants