Skip to content

docs: say when to use yaml instead of tinyaml - #29

Merged
vite-hub[bot] merged 2 commits into
mainfrom
docs/when-to-use-yaml
Nov 3, 2026
Merged

vite-hub[bot] merged 2 commits into
mainfrom
docs/when-to-use-yaml

Conversation

@onmax

@onmax onmax commented Nov 3, 2026

Copy link
Copy Markdown
Owner

The comparison table only listed things tinyaml also does. This adds the things yaml is built for, so the speed and size numbers read fairly.

  • Three rows in the comparison table: keeps comments, Document/AST/CST, and edits that keep formatting. yaml has all three. tinyaml, js-yaml 4 and 5, yamljs and @std/yaml have none. I checked that js-yaml 4.3.2 and 5.5.0 drop comments on a load and dump round trip. yamljs 0.3.0 and @std/yaml 1.3.0 export only value-level parse and stringify.
  • A "When to use yaml instead" section under the table: tinyaml never builds a syntax tree, which is most of why it's small and fast. For comments, node positions or editing a file in place, use yaml.
  • One sentence in the tinyaml README saying the same.

This came out of a discussion in the e18e Discord, where yaml's maintainer and James pointed out that tinyaml is a parse-to-values library and yaml is the one to use when you need the intermediate representation.

@vite-hub

vite-hub Bot commented Nov 3, 2026 •

Copy link
Copy Markdown
Contributor
Session Status Started Duration
Pending Completed Not started —
View session Waiting 2026-11-03T06:12:41.374Z 1m 31s

Latest result

Pull request merged.

Final answers

Session

Pull request merged.

Session

Waiting for GitHub merge request 7b33ec07-54c6-4663-b2a5-b9f945a67cf4.

Session

Updated the branch with main because main changed packages/tinyaml/README.md after its checks ran; waiting for checks on the new head.

Session

Updated the branch with main because main changed packages/tinyaml/README.md after its checks ran; waiting for checks on the new head.

Session

Updated the branch with main because main changed packages/tinyaml/README.md after its checks ran; waiting for checks on the new head.

Session

Updated the branch with main because main changed packages/tinyaml/README.md after its checks ran; waiting for checks on the new head.

View session

Ready under the supplied severity rules. Pullfrog: P2 comparison-table documentation gap confirmed against js-yaml 5.5.0 declarations; standalone repair declined under the no-P2-only-push rule, rationale posted, and thread resolved. No files changed. git diff --check origin/main...HEAD passed, and all supplied hosted checks passed. Local tests were unavailable because host installation rejected an existing dependency protocol; manifests and lockfile are unchanged.

Session

Waiting for running checks before the next pass.

Session

Waiting for running checks before the next pass.

@chatgpt-codex-connector

chatgpt-codex-connector Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Codex Review Summary

This comment shows the latest Codex review activity on this pull request.

Review Status Commit Review trigger
📝 Code Review ✅ Completed 2026-11-03T06:08:49.826170Z 6fba42a PR opened
ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

  • Open a pull request for review
  • Mark a draft as ready
  • Comment "@codex review" or "@codex security review".

Codex reacts with 👀 while any review is running, comments if it has suggestions, and reacts with 👍 once all reviews finish with no findings.

@pullfrog pullfrog Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

ℹ️ One factual correction in the comparison table.

Reviewed changes Reviewed the comparison page and README guidance on when to choose yaml instead of tinyaml.

  • Capability comparison: Adds rows for comment retention, syntax-tree APIs, and formatting-preserving edits.
  • Library selection: Explains the value-oriented scope of tinyaml and recommends yaml for source-aware editing.

Pullfrog  | Fix all ➔ | Fix 👍s ➔ | View workflow run | Using gpt-6.1-sol | 𝕏

@pkg-pr-new

pkg-pr-new Bot commented Nov 3, 2026 •

Copy link
Copy Markdown

Open in StackBlitz

pnpm add https://pkg.pr.new/tinyaml@29
pnpm add https://pkg.pr.new/tinyini@29
pnpm add https://pkg.pr.new/tinyjson5@29
pnpm add https://pkg.pr.new/tinyswap@29

commit: 40a1854

@vite-hub

vite-hub Bot commented Nov 3, 2026

Copy link
Copy Markdown
Contributor

Confirmed the comparison-table finding against the published js-yaml 5.5.0 declarations, which export Document, eventsToAst, jsToAst, and visit; this is a P2 documentation gap, so I am declining a standalone repair under the supplied rule against P2-only pushes and resolving the thread.

@vite-hub
vite-hub Bot merged commit 0e38267 into main Nov 3, 2026
10 checks passed
@github-actions github-actions Bot mentioned this pull request Nov 3, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant