Fix type mapping #72
Closed
Fix type mapping #72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
It also removes the `Codec` class and exports a plain object
instead. This has consequences for imports.
BREAKING CHANGE:
Only use names exports as default exports don't play well with
CommonJS + Typescript typing.
This means that when you use ESM imports, e.g. the raw codec is
no longer imported as
```js
import raw from 'multiformats/codecs/raw'
```
but as
```js
import * as raw from 'multiformats/codecs/raw'
```
The CJS import for codecs don't change, it's still `const raw = require('multiformats/codecs/raw`.
Though other imports change, so
```js
import CID from 'multiformats/cid'
const CID = require('multiformats/cid')
```
is now
```js
import { CID } from 'multiformats/cid'
const { CID } = require ('multiformats/cid')
```
- "*" match seems to cause multiple path substitutions microsoft/TypeScript#41284 that packge name prefix seems to resolve - add types field which acts as main in TS
- modify scripts to use newer tsc --bulid command - generate types on prepare so linking to git dependency works - workaround douple substitution by mapping types/* to itself (see microsoft/TypeScript#41284)
This was referenced Mar 30, 2021
|
👍 amazing detective work, |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is based of #70 pull request. And resolves the issue described here #66 (comment). There is also relevant thread here ipld/js-car#7
Overview of changes
tsc --bulidcommand (they use different code path and other ones will eventually be removed)typeVersionssubstitution occurs multiple times causing resolution to fail microsoft/TypeScript#41284, which causes it to do path substitution twice whentypesfield is present. That causesmultiformatsto be rosolved tonode_modules/multiformats/types/index.d.tsand then withnode_modules/multiformats/types/types/index.d.ts. Here we just maptypes/*back totypes/*which prevents second substitution and avoids the mentioned bug.I really wish things worked without all this hacks, but 🤷♂️