nettee / nettee/zest-dev

Support non-Markdown text files in `zest-dev dump`

Open
#143 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
JavaScript
Stars
3
Forks
1
Avg merge
23m
Merged PRs (30d)
3

Description

Problem

zest-dev dump archives Markdown files from a spec directory, but non-Markdown text artifacts such as SQL scripts are not preserved. A downstream archive workflow may then see the archive issue as complete and delete the source directory, silently losing repository-only text files.

Desired behavior

  • Recursively archive UTF-8 text files in addition to Markdown, including at least .sql, .json, .yaml, .yml, .txt, and shell scripts.
  • Preserve each file's relative path and complete contents.
  • Use a representation that safely handles content containing Markdown fences.
  • Treat unsupported or binary files as an observable failure; do not report a successful dump while silently omitting them.
  • Do not signal dump completion until every file in the spec directory has either been preserved or caused an explicit failure.
  • Keep existing Markdown dump behavior compatible.

Acceptance criteria

  1. A fixture containing spec.md and a nested validation.sql is dumped with both relative paths and byte-equivalent text contents recoverable from the archive issue.
  2. A spec containing an unsupported binary file exits non-zero and identifies the unsupported path.
  3. A partial upload or failed comment creation exits non-zero rather than reporting success.
  4. Tests cover mixed Markdown/text directories and text containing triple-backtick sequences.
  5. The supported text-file and unsupported-file behavior is documented.

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.

Research direction

Start at the zest-dev dump command and trace the existing Markdown archive flow, then inspect how its tests create fixtures and upload or create comments. Extend the coverage for mixed nested text files, fence-containing content, unsupported binaries, and failed uploads. Done means all supported files are recoverable with relative paths and exact contents, while unsupported or partial operations fail visibly and the supported-file behavior is documented.

Written by the indexing model from the issue text.

Assessment

Tech stack
javascript
Domain
cli
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
58/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.