docs: Adds instructions for using syntax highlighting with lazy.nvim by fonors · Pull Request #3246 · snakemake/snakemake

fonors · 2025-01-08T13:10:43Z

This PR adds instructions for loading the Snakemake syntax highlighting using Neovim with lazy.nvim.
It only affects the documentation.

QC

The PR contains a test case for the changes or the changes are already covered by an existing test case.
The documentation (docs/) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).

Summary by CodeRabbit

Documentation
- Updated Vim plugin installation instructions for Snakemake syntax highlighting.
- Added new installation method using lazy.nvim plugin manager.
- Enhanced configuration guide for Snakemake syntax highlighting.

coderabbitai · 2025-01-08T13:10:52Z

📝 Walkthrough

Walkthrough

This pull request updates the Vim README documentation to include a new installation method for the Snakemake syntax highlighting using the lazy.nvim plugin manager. The addition provides a Lua configuration snippet that demonstrates how to set up the Snakemake syntax highlighting plugin, specifically detailing the file type configuration, plugin path appending, and initialization process.

Changes

File	Change Summary
`misc/vim/README.md`	Added lazy.nvim installation method with Lua configuration for Snakemake syntax highlighting

Sequence Diagram

sequenceDiagram
    participant User
    participant lazy.nvim
    participant Snakemake Plugin
    
    User->>lazy.nvim: Configure plugin
    lazy.nvim->>Snakemake Plugin: Load plugin
    Snakemake Plugin->>User: Append runtime path
    Snakemake Plugin->>User: Detect file type

Possibly related PRs

feat: Add commentstring for vim plugin #3104: Addition of a commentstring for Snakemake files in Vim, enhancing plugin functionality

Suggested reviewers

fgvieira
johanneskoester

📜 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 6750ae8 and 7fae584.

📒 Files selected for processing (1)

misc/vim/README.md (1 hunks)

🚧 Files skipped from review as they are similar to previous changes (1)

misc/vim/README.md

Finishing Touches

📝 Generate Docstrings

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 generate docstrings to generate docstrings for this PR. (Beta)
@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.

coderabbitai

Actionable comments posted: 0

🧹 Nitpick comments (1)

misc/vim/README.md (1)
17-30: Indent the code block to match markdown style.

The fenced code block should be indented to maintain consistency with markdown style guidelines.

