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.

Sign up for GitHub

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

Jump to bottom

Include original .ts files in the NPM package to allow proper debugging #142

Closed
gabmontes opened this issue May 28, 2021 · 1 comment · Fixed by #159
Closed

Include original .ts files in the NPM package to allow proper debugging #142

gabmontes opened this issue May 28, 2021 · 1 comment · Fixed by #159
Labels
enhancement

Comments

@gabmontes
Copy link

The published package in NPM only contains the /dist/* files but when debugging with i.e. the Chrome DevTools and stepping into the library, an error is thrown because the original /src/index.ts file cannot be found and therefore the sourcemaps can't be used to display the proper source lines being executed.

Please update the NPM package to also include the /src directory.

Note: To workaround this issue, just copied the /src file into node_modules/eth-sig-util and the DevTools are happy again.
@gabmontes gabmontes mentioned this issue Jun 7, 2021
Closed
@Gudahtt
Copy link
Member

Gudahtt commented Jul 13, 2021

Thanks for the suggestion! Would including inline sources solve the issue for you as well? That should be enough to make Chrome DevTools happy. I had been planning on enabling inline sources anyway.

Gudahtt added a commit that referenced this issue Jul 15, 2021
@Gudahtt
Use standard TypeScript config
42191ca 
The TypeScript config has been updated to match the configuration we
use in other libraries, mostly. The remaining differences are that
`strict` is still not enabled, and there is a separate config used for
testing. The test config was preserved for now, but that will be
replaced soon when we migrate the tests to Jest. `strict` mode will be
enabled in a later PR after we update dependencies, as that will make
the necessary changes much easier.

The changes are:
* `inlineSources` has been enabled. This embeds a complete compy of the
  source code with the source maps, allowing for a much better debugging
  experience.
* `lib` has been set to `ES2020`, ensuring that we only rely upon
  JavaScript APIs. Previously it also allowed use of browser APIs.
* `rootDir` is now set explicitly to `src`, which will help ensure we
  don't accidentally change the structure of the package.
* The old `prod` config was merged with the base config, so it was no
  longer needed as a separate file.

Closes #142
@Gudahtt Gudahtt mentioned this issue Jul 15, 2021
Merged
Gudahtt added a commit that referenced this issue Jul 15, 2021
@Gudahtt
Use standard TypeScript config
46aa107 
The TypeScript config has been updated to match the configuration we
use in other libraries, mostly. The remaining differences are that
`strict` is still not enabled, and there is a separate config used for
testing. The test config was preserved for now, but that will be
replaced soon when we migrate the tests to Jest. `strict` mode will be
enabled in a later PR after we update dependencies, as that will make
the necessary changes much easier.

The changes are:
* `inlineSources` has been enabled. This embeds a complete copy of the
  source code with the source maps, allowing for a much better debugging
  experience.
* `lib` has been set to `ES2020`, ensuring that we only rely upon
  JavaScript APIs. Previously it also allowed use of browser APIs.
* `rootDir` is now set explicitly to `src`, which will help ensure we
  don't accidentally change the structure of the package.
* The old `prod` config was merged with the base config, so it was no
  longer needed as a separate file.

Closes #142
Gudahtt added a commit that referenced this issue Jul 15, 2021
@Gudahtt
Use standard TypeScript config
4d7681e 
The TypeScript config has been updated to match the configuration we
use in other libraries, mostly. The remaining differences are that
`strict` is still not enabled, and there is a separate config used for
testing. The test config was preserved for now, but that will be
replaced soon when we migrate the tests to Jest. `strict` mode will be
enabled in a later PR after we update dependencies, as that will make
the necessary changes much easier.

The changes are:
* `inlineSources` has been enabled. This embeds a complete copy of the
  source code with the source maps, allowing for a much better debugging
  experience.
* `lib` has been set to `ES2020`, ensuring that we only rely upon
  JavaScript APIs. Previously it also allowed use of browser APIs.
* `rootDir` is now set explicitly to `src`, which will help ensure we
  don't accidentally change the structure of the package.
* The old `prod` config was merged with the base config, so it was no
  longer needed as a separate file.

Closes #142
Gudahtt added a commit that referenced this issue Jul 15, 2021
@Gudahtt
Use standard TypeScript config
7b3fa04 
The TypeScript config has been updated to match the configuration we
use in other libraries, mostly. The remaining differences are that
`strict` is still not enabled, and there is a separate config used for
testing. The test config was preserved for now, but that will be
replaced soon when we migrate the tests to Jest. `strict` mode will be
enabled in a later PR after we update dependencies, as that will make
the necessary changes much easier.

The changes are:
* `inlineSources` has been enabled. This embeds a complete copy of the
  source code with the source maps, allowing for a much better debugging
  experience.
* `lib` has been set to `ES2020`, ensuring that we only rely upon
  JavaScript APIs. Previously it also allowed use of browser APIs.
* `rootDir` is now set explicitly to `src`, which will help ensure we
  don't accidentally change the structure of the package.
* The old `prod` config was merged with the base config, so it was no
  longer needed as a separate file.

Closes #142
Gudahtt added a commit that referenced this issue Jul 15, 2021
@Gudahtt
Use standard TypeScript config (#159)
1489507 
The TypeScript config has been updated to match the configuration we
use in other libraries, mostly. The remaining differences are that
`strict` is still not enabled, and there is a separate config used for
testing. The test config was preserved for now, but that will be
replaced soon when we migrate the tests to Jest. `strict` mode will be
enabled in a later PR after we update dependencies, as that will make
the necessary changes much easier.

The changes are:
* `inlineSources` has been enabled. This embeds a complete copy of the
  source code with the source maps, allowing for a much better debugging
  experience.
* `lib` has been set to `ES2020`, ensuring that we only rely upon
  JavaScript APIs. Previously it also allowed use of browser APIs.
* `rootDir` is now set explicitly to `src`, which will help ensure we
  don't accidentally change the structure of the package.
* The old `prod` config was merged with the base config, so it was no
  longer needed as a separate file.

Closes #142
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

Use standard TypeScript config MetaMask/eth-sig-util
2 participants
@Gudahtt @gabmontes