Skip to content

e2store: examples directory and README update#4042

Merged
holgerd77 merged 7 commits into
masterfrom
e2store-examples
Apr 30, 2025
Merged

e2store: examples directory and README update#4042
holgerd77 merged 7 commits into
masterfrom
e2store-examples

Conversation

@ScottyPoi

@ScottyPoi ScottyPoi commented Apr 29, 2025

Copy link
Copy Markdown
Contributor
  • Creates examples directory.
  • Adds examples scripts
    • era
    • era1
    • e2hs
  • Updates README with code section links to examples
    • should auto populate README with npm run examples:build
  • Fixes npm run examples scripts in package.json

@codecov

codecov Bot commented Apr 29, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 79.51%. Comparing base (589a54a) to head (89d9e26).
Report is 1 commits behind head on master.

Additional details and impacted files

Impacted file tree graph

Flag Coverage Δ
block 84.33% <ø> (ø)
blockchain 89.32% <ø> (ø)
client 67.99% <ø> (ø)
common 97.51% <ø> (ø)
devp2p 86.78% <ø> (+0.07%) ⬆️
evm 73.11% <ø> (ø)
mpt 89.74% <ø> (+0.05%) ⬆️
statemanager 69.06% <ø> (ø)
static 99.11% <ø> (ø)
tx 89.89% <ø> (ø)
util 89.19% <ø> (ø)
vm 55.50% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread packages/e2store/README.md Outdated
console.log(body)
console.log(receipts)
}
// ./examples/e2hs.ts#L29-L32

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Ah, we had this discussion on some of Amir's PRs already, so this by-line-inclusion tends to be really error-prone, since one is often not noticing if lines are shifting and this tends to get a constant re-hunting for correct documentation.

Then it's better to just keep static, will re-put the plain code here and push, branch needs an update anyhow.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Update: ah, ok, I see the problem that the examples - if self-contained seem to get really long, also this makes use of this inclusion pretty heavily, a bit of a pity to reverse.

Then I won't do, but we should keep in mind a bit and be really careful here.

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Have pushed an update building the examples and do some small adjustments. Will approve/merge when CI passes. Thanks for the PR! 🙂

@holgerd77 holgerd77 left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@holgerd77 holgerd77 merged commit a7dc3fe into master Apr 30, 2025
@holgerd77 holgerd77 deleted the e2store-examples branch April 30, 2025 15:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants