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: Bash support #2532

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

feat: Bash support #2532

wants to merge 6 commits into from

Conversation

jtbr
Copy link
Contributor

@jtbr jtbr commented Jun 27, 2024

support for bash shell scripting language

I think the only tag type applicable to scripts is function definitions; tree-sitter is all new to me so might want to have a look over that.

Also, while bash scripts commonly end in .sh, they often have no file extension, but are instead identified by the file beginning with #!/bin/bash, #!/bin/sh or similar (they are also normally marked as executable). Not sure if there is any way to support looking for these attributes instead of just the filename.

Summary by CodeRabbit

  • New Features
    • Added support for Bash scripting, allowing users to leverage Bash-specific configurations and syntax highlighting.
    • Updated documentation to reflect the addition of Bash support since version 0.14.0.

Copy link
Contributor

coderabbitai bot commented Jun 28, 2024

Walkthrough

The recent changes introduce support for Bash scripting into the Tabby project. Enhancements include updating configuration files to recognize Bash language, adding a relevant parser dependency, defining function structures, and updating documentation to reflect the newfound support. This integration allows for better handling and parsing of Bash scripts within the Tabby ecosystem.

Changes

Files Change Summary
crates/tabby-common/assets/languages.toml Updated to include top-level keywords specific to Bash scripting.
crates/tabby-scheduler/Cargo.toml Added tree-sitter-bash dependency.
crates/tabby-scheduler/queries/bash.scm Introduced function definition structure in a Scheme file.
crates/tabby-scheduler/src/code/languages.rs Added configuration for the Bash language using tree-sitter-bash in the lazy static block.
website/docs/programming-languages.md Updated documentation to reflect Bash support since version 0.14.0.

Poem

Beneath the stars, where scripts do splash,
Now supports the tongue they call Bash.
With keywords keen and functions clear,
Our code it reads without a sneer.
Documentation sings its name,
In Tabby’s heart, Bash finds its fame.
🐇✨


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>.
    • 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 Configration 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
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

Review details

Configuration used: CodeRabbit UI
Review profile: CHILL

Commits

Files that changed from the base of the PR and between 24af7a1 and e02fffd.

Files selected for processing (5)
  • crates/tabby-common/assets/languages.toml (1 hunks)
  • crates/tabby-scheduler/Cargo.toml (1 hunks)
  • crates/tabby-scheduler/queries/bash.scm (1 hunks)
  • crates/tabby-scheduler/src/code/languages.rs (1 hunks)
  • website/docs/programming-languages.md (1 hunks)
Files skipped from review due to trivial changes (2)
  • crates/tabby-scheduler/Cargo.toml
  • crates/tabby-scheduler/src/code/languages.rs
Additional context used
LanguageTool
website/docs/programming-languages.md

[style] ~7-~7: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ...Languages Most models nowadays support a large number of programming languages (thanks to [The S...

(LARGE_NUMBER_OF)


[uncategorized] ~34-~34: A punctuation mark might be missing here.
Context: ...om/) * PHP * C# * Solidity: Si...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~37-~37: A punctuation mark might be missing here.
Context: ...Dart: Since v0.12.0 * Lua: Since v0.14.0...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

Markdownlint
website/docs/programming-languages.md

20-20: null
Bare URL used

(MD034, no-bare-urls)


12-12: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


16-16: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (3)
crates/tabby-scheduler/queries/bash.scm (1)

2-2: Correct implementation of tree-sitter query for Bash function definitions.

This query correctly captures function definitions in Bash scripts, which is essential for the new Bash support.

website/docs/programming-languages.md (1)

39-39: Update to supported languages list to include Bash.

The addition of Bash to the list of supported languages is accurately documented, reflecting the changes made in this PR.

crates/tabby-common/assets/languages.toml (1)

319-349: Proper configuration for Bash language support.

The settings for the Bash language, including file extensions and top-level keywords, are correctly specified and appropriate for Bash scripting.

website/docs/programming-languages.md Show resolved Hide resolved
@wsxiaoys
Copy link
Member

it seems the test if failing

Duplicate extension found: sh

Could you try fix it? maybe it's a configuratiohn mistake in config.toml

Copy link
Contributor

@coderabbitai coderabbitai bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

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 e02fffd and b30abe7.

Files ignored due to path filters (1)
  • Cargo.lock is excluded by !**/*.lock
Files selected for processing (2)
  • crates/tabby-common/assets/languages.toml (2 hunks)
  • website/docs/programming-languages.md (1 hunks)
Files skipped from review as they are similar to previous changes (1)
  • crates/tabby-common/assets/languages.toml
Additional context used
LanguageTool
website/docs/programming-languages.md

[style] ~7-~7: Specify a number, remove phrase, or simply use “many” or “numerous”
Context: ...Languages Most models nowadays support a large number of programming languages (thanks to [The S...

(LARGE_NUMBER_OF)


[uncategorized] ~34-~34: A punctuation mark might be missing here.
Context: ...om/) * PHP * C# * Solidity: Si...

(AI_EN_LECTOR_MISSING_PUNCTUATION)


[uncategorized] ~37-~37: A punctuation mark might be missing here.
Context: ...Dart: Since v0.12.0 * Lua: Since v0.14.0...

(AI_EN_LECTOR_MISSING_PUNCTUATION)

Markdownlint
website/docs/programming-languages.md

20-20: null
Bare URL used

(MD034, no-bare-urls)


12-12: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)


16-16: null
Emphasis used instead of a heading

(MD036, no-emphasis-as-heading)

Additional comments not posted (1)
website/docs/programming-languages.md (1)

39-39: Ensure consistency in punctuation for language listings.

The entries for Lua and Bash are missing colons after the language name, which is inconsistent with other entries.

- * [Lua](https://www.lua.org): Since v0.14.0
+ * [Lua](https://www.lua.org): Since v0.14.0:

- * [Bash / shellscript](https://www.gnu.org/software/bash/): Since v0.14.0
+ * [Bash / shellscript](https://www.gnu.org/software/bash/): Since v0.14.0:

@jtbr
Copy link
Contributor Author

jtbr commented Jun 28, 2024

seems to be some issue with the tests.. not sure how any of that works...

@wsxiaoys
Copy link
Member

Then it seems the tree-sitter-bash implementation is somewhat broken and caused the breakage?

@jtbr
Copy link
Contributor Author

jtbr commented Jul 3, 2024

Could be wrong, but I don't think it's the library. The test fails at:

code::intelligence::tests::test_create_source_file

It seems that some test suite does not know how to create a test file in the bash scripting language. I don't know anything about this test suite though.

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.

None yet

2 participants