Apply this formatting:
-``` lua
-return {
-  {
+    ``` lua
+    return {
+      {
🧰 Tools

🪛 Markdownlint (0.37.0)

17-17: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

📜 Review details

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

📥 Commits

Reviewing files that changed from the base of the PR and between 7995b11 and 38bb1f1.

📒 Files selected for processing (1)

misc/vim/README.md (1 hunks)

🧰 Additional context used

🪛 Markdownlint (0.37.0)

misc/vim/README.md

17-17: Expected: indented; Actual: fenced
Code block style

(MD046, code-block-style)

🔇 Additional comments (2)

misc/vim/README.md (2)

18-29: LGTM! The lazy.nvim configuration is well-structured.

The configuration follows lazy.nvim's best practices:

Lazy loads on Snakemake file type

Correctly sets up runtime path

Properly initializes file type detection

15-16: LGTM! Documentation maintains consistency.

The new section follows the established documentation pattern and maintains consistency with other plugin manager sections.

sonarqubecloud · 2025-01-08T23:36:55Z

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
0.0% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud

fonors · 2025-01-15T11:57:34Z

@johanneskoester upon further inspection, the syntax highlighting does not working using the standard tab formatting the project uses for Markdown files. Should a change be made to either remove the lua part or to replace tabs with only the backticks?

🤖 I have created a release *beep* *boop* --- ## [8.28.0](v8.27.1...v8.28.0) (2025-02-12) ### Features * do not fail if --cache is active but no SNAKEMAKE_OUTPUT_CACHE env var is defined. Instead, print a warning that explains the options. ([#3270](#3270)) ([9610f7c](9610f7c)) ### Bug Fixes * do not use outdated metadata for rerun triggers (only warn about it) ([#3259](#3259)) ([d766a48](d766a48)) * ensure that exceptions print storage queries instead of local copies of remote files ([#3258](#3258)) ([e5d8ec1](e5d8ec1)) * fix error message of evaluate helper function ([#3282](#3282)) ([9483a64](9483a64)) * Revert cleaning of env vars in apptainer ([#3285](#3285)) ([e79a51b](e79a51b)) ### Performance Improvements * compare checksums of input files <= 1MB (before (10KB) ([#3267](#3267)) ([ba017bb](ba017bb)) * query updated input files in parallel ([#3266](#3266)) ([bc4fcee](bc4fcee)) ### Documentation * Adds instructions for using syntax highlighting with lazy.nvim ([#3246](#3246)) ([7a75043](7a75043)) * Fix typos in basic API example ([#3277](#3277)) ([8782219](8782219)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

…nakemake#3246) This PR adds instructions for loading the Snakemake syntax highlighting using Neovim with lazy.nvim. It only affects the documentation. ### QC  * [ ] The PR contains a test case for the changes or the changes are already covered by an existing test case. * [x] The documentation (`docs/`) is updated to reflect the changes or this is not necessary (e.g. if the change does neither modify the language nor the behavior or functionalities of Snakemake).  ## Summary by CodeRabbit - **Documentation** - Updated Vim plugin installation instructions for Snakemake syntax highlighting. - Added new installation method using lazy.nvim plugin manager. - Enhanced configuration guide for Snakemake syntax highlighting.

🤖 I have created a release *beep* *boop* --- ## [8.28.0](snakemake/snakemake@v8.27.1...v8.28.0) (2025-02-12) ### Features * do not fail if --cache is active but no SNAKEMAKE_OUTPUT_CACHE env var is defined. Instead, print a warning that explains the options. ([snakemake#3270](snakemake#3270)) ([9610f7c](snakemake@9610f7c)) ### Bug Fixes * do not use outdated metadata for rerun triggers (only warn about it) ([snakemake#3259](snakemake#3259)) ([d766a48](snakemake@d766a48)) * ensure that exceptions print storage queries instead of local copies of remote files ([snakemake#3258](snakemake#3258)) ([e5d8ec1](snakemake@e5d8ec1)) * fix error message of evaluate helper function ([snakemake#3282](snakemake#3282)) ([9483a64](snakemake@9483a64)) * Revert cleaning of env vars in apptainer ([snakemake#3285](snakemake#3285)) ([e79a51b](snakemake@e79a51b)) ### Performance Improvements * compare checksums of input files <= 1MB (before (10KB) ([snakemake#3267](snakemake#3267)) ([ba017bb](snakemake@ba017bb)) * query updated input files in parallel ([snakemake#3266](snakemake#3266)) ([bc4fcee](snakemake@bc4fcee)) ### Documentation * Adds instructions for using syntax highlighting with lazy.nvim ([snakemake#3246](snakemake#3246)) ([7a75043](snakemake@7a75043)) * Fix typos in basic API example ([snakemake#3277](snakemake#3277)) ([8782219](snakemake@8782219)) --- This PR was generated with [Release Please](https://github.com/googleapis/release-please). See [documentation](https://github.com/googleapis/release-please#release-please). Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>

fonors requested a review from johanneskoester as a code owner January 8, 2025 13:10

coderabbitai bot reviewed Jan 8, 2025

View reviewed changes

fonors changed the title ~~Adds instructions for using syntax highlighting with lazy.nvim~~ docs: Adds instructions for using syntax highlighting with lazy.nvim Jan 8, 2025

fonors and others added 2 commits January 8, 2025 23:36

Adds instructions for using syntax highlighting with lazy.nvim

0d3880f

Fix identation on lazy.nvim plugin instructions

7fae584

fonors force-pushed the main branch from 6750ae8 to 7fae584 Compare January 8, 2025 23:36

johanneskoester approved these changes Jan 15, 2025

View reviewed changes

johanneskoester merged commit 7a75043 into snakemake:main Jan 15, 2025

github-actions bot mentioned this pull request Jan 15, 2025

chore(main): release 8.28.0 #3255

Merged

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

docs: Adds instructions for using syntax highlighting with lazy.nvim#3246

docs: Adds instructions for using syntax highlighting with lazy.nvim#3246
johanneskoester merged 2 commits intosnakemake:mainfrom
fonors:main

fonors commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

Uh oh!

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested reviewers

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (`.coderabbit.yaml`)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Uh oh!

sonarqubecloud bot commented Jan 8, 2025

Uh oh!

fonors commented Jan 15, 2025 •

edited

Loading

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

Conversation

fonors commented Jan 8, 2025 • edited by coderabbitai bot Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

QC

Summary by CodeRabbit

Uh oh!

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

Uh oh!

Walkthrough

Changes

Sequence Diagram

Possibly related PRs

Suggested reviewers

Finishing Touches

Chat

CodeRabbit Commands (Invoked using PR comments)

Other keywords and placeholders

CodeRabbit Configuration File (.coderabbit.yaml)

Documentation and Community

Uh oh!

coderabbitai bot left a comment

Choose a reason for hiding this comment

Uh oh!

sonarqubecloud bot commented Jan 8, 2025

Quality Gate passed

Uh oh!

fonors commented Jan 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

2 participants

fonors commented Jan 8, 2025 •

edited by coderabbitai bot

Loading

coderabbitai bot commented Jan 8, 2025 •

edited

Loading

CodeRabbit Configuration File (`.coderabbit.yaml`)

fonors commented Jan 15, 2025 •

edited

Loading