YAML generation uses manual string building in compile_gate_step_external

Open Beginner friendly
#384 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
2/5
Estimated time
1-3 hours
Newbie friendliness
68/100
Issue type
Refactor
Clarity
Mostly clear
Activity status
Quiet
Tech stack
rust

Research direction

Review src/compile/filter_ir.rs and compile_gate_step_external, then compare the current manual YAML construction with the proposed serialization or escaping approach. Done means generated YAML remains valid when names contain quotes or newlines, without changing current output for the existing static names.

Written by the indexing model from the issue text.

Description

refactor rust

src/compile/filter_ir.rs:

step.push_str(&format!(" name: {}\n", ctx.step_name()));
step.push_str(&format!(" displayName: "{}"\n", ctx.display_name()));
These values come from &'static str constants so there's no injection risk today. But the pattern is fragile — a future GateContext variant with a display name containing " or \n would silently produce invalid YAML. Suggest serializing via serde_yaml or at minimum YAML-escaping display names.

Dominant language
Rust
Stars
23
Forks
8
Avg merge
3d 14h
Merged PRs (30d)
20

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from githubnext/ado-aw

All issues in githubnext/ado-aw

Similar issues

More Rust issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.