Skip to content

docs: add "How It Works" section to README (EN + ZH) - #16

Merged
axetroy merged 5 commits into
masterfrom
copilot/add-how-it-works-section
Apr 27, 2026
Merged

axetroy merged 5 commits into
masterfrom
copilot/add-how-it-works-section

Conversation

Copilot AI commented Apr 24, 2026

Copy link
Copy Markdown
Contributor

Adds a bilingual "How It Works" section to both README.md and README_zh-CN.md, explaining dedust's internal pipeline for users who want to understand what happens under the hood.

Changes

  • README.md — New section inserted between "Features" and "Installation" covering the 5-stage pipeline with an ASCII flow diagram:

    • Tokenize → Tokenizer produces a typed token stream from raw DSL text
    • Parse → Parser builds structured rule objects (action + target glob + condition tree with and/not/location modifiers)
    • Validate → Validator rejects broad patterns (delete *, delete **/*) lacking conditions
    • Evaluate → Evaluator recursively walks baseDir, applying ignore/skip semantics and resolving spatial predicates (parent, parents, child, children, sibling) per directory
    • Execute → .execute() sorts targets deepest-first and deletes via Node.js fs APIs, capturing errors non-fatally
    • Includes a callout clarifying the default dry-run behaviour
  • README_zh-CN.md — Full Chinese translation of the same section, placed at the same position

@axetroy
axetroy merged commit 951bcdf into master Apr 27, 2026
0 of 6 checks passed
@axetroy
axetroy deleted the copilot/add-how-it-works-section branch April 27, 2026 05:44
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.

2 participants