Snakemake files have Python syntax #2745
Closed
Conversation
This file contains 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
In #1834 the filename `Snakefile` was added to the list of Python filenames. Here, I propose to add 3 file extensions for [Snakemake][1]. All 3 of these file extensions are unique to Python. The author of Snakemake lists the following [file extensions for Snakefiles][2]: - .rules - .snakefile - .snake and the following filenames: - Snakefile Aside: In the future, when Snakemake is more mature, it may be sensible to provide a language grammar based on Python and customized for Snakemake. Currently, I favor highlighting Snakemake files like Python files. [1]: https://bitbucket.org/snakemake/snakemake/wiki/Home [2]: https://bitbucket.org/snakemake/snakemake/wiki/FAQ#markdown-header-how-do-i-enable-syntax-highlighting-in-vim-for-snakefiles
|
Hi @slowkow thanks for opening this Pull Request. Firstly, a little housekeeping: the tests are current failing as the extensions need to be sorted alphabetically, if you could fix that up that would be great. Secondly, would you mind reviewing our contributing guidelines? Specifically it would be great to see links to search queries showing in-the-wild usage of these extensions. |
|
🎏 flagging this as stale 🎏 |
|
This PR has been picked up here: #3953 |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
In #1834 the filename
Snakefilewas added to the list of Python filenames.Here, I propose to add 3 file extensions for Snakemake. All 3 of these file extensions are unique to Python.
The author of Snakemake lists the following file extensions for Snakefiles:
and the following filenames:
Aside: In the future, when Snakemake is more mature, it may be sensible to provide a language grammar based on Python and customized for Snakemake. Currently, I favor highlighting Snakemake files like Python files.