Skip to content

feat: enforce lowercase primitive type names #144

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

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

dsanders11
Copy link
Member

The docs are inconsistent in type names (90% string, 10% String, similar for number vs Number, etc). The eventual electron.d.ts output gets them finally converted to string and number, but let's throw an error if the titlecase ones are used in the docs to better enforce consistency and avoid user confusion.

A consequence of this change is a lot of types in electron-api.json are currently String, and they'll all become string - I think that should be fine.

@dsanders11 dsanders11 requested a review from a team as a code owner June 5, 2025 22:32
Copy link
Member

@erickzhao erickzhao left a comment

Choose a reason for hiding this comment

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

Do we need to fix all the docs ones to primitives before landing this?

@dsanders11
Copy link
Member Author

Do we need to fix all the docs ones to primitives before landing this?

Yea, either in the PR that updates e/e or in a separate PR ahead of time.

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.

2 participants