Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Migrate to a monorepo #294

Closed
wants to merge 0 commits into from

Conversation

piotr-roslaniec
Copy link
Contributor

@piotr-roslaniec piotr-roslaniec commented Sep 7, 2023

To Do

  • Configure changesets for package release management
  • Update examples with pre and taco modules. Use TS and typecheck in examples.
  • Fix exports field in package.json (currently breaks tests in packages/taco
  • Update *.md files
  • Make sure examples are getting built, tested, etc. on CI
  • Revisit WASM packaging
  • Revisit module build
  • Figure out the structure of the pre package, similarly to taco package
  • Take advantage of peerDependencies
  • ...

Type of PR:

  • Documentation
  • Refactor
  • Other

Required reviews:

  • 3

What this does:

  • Creates a workspace for the monorepo structure with shared, pre and taco packages
  • Configures pnpm as a package manager
  • Reworks linting, docs generating, and other utilities
  • Replaces jest with vitest
  • ethers-contracts generated by typechain are no longer stored in the repo

Issues fixed/closed:

  • Fixes #...

Why it's needed:

Explain how this PR fits in the greater context of the NuCypher Network.
E.g., if this PR address a nucypher/productdev issue, let reviewers know!

Notes for reviewers:

  • This is a work in progress
  • Consider adding nucypher-ts demos (like https://github.com/nucypher/nucypher-ts-demo-tdec) as examples in ./apps
  • Consider moving refactoring of ./packages/* into a separate PR (functional vs OOO/character-based API)
  • Do we want ./examples to use taco or pre, or both?

@codecov-commenter
Copy link

codecov-commenter commented Sep 8, 2023

Codecov Report

Merging #294 (59bd4a8) into alpha (8f1dcf1) will decrease coverage by 81.26%.
The diff coverage is 0.00%.

@@            Coverage Diff             @@
##            alpha    #294       +/-   ##
==========================================
- Coverage   81.25%   0.00%   -81.26%     
==========================================
  Files          36      40        +4     
  Lines        1035    1074       +39     
  Branches      110     117        +7     
==========================================
- Hits          841       0      -841     
- Misses        186    1019      +833     
- Partials        8      55       +47     
Files Changed Coverage Δ
packages/nucypher-ts/src/characters/alice.ts 0.00% <0.00%> (ø)
packages/nucypher-ts/src/characters/bob.ts 0.00% <0.00%> (ø)
...ckages/nucypher-ts/src/characters/cbd-recipient.ts 0.00% <0.00%> (ø)
packages/nucypher-ts/src/characters/enrico.ts 0.00% <0.00%> (ø)
...ckages/nucypher-ts/src/characters/pre-recipient.ts 0.00% <0.00%> (ø)
...ckages/nucypher-ts/src/conditions/base/contract.ts 0.00% <ø> (ø)
packages/nucypher-ts/src/conditions/base/index.ts 0.00% <ø> (ø)
packages/nucypher-ts/src/conditions/base/rpc.ts 0.00% <ø> (ø)
packages/nucypher-ts/src/conditions/base/shared.ts 0.00% <ø> (ø)
packages/nucypher-ts/src/conditions/base/time.ts 0.00% <ø> (ø)
... and 30 more

📢 Have feedback on the report? Share it here.

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