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

chore: improve Configure TypeScript section in the readme #70

Closed
wants to merge 1 commit into from
Closed

chore: improve Configure TypeScript section in the readme #70

wants to merge 1 commit into from

Conversation

mrazauskas
Copy link

What

This PR is a suggestion to improve Configure TypeScript section in the readme.

Why

Technically there is no problem, all works well as documented. It just does not look elegant to reach into node_modules instead of letting package manager and TypeScript do the job. The improvement is subjective, of course.

Housekeeping

  • Documentation is up to date
  • No additional lint warnings

@@ -22,7 +22,7 @@ Thanks for being willing to contribute!

Once you are ready to commit the changes, please use the below commands

1. `git add <files to be comitted>`
1. `git add <files to be committed>`
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Just a typo. Could not leave it, sorry.

```json
{
"devDependencies": {
"@types/jest-expect-message": "npm:jest-expect-message@*",
Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The inspiration for this solution was the Supporting lib from node_modules section from TypeScript 4.5 release notes. The usage of npm: protocol looked smart. I tried out the same approach with @types/* package declaration and it worked! Well.. Looks obvious, but that was rather a discovery for me ;D

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.

1 participant