feat: implement shebang and comment-based language detection#1258
Open
Divyapahuja31 wants to merge 4 commits intoshikijs:mainfrom
Open
feat: implement shebang and comment-based language detection#1258Divyapahuja31 wants to merge 4 commits intoshikijs:mainfrom
Divyapahuja31 wants to merge 4 commits intoshikijs:mainfrom
Conversation
✅ Deploy Preview for shiki-next ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for shiki-matsu ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1258 +/- ##
==========================================
+ Coverage 89.53% 89.71% +0.17%
==========================================
Files 79 79
Lines 3479 3519 +40
Branches 1009 1024 +15
==========================================
+ Hits 3115 3157 +42
+ Misses 328 326 -2
Partials 36 36 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
1 task
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Description
This PR implements robust, content-aware language detection in
guessEmbeddedLanguagesand integrates it into the Shiki CLI.What is this solving?
Currently, Shiki's language auto-detection is primarily restricted to explicit markdown fences (
`js) or specific HTML attributes. This makes it difficult to provide accurate highlighting for:deployorrunthat rely on shebangs.stdin): Code piped directly into the CLI (cat file | shiki) where no filename exists.<!-- language: lang-js -->.Why is this needed?
To provide a "magic" out-of-the-box experience, especially for the CLI tool (
skat). This PR allows Shiki to identify the language by inspecting the actual content header and common developer annotations, reducing the need for manual--langoverrides.Changes:
#!lines. It accurately handles standard paths (/bin/bash), environment-based resolution (/usr/bin/env node), and complexenv -Sflags (e.g.,ts-node).@langannotations.@shikijs/clito useguessEmbeddedLanguagesas a fallback forstdinand files with unknown extensions.Linked Issues
This is a feature enhancement for the core utility and CLI.
Additional context
Reviewers may want to focus on the
env -Sparsing logic inpackages/core/src/utils/strings.ts. It's designed to skip common environment flags to find the actual executable name (e.g., identifyingts-nodein#!/usr/bin/env -S ts-node --foo).I have included 7 new unit tests in
packages/core/src/utils/strings.test.tscovering these new detection patterns to ensure stability.