sprocket

Workflow Description Language 文件的包管理器。

请求功能 · 报告错误 · ⭐ 考虑星标仓库！⭐

🎨 功能

• sprocket check 检查 Workflow Description Language 文件的语法有效性。
• sprocket lint 检查 Workflow Description Language 文件的错误。
• sprocket explain 解释错误规则。

指导原则

• 现代、可靠的日常生物信息学分析基础—用 Rust 编写。 sprocket 的目标是将一系列工具打包在一起，用于使用 Workflow Description Language 开发生物信息学任务和工作流程。它旨在支持现代多核系统，并使用 Rust 编写。
• 专注于 WDL 规范。 我们的目标是准确实现 OpenWDL 规范 的各个版本。换句话说，sprocket 的目标是与工作流程引擎无关。未来，我们计划使 sprocket 可以为工作流程引擎团队扩展。

📚 入门

安装

在您安装 sprocket 之前，您需要安装 Rust。我们建议使用 rustup 来完成此操作。

安装 Rust 后，您可以通过运行以下命令来安装 sprocket 的最新版本。

cargo install sprocket

🖥️ 开发

要初始化开发环境，请使用以下命令。

# Clone the repository
git clone [email protected]:stjude-rust-labs/sprocket.git
cd sprocket

# Build the crate in release mode
cargo build --release

# Run the `sprocket` command line tool
cargo run --release

🚧️ 测试

在提交任何拉取请求之前，请确保代码通过以下检查（从根目录开始）。

# Run the project's tests.
cargo test --all-features

# Run the tests for the examples.
cargo test --examples --all-features

# Ensure the project doesn't have any linting warnings.
cargo clippy --all-features

# Ensure the project passes `cargo fmt`.
cargo fmt --check

# Ensure the docs build.
cargo doc

🤝 贡献

欢迎贡献、问题和功能请求！请随意查看问题页面。

📝 许可证

本项目可以自由选择以Apache 2.0或MIT许可证发布。

版权所有 © 2023-至今 St. Jude Children's Research Hospital。