Add Typescript Support #45
Merged
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
Prettier and ESLint were both trying to drive formatting for CHANGELOG.md that didn't actually result in a end difference for Github's markdown generator. It was causing unnecessary commits. As CHANGELOG.md is auto-generated, linting it is not necessary. Resolves: 44
These were superfluous and getting ignored anyway. Conversations about details and problems on these should be had in the open, not behind email.
See @m-scott-lassiter/semantic-release-github-npm-config
The new semantic-release config with this change uses a beta branch for pre-releases.
This is a beta test addressing issue #43 for testing. It adds typescript bindings in a index.d.ts file.
## [1.6.0-beta.1](v1.5.2...v1.6.0-beta.1) (2022-05-20) ### 🏗️ Build Changes * change the semantic-release configuration to a shared config ([c2a19fa](c2a19fa)) * ignore CHANGELOG.md from linting and formatting ([2e3ca94](2e3ca94)) ### 🎁 Feature Changes * add typescript bindings to the encoder ([e1cd754](e1cd754)), closes [#43](#43)
Missed this when building the new package. Refer to issue #43 for details.
## [1.6.0-beta.2](v1.6.0-beta.1...v1.6.0-beta.2) (2022-05-20) ### 🐞 Bug Fixes * add typescript definition file to "files" key ([009460c](009460c)), closes [#43](#43)
Updates @m-scott-lassiter/semantic-release-github-npm-config to version 2.0.0 which causes API types to trigger patches. Also upgrades the commitizen script with a more customized scope list to assist other developers.
This might fix the problem in #43. I added @ts-check back in, changed the index.d.ts to 'declare class' instead of 'export class', and I am not getting any errors in VS Code anymore with the built in Typescript checker. However, I am not actually running Typescript, so I do not know if this will solve the problem once and for all or not. Additionally, I indentified some issues in the API documentation and have improved those.
This version has reached end of life and will no longer get supported in the test scripts.
Codecov Report
@@ Coverage Diff @@
## main #45 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 1 1
Lines 94 95 +1
Branches 28 28
=========================================
+ Hits 94 95 +1
Continue to review full report at Codecov.
|
|
🎉 This PR is included in version 1.6.0 🎉 The release is available on: Your semantic-release bot 📦🚀 |
1 task
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.
Proposed Changes
Added Typescript definitions and improve the CI/CD pipeline.
Pull Request Checklist
Please check if your PR fulfills the following requirements:
npm run build) locally and pushed all changesIssues Addressed: #43
Other Information
Switched build configuration over to
@m-scott-lassiter/semantic-release-github-npm-config