Skip to content
This repository has been archived by the owner on Jan 19, 2021. It is now read-only.

More consistent and better structured directory/file layout #75

Closed
holgerd77 opened this issue Jan 21, 2019 · 2 comments
Closed

More consistent and better structured directory/file layout #75

holgerd77 opened this issue Jan 21, 2019 · 2 comments

Comments

@holgerd77
Copy link
Member

Currently file naming is pretty inconsistent within the source directory of the library and it's relatively hard to grasp for newcomers what the code within different files do and how task/responsibility areas are structured.

File/directory structure should be updated - with respect (or at least considering) to API changes which would occur when moving certain files (e.g. src/secure.js). The following is a proposal which came out of discussion within PR #74:

  • main directory
    • base.js
    • checkpoint.js
    • index.js
    • secure.js
    • node.js
    • proof.js
  • util directory
    • async.js
    • hex.js
    • nibbles.js
    • tasks.js (or eventually merge with async.js)
  • db directory
    • index.js
    • scratch.js
  • readStream directory
    • index.js
    • scratch.js
@holgerd77
Copy link
Member Author

Note: eventually we can rename DB file and source occurences to Storage or something similar, to better prepare for a future backend exchange possibility.

@holgerd77
Copy link
Member Author

Addressed along several follow-up (and at least partially unrelated) refactoring PRs, will close.

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

No branches or pull requests

1 participant