fix(sh): exclude `ShellSession` language #416

nwalters512 · 2025-03-28T18:37:33Z

Closes #415.

Per the request from #415 (comment), I also updated linguist-languages.

Summary by CodeRabbit

New Features
- Improved language customization now offers enhanced filtering options to tailor which languages are displayed.
Chores
- Upgraded the linguist-languages dependency to the latest version for potential bug fixes and improvements.
- Added a new entry for the exclusion of the ShellSession language in the prettier-plugin-sh.

changeset-bot · 2025-03-28T18:37:36Z

⚠️ No Changeset found

Latest commit: f462fe9

Merging this PR will not cause a version bump for any packages. If these changes should not result in a new version, you're good to go. If these changes should result in a version bump, you need to add a changeset.

This PR includes no changesets

When changesets are added to this PR, you'll see the packages that this PR includes changesets for and the associated semver types

Click here to learn what changesets are, and how to add one.

Click here if you're a maintainer who wants to add a changeset to this PR

coderabbitai · 2025-03-28T18:37:41Z

Walkthrough

This pull request updates the linguist-languages dependency in the project and refactors the language support functionality. In the package.json file, the dependency version is bumped from ^7.27.0 to ^7.29.0. In scripts/languages.ts, the function getSupportLanguages is renamed to getSupportedLanguages and its signature is extended to include an optional parameter excludeNames for filtering out specific languages. These changes propagate to all relevant modules invoking this function.

Changes

File(s)	Change Summary
`package.json`	Updated `linguist-languages` dependency from `^7.27.0` to `^7.29.0`.
`scripts/languages.ts` (and references in autocorrect, sh, sql, toml)	Renamed `getSupportLanguages` to `getSupportedLanguages`, added an optional `excludeNames` parameter, and introduced exclusion logic (notably for the sh language export).

Sequence Diagram(s)

sequenceDiagram
    participant Caller
    participant LanguageFunc as getSupportedLanguages

    Caller->>LanguageFunc: Call with (parser, aceModes, [excludeNames?])
    alt excludeNames provided
        LanguageFunc->>LanguageFunc: Check if current language exists in excludeNames
        LanguageFunc-->>LanguageFunc: Skip languages listed in excludeNames
    else No exclusion list
        LanguageFunc->>LanguageFunc: Process all supported languages
    end
    LanguageFunc-->>Caller: Return filtered list of languages

Assessment against linked issues

Objective	Addressed	Explanation
prettier-plugin-sh should ignore ShellSession blocks in console output [#415]	✅

Poem

I'm a coding rabbit, nimble on my feet,
Hopping through dependencies, making our code neat.
Functions renamed and filters set to steer,
Excluding unwanted names with a joyful cheer.
Celebrate the changes—hoppy code year to year! 🐰

📜 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 f462fe9 and c5e8e45.

📒 Files selected for processing (1)

.changeset/light-pots-remain.md (1 hunks)

✅ Files skipped from review due to trivial changes (1)

.changeset/light-pots-remain.md

⏰ Context from checks skipped due to timeout of 90000ms (1)

GitHub Check: Codacy Static Code Analysis

🪧 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 plan to trigger planning for file edits and PR creation.
@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.

codesandbox-ci · 2025-03-28T18:38:00Z

This pull request is automatically built and testable in CodeSandbox.

To see build info of the built libraries, click here or the icon next to each commit SHA.

socket-security · 2025-03-28T18:38:11Z

New, updated, and removed dependencies detected. Learn more about Socket for GitHub ↗︎

Package	New capabilities	Transitives	Size	Publisher
npm/lodash@4.17.21	None	`0`	1.41 MB	bnjmnt4n

🚮 Removed packages: npm/common-tags@1.8.2, npm/github-markdown-css@5.4.0

View full report↗︎

nwalters512 added 2 commits March 28, 2025 11:33

fix(sh): exclude ShellSession language

1f7ad32

chore(deps): update linguist-languages

f462fe9

JounQin approved these changes Mar 28, 2025

View reviewed changes

Create light-pots-remain.md

c5e8e45

nwalters512 mentioned this pull request Mar 28, 2025

Format sh files PrairieLearn/PrairieLearn#11641

Merged

JounQin merged commit 82835c7 into un-ts:master Mar 28, 2025
17 of 18 checks passed

JounQin mentioned this pull request Mar 28, 2025

chore: release package(s) #417

Merged

nwalters512 deleted the prettier-sh-exclude-shell-session branch March 28, 2025 19:59

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

Uh oh!

fix(sh): exclude `ShellSession` language #416

fix(sh): exclude `ShellSession` language #416

Uh oh!

nwalters512 commented Mar 28, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

changeset-bot bot commented Mar 28, 2025

Uh oh!

coderabbitai bot commented Mar 28, 2025 •

edited

Loading

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

codesandbox-ci bot commented Mar 28, 2025 •

edited

Loading

Uh oh!

socket-security bot commented Mar 28, 2025 •

edited

Loading

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(sh): exclude ShellSession language #416

fix(sh): exclude ShellSession language #416

Uh oh!

Conversation

nwalters512 commented Mar 28, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Summary by CodeRabbit

Uh oh!

changeset-bot bot commented Mar 28, 2025

⚠️ No Changeset found

Uh oh!

coderabbitai bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Walkthrough

Changes

Sequence Diagram(s)

Assessment against linked issues

Poem

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

codesandbox-ci bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

socket-security bot commented Mar 28, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Uh oh!

Uh oh!

fix(sh): exclude `ShellSession` language #416

fix(sh): exclude `ShellSession` language #416

nwalters512 commented Mar 28, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Mar 28, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

codesandbox-ci bot commented Mar 28, 2025 •

edited

Loading

socket-security bot commented Mar 28, 2025 •

edited

Loading