Nextflow 和 nf-core 工作流补全、命令、语法高亮和片段，适用于 Sublime Text 4

• ⚠️警告⚠️：自版本1.0.0起，本软件包不再支持Sublime Text 3。仅支持Sublime Text 4，因为本软件包需要Python 3.8和ST4的新功能。
• ❗注意❗：本软件包仅支持 DSL-2 Nextflow工作流。

本软件包提供Nextflow工作流语言

• 补全（如：params., conda, <PROCESS/WORKFLOW>.out.<emit name>）
• 过程和子工作流的信息弹出窗口
• 命令（插入容器指令、插入模块导入语句）
• 语法高亮
• 片段

本质上，这个软件包试图使Nextflow工作流开发变得更容易，特别是在尝试开发nf-core标准和最佳实践以开发Nextflow管道时。

Nextflow补全和命令

过程模块包含命令

• ctrl+l,p 在你想要导入过程的 .nf 文件中

• 选择你想要导入的过程
• 将会插入一些类似以下的内容

include { MAKE_BED_MASK } from '../modules/local/make_bed_mask' addParams( options: modules['make_bed_mask'] )

addParams(选项：modules['make_bed_mask'] )可能不是必须的，可以被移除；它假设你有包含你的模块 args，publish_dir等（详细信息见nf-core/modules）。

工作流params

注意：关于 params 的自动完成和信息小窗口依赖于工作流程根文件夹中有效的 nextflow_schema.json 文件。例如，请参阅 nf-core/viralrecon 工作流程的 nextflow_schema.json 文件：nf-core/viralrecon 工作流程的 nextflow_schema.json。

将光标移动到 params.<variable> 以显示从该工作流程参数的 nextflow_schema.json 中提取的信息。

Conda 自动完成

注意：为了获取软件包信息（需要能够运行 conda search），必须安装 Conda 以及任何通道（例如bioconda，conda-forge）。

• 打开命令面板（ctrl+shift+p）并运行 Nextflow: Fetch Conda packages information 命令以获取最新的 Conda 软件包信息（运行 conda search；可能需要一段时间）。
• 在您的流程定义中，在 conda 指令字符串内按 ctrl+space 可启动完成列表。 由于软件包列表可能非常大，这可能会稍显延迟。

process PANGOLIN {
  conda '<press ctrl+space to bring up completion list>'
}

流程输出通道自动完成

在输入 <PROCESS_NAME>.out 之后获取名为的输出流程（即使用 emit 选项）的自动完成。

• 自动完成还会显示通道上有什么内容！

流程输出通道小窗口

显示关于一个流程正在产生的输出的有用信息。

容器指令插入命令

此命令将插入类似于在 nf-core modules 流程定义中找到的与 container 指令相似的代码。从 Singularity 镜像 https://depot.galaxyproject.org/singularity/ 中获取 Biocontainers 信息，并将其作为 Python pickle 文件缓存。 Docker 容器镜像标签指向 Biocontainers 的 Quay.io 页面。

• 打开命令面板（ctrl+shift+p）并运行 Nextflow: Fetch Biocontainers information 命令以获取从 Biocontainers 获取的最新列表
• 在您的流程定义中，按 ctrl+l,c，搜索您感兴趣的容器

• 选择您感兴趣的程序和版本以输出以下内容

if (workflow.containerEngine == 'singularity' && !params.singularity_pull_docker_container) {
  container 'https://depot.galaxyproject.org/singularity/fastqc:0.11.9--hdfd78af_1'
} else {
  container 'quay.io/biocontainers/fastqc:0.11.9--hdfd78af_1'
}

Nextflow 语法高亮显示

Nextflow 语法高亮显示将 Sublime Text 4 的 Groovy 语法扩展到对以下内容的语法高亮显示：

• 导入（DSL-2 模块）
• 工作流程定义
• 流程定义
• 根据匹配的 ch_* 进行通道高亮显示
• 一些无效语法检查（输入标签中的通道和输出标签中的通道）
• Highlight special Nextflow functions and variables (workflow, params, task, etc.)

流程语法高亮和范围允许您轻松地导航到流程的定义或用法（使用 ctrl+shift+g 键盘快捷键）

Nextflow 代码片段

输入以下之一并按 TAB

• !env: #!/usr/bin/env nextflow
• proc: process 片段
• tag: tag 流程指令片段
• pub: publishDir 流程指令片段
• conda: conda 流程指令片段
• illumina: Illumina 成对读取文件通道
• cpus: 将 "${task.cpus}" 插入进程脚本
• script_path: 从工作流程基本目录中的 scripts/ 目录指定用户脚本（例如 Python 脚本）
• info: log.info 片段
• done: 工作流程完成或错误信息

变更日志

1.1.0 - [2022-05-13]

增加

• 更丰富的弹窗以显示过程输出的信息，使得在不参考过程代码的情况下更容易选择正确的输出通道。
• 子工作流程完成和有关take和emit通道的信息弹窗
• conda指令片段

修复

• 注释切换功能

1.0.0 - [2021-06-30]

• 为Nextflow DSL-2添加了语法高亮
• 添加了工作流程params、PROCESS.out.、conda、容器、模块包含的补全和命令
• 删除了一些不太有用的片段

0.1.0-alpha.1 - [2019-03-27]

• 首次发布，包含基于Groovy的语法高亮和基本片段

许可证

MIT许可证

版权所有 © Peter Kruczkiewicz