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

feat: generate just typescript #92

Merged
merged 1 commit into from
Feb 12, 2024
Merged

feat: generate just typescript #92

merged 1 commit into from
Feb 12, 2024

Conversation

aecorredor
Copy link
Member

@aecorredor aecorredor commented Feb 12, 2024

INCLUDES BREAKING CHANGE

Motivations

In order to make integration in downstream consumers easier, we've migrated from generating separate code (.js) and declaration (.d.ts) files to only generating a single TypeScript (.ts) file. The main reason for this is that tsc does not include .d.ts files by default in its build process, which break consumers that have used this package before the build step, since they'll lose the generated .d.ts file when their build process generates its own from the .js file that this package also generates.

@lifeomic-probot
Copy link

lifeomic-probot bot commented Feb 12, 2024

⚠️ Detected a breaking change in commit e18d43c

Merging this PR will result in a major version bump.

Created by lifeomic-probot (Enforce Semantic Commits)

module.exports.Client = Client;
`,
declaration: `/* eslint-disable */
typescript: `/* eslint-disable */
Copy link
Contributor

Choose a reason for hiding this comment

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

do we still need this?

Copy link
Member Author

@aecorredor aecorredor Feb 12, 2024

Choose a reason for hiding this comment

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

I think we do since eslint does also check typescript files. If we don't, it might be worth putting it as another change.

@aecorredor aecorredor merged commit ab06528 into master Feb 12, 2024
4 checks passed
@aecorredor aecorredor deleted the generate-ts branch February 12, 2024 21:15
Copy link

🎉 This PR is included in version 6.0.0 🎉

The release is available on:

Your semantic-release bot 📦🚀

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants