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

Update typings to support ESM #141

Merged
merged 5 commits into from
Jun 30, 2021
Merged

Update typings to support ESM #141

merged 5 commits into from
Jun 30, 2021

Conversation

ChristianMurphy
Copy link
Member

Initial checklist

  • I read the support docs
  • I read the contributing guide
  • I agree to follow the code of conduct
  • I searched issues and couldn’t find anything (or linked relevant results below)
  • If applicable, I’ve added docs and tests

Description of changes

Update typings to support ESM style imports (part of dc46bc5)
For now keeping the typings as a .d.ts file, JSDoc could be nice down the road, but overload support and split interfaces (FrozenProcessor vs Processor) are still challenging in JSDoc and potentially more difficult to maintain than the .d.ts file.

@github-actions github-actions bot added 👋 phase/new Post is being triaged automatically 🤞 phase/open Post is being triaged manually and removed 👋 phase/new Post is being triaged automatically labels Jun 26, 2021
@codecov-commenter

This comment has been minimized.

Sign in to view
@ChristianMurphy ChristianMurphy added ☂️ area/types This affects typings 🕸️ area/tests This affects tests labels Jun 26, 2021
@ChristianMurphy
Copy link
Member Author

📓 the removal of namespace makes this diff look larger than it is.
Disable space in the preview for a better view at changes (https://github.blog/2021-04-28-github-desktop-hiding-whitespace-expanding-diffs-repo-aliases/#hide-whitespace-in-diffs)

@ChristianMurphy
Copy link
Member Author

/cc @remcohaszing

@ChristianMurphy ChristianMurphy added the 🧑 semver/major This is a change label Jun 26, 2021
wooorm
wooorm approved these changes Jun 26, 2021
View reviewed changes
Copy link
Member

@wooorm wooorm left a comment

Choose a reason for hiding this comment

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

Should the tsconfig also be updated to support ES2020? https://github.com/unifiedjs/unified/blob/main/types/tsconfig.json

@ChristianMurphy

This comment has been minimized.

Sign in to view
@wooorm

This comment has been minimized.

Sign in to view
@ChristianMurphy

This comment has been minimized.

Sign in to view
@wooorm

This comment has been minimized.

Sign in to view
@ChristianMurphy

This comment has been minimized.

Sign in to view
@ChristianMurphy ChristianMurphy merged commit 45eb72e into unifiedjs:main Jun 30, 2021
@ChristianMurphy ChristianMurphy deleted the update-typings branch June 30, 2021 16:45
@github-actions

This comment has been minimized.

Sign in to view
@ChristianMurphy
Copy link
Member Author

This will be a part of unified version 10 release

@wooorm wooorm added 💪 phase/solved Post is done and removed 🤞 phase/open Post is being triaged manually labels Jun 30, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@wooorm wooorm wooorm approved these changes

@Rokt33r Rokt33r Awaiting requested review from Rokt33r

@Murderlon Murderlon Awaiting requested review from Murderlon

Assignees
No one assigned
Labels
🕸️ area/tests This affects tests ☂️ area/types This affects typings 💪 phase/solved Post is done 🧑 semver/major This is a change
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
3 participants
@ChristianMurphy @codecov-commenter @wooorm