Support TypeScript's moduleResolution: "Node16"
#524
Conversation
This file contains hidden or 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
Bumps [micromark-extension-gfm](https://github.com/micromark/micromark-extension-gfm) from 2.0.1 to 2.0.3. - [Release notes](https://github.com/micromark/micromark-extension-gfm/releases) - [Commits](micromark/micromark-extension-gfm@2.0.1...2.0.3) --- updated-dependencies: - dependency-name: micromark-extension-gfm dependency-type: indirect update-type: version-update:semver-patch ...
Add support for TypeScript's `NodeNext`/`Node16` `moduleResolution`. TypeScript uses the new Node.JS package entry point syntax in the `package.json` file to pick which types file to load. In order to avoid breaking backwards compatibility with newer versions of Node.JS, that may have use something like `import * from "@adobe/jsonschema2md/lib/config"`, we need to explicitly list every single import path that people may have used. See: https://www.typescriptlang.org/docs/handbook/esm-node.html See: https://nodejs.org/api/packages.html#package-entry-points
Codecov Report
@@ Coverage Diff @@
## main #524 +/- ##
=======================================
Coverage 99.75% 99.75%
=======================================
Files 11 11
Lines 2039 2039
=======================================
Hits 2034 2034
Misses 5 5
📣 We’re building smart automated test selection to slash your CI/CD build times. Learn more |
aloisklink
commented
Aug 3, 2023
Comment on lines
+24
to
+35
| "./lib/*": { | ||
| "import": { | ||
| "types": "./types/*.d.ts", | ||
| "default": "./lib/*.js" | ||
| } | ||
| }, | ||
| "./lib/index": { | ||
| "import": { | ||
| "types": "./types/index.d.ts", | ||
| "default": "./lib/index.js" | ||
| } | ||
| }, |
Contributor
Author
There was a problem hiding this comment.
These are currently needed for backwards compatibility, in case somebody has done import {jsonschema2md} from "@adobe/jsonschema2md/lib/index"; or import { default as schemaLoader } from '@adobe/jsonschema2md/lib/schemaProxy';.
However, as long as you're okay with having a BREAKING CHANGE, we can remove these lines.
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Add support for TypeScript's
moduleResolution: "Node16".There's more information about what this this entails in https://www.typescriptlang.org/docs/handbook/esm-node.html, but essentially, it lets TypeScript check that all ESM imports match what Node.JS can import.
However, TypeScript will no longer look at the
"types"/"typing"field in yourpackage.jsonfile. Instead, they except entries in the"exports"field inpackage.json.In order to avoid breaking backwards compatibility with newer versions of Node.JS, that may have use something like
import * from "@adobe/jsonschema2md/lib/config", we need to explicitly list every single import path that people may have used.Before
Using https://arethetypeswrong.github.io/?p=%40adobe%2Fjsonschema2md%407.1.5, we can see that the
node16types are currently broken for@adobe/jsonschema2mdv7.1.5:After
Run
npm pack, and upload the file to https://arethetypeswrong.github.io/