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

fix: types with ipjs build #165

Merged
merged 1 commit into from
Aug 19, 2021
Merged

fix: types with ipjs build #165

merged 1 commit into from
Aug 19, 2021

Conversation

vasco-santos
Copy link
Member

@vasco-santos vasco-santos commented Aug 19, 2021

Currently, the published package.json has "types": "dist/src/index.d.ts" and should be "types": "src/index.d.ts", according to where the types really are.

The problem here is that we need to both:

  • have type paths correct in the dist folder
  • have type paths correct for local dev in src

Given the path will change, we need to guarantee this is updated in the build package.json. Using an approach like multiformats and uint8arrays having a types folder which is moved to dist is not possible because of the inline d.ts files in this repo, which will be inside dist folder as dist/src/*.d.ts, breaking the imports from the types around it.

With the above in mind, this PR adds a postbuild script where the package.json is changed in post build to have dist removed.

@vasco-santos vasco-santos force-pushed the fix/types-with-ipjs-build branch from 44c757c to 387fd37 Compare August 19, 2021 11:10
@achingbrain
Copy link
Member

achingbrain commented Aug 19, 2021

I can't see postbuild in the npm lifecycle docs - when does it run? Or do we have to trigger it manually?

Should this maybe be prepublishOnly or prepack instead?

@vasco-santos
Copy link
Member Author

I am using https://docs.npmjs.com/cli/v6/using-npm/scripts#pre--post-scripts but sure, I can do prepack instead given prepublish is deprecated and we would like to support running this when installing git deps

@vasco-santos vasco-santos requested review from achingbrain and removed request for achingbrain August 19, 2021 12:06
@achingbrain
Copy link
Member

achingbrain commented Aug 19, 2021

I am using docs.npmjs.com/cli/v6/using-npm/scripts#pre--post-scripts

Ah yes, quite right. In that case maybe it should be postbuild after all. As I read it, prepare will be run, which runs build then npm will run postbuild.

@vasco-santos vasco-santos force-pushed the fix/types-with-ipjs-build branch from b126113 to 387fd37 Compare August 19, 2021 12:15
@vasco-santos
Copy link
Member Author

Removed second commit

@achingbrain achingbrain merged commit fea85b5 into master Aug 19, 2021
@achingbrain achingbrain deleted the fix/types-with-ipjs-build branch August 19, 2021 13:41
github-actions bot pushed a commit that referenced this pull request Apr 26, 2022
## ipfs-unixfs-v1.0.0 (2022-04-26)

### ⚠ BREAKING CHANGES

* ./src/dir-sharded is not in the exports map so cannot be imported

Co-authored-by: Alex Potsides <alex@achingbrain.net>
* uses new multiformats stack and takes a blockservice instead of the block api

Co-authored-by: Rod Vagg <rod@vagg.org>
Co-authored-by: achingbrain <alex@achingbrain.net>
* switches to named exports
* types are now included with all unixfs modules
* does not convert input to node Buffers any more, uses Uint8Arrays instead

### Features

* add types ([#114](#114)) ([ca26353](ca26353))

### Bug Fixes

* add pbjs namespace ([#145](#145)) ([dd26b92](dd26b92))
* declare types in .ts files ([#168](#168)) ([76ec6e5](76ec6e5))
* ignore high mode bits passed to constructor ([#53](#53)) ([8e8d83d](8e8d83d))
* ignore undefined values in options ([#173](#173)) ([200dff3](200dff3))
* individual packages can use npm 6 ([#167](#167)) ([2b429cc](2b429cc))
* publish with types in package.json ([#166](#166)) ([0318c98](0318c98))
* remove node globals ([#52](#52)) ([5414412](5414412))
* replace node buffers with uint8arrays ([#69](#69)) ([8a5aed2](8a5aed2)), closes [#66](#66)
* types with ipjs build ([#165](#165)) ([fea85b5](fea85b5))
* use @ipld/dag-pb instead of ipld-dag-pb ([#116](#116)) ([bab1985](bab1985))

### Trivial Changes

* add travis file and configure build scripts ([5a25c87](5a25c87))
* consolidate .gitignore files ([b05e468](b05e468))
* declare interface types in .d.ts file ([#122](#122)) ([eaa8449](eaa8449))
* dep updates ([cf9480b](cf9480b))
* **deps-dev:** bump aegir from 26.0.0 to 28.1.0 ([#86](#86)) ([87541c7](87541c7))
* **deps-dev:** bump aegir from 28.2.0 to 29.2.2 ([#101](#101)) ([010ab47](010ab47))
* exclude docs and tests from npm package ([63b8ba0](63b8ba0))
* move files into packages folder ([943be9d](943be9d))
* publish ([5203595](5203595))
* publish ([0f9092e](0f9092e))
* publish ([2713329](2713329))
* publish ([35e2059](35e2059))
* publish ([137a4ad](137a4ad))
* publish ([f173850](f173850))
* publish ([2ea467f](2ea467f))
* publish ([dedbd82](dedbd82))
* publish ([dc2d400](dc2d400))
* publish ([27d57df](27d57df))
* publish ([5ccac2f](5ccac2f))
* publish ([172548b](172548b))
* publish ([9a2b5f2](9a2b5f2))
* publish ([e57ba16](e57ba16))
* publish ([9e8f077](9e8f077))
* publish ([22e29bb](22e29bb))
* publish ([dabbb48](dabbb48))
* publish ([32e5165](32e5165))
* publish ([5d3f4bd](5d3f4bd))
* publish ([49c8c54](49c8c54))
* publish ([db2c878](db2c878))
* publish ([9237250](9237250))
* remove changes from readme ([7c727ef](7c727ef))
* remove node buffers from runtime code ([#66](#66)) ([db60a42](db60a42))
* remove redundant test files ([3078608](3078608))
* small readme change ([f45436c](f45436c))
* swap to prereleaseOnly ([efb01ac](efb01ac))
* switch to auto-release ([#208](#208)) ([99386e6](99386e6))
* switch to ESM ([#161](#161)) ([819267f](819267f)), closes [skypackjs/skypack-cdn#171](skypackjs/skypack-cdn#171)
* tighten up input types ([#133](#133)) ([47f295b](47f295b))
* update build scripts ([37d96ee](37d96ee))
* update deps ([#144](#144)) ([f5f5fe4](f5f5fe4))
* update deps ([#78](#78)) ([2bf5d07](2bf5d07))
* update lockfiles ([9d11252](9d11252))
* update package.json scripts and readmes ([bda3717](bda3717))
* update readme ([a012f22](a012f22))
* update readme ([7f93da1](7f93da1))
* update readmes ([#188](#188)) ([273a141](273a141))
* upgrade deps ([3a43e92](3a43e92))
* use npm 7 workspaces instead of lerna bootstrap ([#120](#120)) ([1ceb097](1ceb097))
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