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.

Sign up for GitHub

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

Jump to bottom

is there a good reason w3up-client tsconfig.json should continue to not include /test? #668

Closed
gobengo opened this issue Mar 27, 2023 · 2 comments
Closed

is there a good reason w3up-client tsconfig.json should continue to not include /test? #668

gobengo opened this issue Mar 27, 2023 · 2 comments

Comments

@gobengo
Copy link
Contributor

gobengo commented Mar 27, 2023 •
edited
Loading

Motivation:

Benefits of including /test in tsconfig.json:

  • type-checking on our tests. may catch bugs/mistakes via static analysis instead of at runtime in a way that would hamper end-user's experience
@gobengo gobengo mentioned this issue Mar 27, 2023
Merged
10 tasks
@gobengo gobengo changed the title is there a reason tsconfig.json does not include /test? is there a reason w3up-client tsconfig.json does not include /test? Mar 27, 2023
@gobengo
Copy link
Contributor Author

gobengo commented Mar 27, 2023

@alanshaw would it be helpful if I include /test in tsconfig.json and make them pass?

@gobengo gobengo changed the title is there a reason w3up-client tsconfig.json does not include /test? is there a good reason w3up-client tsconfig.json should continue to not include /test? Mar 27, 2023
gobengo referenced this issue Mar 28, 2023
@gobengo @ice-breaker-tg
@yusefnapora @the-simian @dashcraft @vasco-santos @hugomrdias @Gozala @dchoi27 @github-actions @travis @omahs
feat: add w3up-client at /packages/w3up-client (#653)
ca921ec 
Motivation:
* #648
* e.g. so we can iterate on w3up-client and its dependencies like
`@web3-storage/access/agent` at the same time within the workspace (and
modifying tests/types) without having to release anything. We can only
do releases once we are sure that everything in the monorepo (now incl
w3up-client) works together to accomplish a useful goal
* round 2, this time not using `git subtree add`
#649 (comment)

How
* [x] this git technique: https://stackoverflow.com/a/20974621 (via
[this tip](https://github.com/web3-storage/w3protocol
/pull/649#pullrequestreview-1358869478))
* [x] add `@web3-storage/w3up-client` to release-please-config
* [x] add latest npm release for w3up-client to this monorepo's
[release-please-config following release-please 'initial version'
docs](https://github.com/googleapis/release-please/blob/main/docs/manifest-releaser.md#initial-version)
* [x] w3protocol monorepo github workflows call appropriate w3up-client
workflows
* [x] on push/pr, do w3up-client build and test
f9b8e65#diff-eefdf870850494ad962a679c802b7733805b6996d8f1c6a992ae8760a366f82eR16
* [x] on commit to main branch do release-please-action to prepare a
release-please pr for w3up-client publishing to npm
* @gobengo: I believe this will happen via unified
[`/.github/workflow/release.yml`](https://github.com/web3-storage/w3protocol/blob/main/.github/workflows/release.yml#L15)
workflow, since I added w3up-client to release-please-config and
manifest
* [x] when w3up-client release-please pr is merged, release
`@web3-storage/w3up-client` to
https://www.npmjs.com/package/@web3-storage/w3up-client
* should happen [via
release.yml](2f8ae22#diff-87db21a973eed4fef5f32b267aa60fcee5cbdf03c67fafdc2a9b553bb0b15f34R39)
* [x] [add w3up-client to monorepo root docs
build](2f8ae22#diff-b55cdbef4907b7045f32cc5360d48d262cca5f94062e353089f189f4460039e0R42)
* [x] ensure w3up-client has intra-monorepo dependencies set up [using
`workspace:`
protocol](https://pnpm.io/workspaces#workspace-protocol-workspace) and
similar use of tsconfig.json [project
references](8b87fcc#diff-78dc2f52fc9c2ed3593f53799153a338a7f20eb6f16309a1175fbfcbae270118R49)
* [x] w3up-client tsconfig extends monorepo root

Unblocks:
* add "./test" to tsconfig.json in w3up-client to type check the tests
like the rest of packages in this monorepo
  * based on https://github.com/web3-storage/w3up-client/issues/96

---------

Co-authored-by: ice.breaker <ice.breaker@trigram.co>
Co-authored-by: Yusef Napora <yusef@napora.org>
Co-authored-by: ice.breaker <94936890+ice-breaker-tg@users.noreply.github.com>
Co-authored-by: Jesse Harlin <harlinjesse@gmail.com>
Co-authored-by: Daniel <daniel.ashcraft@ofashandfire.com>
Co-authored-by: Vasco Santos <santos.vasco10@gmail.com>
Co-authored-by: Hugo Dias <hugomrdias@gmail.com>
Co-authored-by: Irakli Gozalishvili <contact@gozala.io>
Co-authored-by: David Choi <dchoi27@gmail.com>
Co-authored-by: Alan Shaw <alan.shaw@protocol.ai>
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
Co-authored-by: Yusef Napora <yusef@protocol.ai>
Co-authored-by: Travis Vachon <travis.vachon@gmail.com>
Co-authored-by: omahs <73983677+omahs@users.noreply.github.com>
@gobengo gobengo transferred this issue from web3-storage/w3up-client Mar 28, 2023
@gobengo gobengo mentioned this issue Mar 28, 2023
Merged
@gobengo
Copy link
Contributor Author

gobengo commented Mar 29, 2023

nope

@gobengo gobengo closed this as completed Mar 29, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@gobengo