Move typescript to peer dependencies #350
Merged
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.
What was the problem
Currently, the typescript package is used to load tsconfig and is not used by users who only use JavaScript.
The implementation is such that
require('typescript')
is actually done in the function, so it does not affect all users.However, including it in the dependencies may restrict the version of TypeScript that can be used, and a warning may be displayed if a user specifies a different version when installing madge.
Solution
Move the
typescript
dependency to the "peerDependencies" field and make the version specification a wildcard.Also add the "peerDependenciesMeta" field and make typescript as optional.
This is to avoid conflicts with the user's specification, and also because of the version specification in the directive
detective-typescript
, we expect to use thetypescript
version specified by thedetective-typescript
package, or thetypescript
version specified by the user, to be used when resolving the version. or the user-specifiedtypescript
version is expected to be used."peerDependencies" that specify only
typescript: *
can be ignored during development, so we specify typescript@^4.5.5, which is the same as the[email protected]
package.